rbs 2.0.0 → 2.2.2

data/stdlib/time/0/time.rbs

@@ -1,29 +1,30 @@
+%a{annotate:rdoc:skip}
 class Time
   interface _TimeLike
     def year: () -> Integer
+
     def mon: () -> Integer
+
     def day: () -> Integer
   end
 
+  # <!--
+  #   rdoc-file=lib/time.rb
+  #   - zone_offset(zone, year=self.now.year)
+  # -->
+  # Return the number of seconds the specified time zone differs from UTC.
   #
-  # Return the number of seconds the specified time zone differs
-  # from UTC.
-  #
-  # Numeric time zones that include minutes, such as
-  # <code>-10:00</code> or <code>+1330</code> will work, as will
-  # simpler hour-only time zones like <code>-10</code> or
-  # <code>+13</code>.
+  # Numeric time zones that include minutes, such as `-10:00` or `+1330` will
+  # work, as will simpler hour-only time zones like `-10` or `+13`.
   #
   # Textual time zones listed in ZoneOffset are also supported.
   #
-  # If the time zone does not match any of the above, +zone_offset+
-  # will check if the local time zone (both with and without
-  # potential Daylight Saving \Time changes being in effect) matches
-  # +zone+. Specifying a value for +year+ will change the year used
-  # to find the local time zone.
+  # If the time zone does not match any of the above, `zone_offset` will check if
+  # the local time zone (both with and without potential Daylight Saving Time
+  # changes being in effect) matches `zone`. Specifying a value for `year` will
+  # change the year used to find the local time zone.
   #
-  # If +zone_offset+ is unable to determine the offset, nil will be
-  # returned.
+  # If `zone_offset` is unable to determine the offset, nil will be returned.
   #
   #     require 'time'
   #
@@ -33,9 +34,16 @@ class Time
   #
   def self.zone_offset: (String zone, ?Integer year) -> Integer
 
+  # <!--
+  #   rdoc-file=lib/time.rb
+  #   - parse(date, now=self.now) { |year| ... }
+  # -->
+  # Takes a string representation of a Time and attempts to parse it using a
+  # heuristic.
   #
-  # Takes a string representation of a Time and attempts to parse it
-  # using a heuristic.
+  # This method **does not** function as a validator.  If the input string does
+  # not match valid formats strictly, you may get a cryptic result.  Should
+  # consider to use `Time.strptime` instead of this method as possible.
   #
   #     require 'time'
   #
@@ -72,10 +80,10 @@ class Time
   #     Time.parse("12:00", dt) #=> 2010-10-30 12:00:00 -0500
   #     Time.parse("12:00", md) #=> 2010-10-31 12:00:00 -0500
   #
-  # If a block is given, the year described in +date+ is converted
-  # by the block.  This is specifically designed for handling two
-  # digit years. For example, if you wanted to treat all two digit
-  # years prior to 70 as the year 2000+ you could write this:
+  # If a block is given, the year described in `date` is converted by the block.
+  # This is specifically designed for handling two digit years. For example, if
+  # you wanted to treat all two digit years prior to 70 as the year 2000+ you
+  # could write this:
   #
   #     require 'time'
   #
@@ -85,8 +93,8 @@ class Time
   #     #=> 1970-10-31 00:00:00 -0500
   #
   # If the upper components of the given time are broken or missing, they are
-  # supplied with those of +now+.  For the lower components, the minimum
-  # values (1 or 0) are assumed if broken or missing.  For example:
+  # supplied with those of `now`.  For the lower components, the minimum values (1
+  # or 0) are assumed if broken or missing.  For example:
   #
   #     require 'time'
   #
@@ -99,9 +107,8 @@ class Time
   #     Time.parse("Aug 2000", now)  #=> 2000-08-01 00:00:00 -0500
   #
   # Since there are numerous conflicts among locally defined time zone
-  # abbreviations all over the world, this method is not intended to
-  # understand all of them.  For example, the abbreviation "CST" is
-  # used variously as:
+  # abbreviations all over the world, this method is not intended to understand
+  # all of them.  For example, the abbreviation "CST" is used variously as:
   #
   #     -06:00 in America/Chicago,
   #     -05:00 in America/Havana,
@@ -110,23 +117,21 @@ class Time
   #     +10:30 in Australia/Adelaide,
   #     etc.
   #
-  # Based on this fact, this method only understands the time zone
-  # abbreviations described in RFC 822 and the system time zone, in the
-  # order named. (i.e. a definition in RFC 822 overrides the system
-  # time zone definition.)  The system time zone is taken from
-  # <tt>Time.local(year, 1, 1).zone</tt> and
-  # <tt>Time.local(year, 7, 1).zone</tt>.
-  # If the extracted time zone abbreviation does not match any of them,
+  # Based on this fact, this method only understands the time zone abbreviations
+  # described in RFC 822 and the system time zone, in the order named. (i.e. a
+  # definition in RFC 822 overrides the system time zone definition.)  The system
+  # time zone is taken from `Time.local(year, 1, 1).zone` and `Time.local(year, 7,
+  # 1).zone`. If the extracted time zone abbreviation does not match any of them,
   # it is ignored and the given time is regarded as a local time.
   #
-  # ArgumentError is raised if Date._parse cannot extract information from
-  # +date+ or if the Time class cannot represent specified date.
+  # ArgumentError is raised if Date._parse cannot extract information from `date`
+  # or if the Time class cannot represent specified date.
   #
   # This method can be used as a fail-safe for other parsing methods as:
   #
-  #   Time.rfc2822(date) rescue Time.parse(date)
-  #   Time.httpdate(date) rescue Time.parse(date)
-  #   Time.xmlschema(date) rescue Time.parse(date)
+  #     Time.rfc2822(date) rescue Time.parse(date)
+  #     Time.httpdate(date) rescue Time.parse(date)
+  #     Time.xmlschema(date) rescue Time.parse(date)
   #
   # A failure of Time.parse should be checked, though.
   #
@@ -134,66 +139,115 @@ class Time
   #
   def self.parse: (String date, ?_TimeLike now) ?{ (Integer) -> Integer } -> Time
 
+  # <!--
+  #   rdoc-file=lib/time.rb
+  #   - strptime(date, format, now=self.now) { |year| ... }
+  # -->
+  # Works similar to `parse` except that instead of using a heuristic to detect
+  # the format of the input string, you provide a second argument that describes
+  # the format of the string.
   #
-  # Works similar to +parse+ except that instead of using a
-  # heuristic to detect the format of the input string, you provide
-  # a second argument that describes the format of the string.
-  #
-  # If a block is given, the year described in +date+ is converted by the
-  # block.  For example:
+  # If a block is given, the year described in `date` is converted by the block.
+  # For example:
   #
-  #   Time.strptime(...) {|y| y < 100 ? (y >= 69 ? y + 1900 : y + 2000) : y}
+  #     Time.strptime(...) {|y| y < 100 ? (y >= 69 ? y + 1900 : y + 2000) : y}
   #
   # Below is a list of the formatting options:
   #
-  # %a :: The abbreviated weekday name ("Sun")
-  # %A :: The  full  weekday  name ("Sunday")
-  # %b :: The abbreviated month name ("Jan")
-  # %B :: The  full  month  name ("January")
-  # %c :: The preferred local date and time representation
-  # %C :: Century (20 in 2009)
-  # %d :: Day of the month (01..31)
-  # %D :: Date (%m/%d/%y)
-  # %e :: Day of the month, blank-padded ( 1..31)
-  # %F :: Equivalent to %Y-%m-%d (the ISO 8601 date format)
-  # %g :: The last two digits of the commercial year
-  # %G :: The week-based year according to ISO-8601 (week 1 starts on Monday
-  #       and includes January 4)
-  # %h :: Equivalent to %b
-  # %H :: Hour of the day, 24-hour clock (00..23)
-  # %I :: Hour of the day, 12-hour clock (01..12)
-  # %j :: Day of the year (001..366)
-  # %k :: hour, 24-hour clock, blank-padded ( 0..23)
-  # %l :: hour, 12-hour clock, blank-padded ( 0..12)
-  # %L :: Millisecond of the second (000..999)
-  # %m :: Month of the year (01..12)
-  # %M :: Minute of the hour (00..59)
-  # %n :: Newline (\n)
-  # %N :: Fractional seconds digits
-  # %p :: Meridian indicator ("AM" or "PM")
-  # %P :: Meridian indicator ("am" or "pm")
-  # %r :: time, 12-hour (same as %I:%M:%S %p)
-  # %R :: time, 24-hour (%H:%M)
-  # %s :: Number of seconds since 1970-01-01 00:00:00 UTC.
-  # %S :: Second of the minute (00..60)
-  # %t :: Tab character (\t)
-  # %T :: time, 24-hour (%H:%M:%S)
-  # %u :: Day of the week as a decimal, Monday being 1. (1..7)
-  # %U :: Week number of the current year, starting with the first Sunday as
-  #       the first day of the first week (00..53)
-  # %v :: VMS date (%e-%b-%Y)
-  # %V :: Week number of year according to ISO 8601 (01..53)
-  # %W :: Week  number  of the current year, starting with the first Monday
-  #       as the first day of the first week (00..53)
-  # %w :: Day of the week (Sunday is 0, 0..6)
-  # %x :: Preferred representation for the date alone, no time
-  # %X :: Preferred representation for the time alone, no date
-  # %y :: Year without a century (00..99)
-  # %Y :: Year which may include century, if provided
-  # %z :: Time zone as  hour offset from UTC (e.g. +0900)
-  # %Z :: Time zone name
-  # %% :: Literal "%" character
-  # %+ :: date(1) (%a %b %e %H:%M:%S %Z %Y)
+  # %a
+  # :   The abbreviated weekday name ("Sun")
+  # %A
+  # :   The  full  weekday  name ("Sunday")
+  # %b
+  # :   The abbreviated month name ("Jan")
+  # %B
+  # :   The  full  month  name ("January")
+  # %c
+  # :   The preferred local date and time representation
+  # %C
+  # :   Century (20 in 2009)
+  # %d
+  # :   Day of the month (01..31)
+  # %D
+  # :   Date (%m/%d/%y)
+  # %e
+  # :   Day of the month, blank-padded ( 1..31)
+  # %F
+  # :   Equivalent to %Y-%m-%d (the ISO 8601 date format)
+  # %g
+  # :   The last two digits of the commercial year
+  # %G
+  # :   The week-based year according to ISO-8601 (week 1 starts on Monday and
+  #     includes January 4)
+  # %h
+  # :   Equivalent to %b
+  # %H
+  # :   Hour of the day, 24-hour clock (00..23)
+  # %I
+  # :   Hour of the day, 12-hour clock (01..12)
+  # %j
+  # :   Day of the year (001..366)
+  # %k
+  # :   hour, 24-hour clock, blank-padded ( 0..23)
+  # %l
+  # :   hour, 12-hour clock, blank-padded ( 0..12)
+  # %L
+  # :   Millisecond of the second (000..999)
+  # %m
+  # :   Month of the year (01..12)
+  # %M
+  # :   Minute of the hour (00..59)
+  # %n
+  # :   Newline (n)
+  # %N
+  # :   Fractional seconds digits
+  # %p
+  # :   Meridian indicator ("AM" or "PM")
+  # %P
+  # :   Meridian indicator ("am" or "pm")
+  # %r
+  # :   time, 12-hour (same as %I:%M:%S %p)
+  # %R
+  # :   time, 24-hour (%H:%M)
+  # %s
+  # :   Number of seconds since 1970-01-01 00:00:00 UTC.
+  # %S
+  # :   Second of the minute (00..60)
+  # %t
+  # :   Tab character (t)
+  # %T
+  # :   time, 24-hour (%H:%M:%S)
+  # %u
+  # :   Day of the week as a decimal, Monday being 1. (1..7)
+  # %U
+  # :   Week number of the current year, starting with the first Sunday as the
+  #     first day of the first week (00..53)
+  # %v
+  # :   VMS date (%e-%b-%Y)
+  # %V
+  # :   Week number of year according to ISO 8601 (01..53)
+  # %W
+  # :   Week  number  of the current year, starting with the first Monday as the
+  #     first day of the first week (00..53)
+  # %w
+  # :   Day of the week (Sunday is 0, 0..6)
+  # %x
+  # :   Preferred representation for the date alone, no time
+  # %X
+  # :   Preferred representation for the time alone, no date
+  # %y
+  # :   Year without a century (00..99)
+  # %Y
+  # :   Year which may include century, if provided
+  # %z
+  # :   Time zone as  hour offset from UTC (e.g. +0900)
+  # %Z
+  # :   Time zone name
+  # %%
+  # :   Literal "%" character
+  # %+
+  # :   date(1) (%a %b %e %H:%M:%S %Z %Y)
+  #
   #
   #     require 'time'
   #
@@ -203,13 +257,16 @@ class Time
   #
   def self.strptime: (String date, String format, ?_TimeLike now) ?{ (Integer) -> Integer } -> Time
 
-  #
-  # Parses +date+ as date-time defined by RFC 2822 and converts it to a Time
+  # <!--
+  #   rdoc-file=lib/time.rb
+  #   - rfc2822(date)
+  # -->
+  # Parses `date` as date-time defined by RFC 2822 and converts it to a Time
   # object.  The format is identical to the date format defined by RFC 822 and
   # updated by RFC 1123.
   #
-  # ArgumentError is raised if +date+ is not compliant with RFC 2822
-  # or if the Time class cannot represent specified date.
+  # ArgumentError is raised if `date` is not compliant with RFC 2822 or if the
+  # Time class cannot represent specified date.
   #
   # See #rfc2822 for more information on this format.
   #
@@ -222,14 +279,22 @@ class Time
   #
   def self.rfc2822: (String date) -> Time
 
+  # <!--
+  #   rdoc-file=lib/time.rb
+  #   - rfc822(date)
+  # -->
+  #
   alias self.rfc822 self.rfc2822
 
+  # <!--
+  #   rdoc-file=lib/time.rb
+  #   - httpdate(date)
+  # -->
+  # Parses `date` as an HTTP-date defined by RFC 2616 and converts it to a Time
+  # object.
   #
-  # Parses +date+ as an HTTP-date defined by RFC 2616 and converts it to a
-  # Time object.
-  #
-  # ArgumentError is raised if +date+ is not compliant with RFC 2616 or if
-  # the Time class cannot represent specified date.
+  # ArgumentError is raised if `date` is not compliant with RFC 2616 or if the
+  # Time class cannot represent specified date.
   #
   # See #httpdate for more information on this format.
   #
@@ -242,13 +307,16 @@ class Time
   #
   def self.httpdate: (String date) -> Time
 
+  # <!--
+  #   rdoc-file=lib/time.rb
+  #   - xmlschema(time)
+  # -->
+  # Parses `time` as a dateTime defined by the XML Schema and converts it to a
+  # Time object.  The format is a restricted version of the format defined by ISO
+  # 8601.
   #
-  # Parses +date+ as a dateTime defined by the XML Schema and converts it to
-  # a Time object.  The format is a restricted version of the format defined
-  # by ISO 8601.
-  #
-  # ArgumentError is raised if +date+ is not compliant with the format or if
-  # the Time class cannot represent specified date.
+  # ArgumentError is raised if `time` is not compliant with the format or if the
+  # Time class cannot represent the specified time.
   #
   # See #xmlschema for more information on this format.
   #
@@ -261,16 +329,24 @@ class Time
   #
   def self.xmlschema: (String date) -> Time
 
+  # <!--
+  #   rdoc-file=lib/time.rb
+  #   - iso8601(time)
+  # -->
+  #
   alias self.iso8601 self.xmlschema
 
-  #
+  # <!--
+  #   rdoc-file=lib/time.rb
+  #   - rfc2822()
+  # -->
   # Returns a string which represents the time as date-time defined by RFC 2822:
   #
-  #   day-of-week, DD month-name CCYY hh:mm:ss zone
+  #     day-of-week, DD month-name CCYY hh:mm:ss zone
   #
   # where zone is [+-]hhmm.
   #
-  # If +self+ is a UTC time, -0000 is used as zone.
+  # If `self` is a UTC time, -0000 is used as zone.
   #
   #     require 'time'
   #
@@ -281,13 +357,21 @@ class Time
   #
   def rfc2822: () -> String
 
+  # <!--
+  #   rdoc-file=lib/time.rb
+  #   - rfc822()
+  # -->
+  #
   alias rfc822 rfc2822
 
-  #
+  # <!--
+  #   rdoc-file=lib/time.rb
+  #   - httpdate()
+  # -->
   # Returns a string which represents the time as RFC 1123 date of HTTP-date
   # defined by RFC 2616:
   #
-  #   day-of-week, DD month-name CCYY hh:mm:ss GMT
+  #     day-of-week, DD month-name CCYY hh:mm:ss GMT
   #
   # Note that the result is always UTC (GMT).
   #
@@ -300,18 +384,21 @@ class Time
   #
   def httpdate: () -> String
 
-  #
+  # <!--
+  #   rdoc-file=lib/time.rb
+  #   - xmlschema(fraction_digits=0)
+  # -->
   # Returns a string which represents the time as a dateTime defined by XML
   # Schema:
   #
-  #   CCYY-MM-DDThh:mm:ssTZD
-  #   CCYY-MM-DDThh:mm:ss.sssTZD
+  #     CCYY-MM-DDThh:mm:ssTZD
+  #     CCYY-MM-DDThh:mm:ss.sssTZD
   #
   # where TZD is Z or [+-]hh:mm.
   #
   # If self is a UTC time, Z is used as TZD.  [+-]hh:mm is used otherwise.
   #
-  # +fractional_digits+ specifies a number of digits to use for fractional
+  # `fractional_digits` specifies a number of digits to use for fractional
   # seconds.  Its default value is 0.
   #
   #     require 'time'
@@ -323,5 +410,10 @@ class Time
   #
   def xmlschema: (?Integer fraction_digits) -> String
 
+  # <!--
+  #   rdoc-file=lib/time.rb
+  #   - iso8601(fraction_digits=0)
+  # -->
+  #
   alias iso8601 xmlschema
 end

data/stdlib/timeout/0/timeout.rbs

@@ -1,3 +1,4 @@
+# <!-- rdoc-file=lib/timeout.rb -->
 # Timeout long-running blocks
 #
 # ## Synopsis
@@ -24,6 +25,10 @@
 # :   (C) 2000  Information-technology Promotion Agency, Japan
 #
 module Timeout
+  # <!--
+  #   rdoc-file=lib/timeout.rb
+  #   - timeout(sec, klass = nil, message = nil) { |sec| ... }
+  # -->
   # Perform an operation in a block, raising an error if it takes longer than
   # `sec` seconds to complete.
   #
@@ -47,6 +52,9 @@ module Timeout
   # prevent the handling of the exception.  For that reason, this method cannot be
   # relied on to enforce timeouts for untrusted blocks.
   #
+  # If a scheduler is defined, it will be used to handle the timeout by invoking
+  # Scheduler#timeout_after.
+  #
   # Note that this is both a method of module Timeout, so you can `include
   # Timeout` into your classes so they have a #timeout method, as well as a module
   # method, so you can call it directly as Timeout.timeout().
@@ -54,7 +62,9 @@ module Timeout
   def self?.timeout: [T] (Numeric? sec, ?singleton(Exception) klass, ?String message) { (Numeric sec) -> T } -> T
 end
 
+# <!-- rdoc-file=lib/timeout.rb -->
 # Raised by Timeout.timeout when the block times out.
+#
 class Timeout::Error < RuntimeError
   attr_reader thread: Thread?
 end

data/stdlib/tmpdir/0/tmpdir.rbs

@@ -1,8 +1,17 @@
+%a{annotate:rdoc:skip}
 class Dir
+  # <!--
+  #   rdoc-file=lib/tmpdir.rb
+  #   - tmpdir()
+  # -->
   # Returns the operating system's temporary file path.
   #
   def self.tmpdir: () -> String
 
+  # <!--
+  #   rdoc-file=lib/tmpdir.rb
+  #   - mktmpdir(prefix_suffix=nil, *rest, **options) { |dup| ... }
+  # -->
   # Dir.mktmpdir creates a temporary directory.
   #
   # The directory is created with 0700 permission. Application should not change
@@ -33,7 +42,7 @@ class Dir
   #
   #     Dir.mktmpdir {|dir|
   #       # use the directory...
-  #       open("#{dir}/foo", "w") { ... }
+  #       open("#{dir}/foo", "w") { something using the file }
   #     }
   #
   # If a block is not given, The path of the directory is returned. In this case,
@@ -42,12 +51,12 @@ class Dir
   #     dir = Dir.mktmpdir
   #     begin
   #       # use the directory...
-  #       open("#{dir}/foo", "w") { ... }
+  #       open("#{dir}/foo", "w") { something using the file }
   #     ensure
   #       # remove the directory.
   #       FileUtils.remove_entry dir
   #     end
   #
-  def self.mktmpdir: (?(String | [ String, String ] | nil), ?String?, ?max_try: Integer?) -> String
-                   | [X] (?(String | [ String, String ] | nil), ?String?, ?max_try: Integer?) { (String) -> X } -> X
+  def self.mktmpdir: (?String | [ String, String ] | nil, ?String?, ?max_try: Integer?) -> String
+                   | [X] (?String | [ String, String ] | nil, ?String?, ?max_try: Integer?) { (String) -> X } -> X
 end

data/stdlib/tsort/0/cyclic.rbs

@@ -1,3 +1,4 @@
+%a{annotate:rdoc:skip}
 module TSort[Node]
   class Cyclic < StandardError
   end

data/stdlib/tsort/0/interfaces.rbs

@@ -1,3 +1,4 @@
+%a{annotate:rdoc:skip}
 module TSort[Node]
   interface _Sortable[Node]
     # #tsort_each_node is used to iterate for all nodes over a graph.

data/stdlib/tsort/0/tsort.rbs

@@ -1,3 +1,4 @@
+# <!-- rdoc-file=lib/tsort.rb -->
 # TSort implements topological sorting using Tarjan's algorithm for strongly
 # connected components.
 #
@@ -115,7 +116,12 @@
 #
 #
 # *SIAM Journal on Computing*, Vol. 1, No. 2, pp. 146-160, June 1972.
+#
 module TSort[Node] : TSort::_Sortable[Node]
+  # <!--
+  #   rdoc-file=lib/tsort.rb
+  #   - each_strongly_connected_component(each_node, each_child) { |nodes| ... }
+  # -->
   # The iterator version of the TSort.strongly_connected_components method.
   #
   # The graph is represented by *each_node* and *each_child*. *each_node* should
@@ -145,6 +151,10 @@ module TSort[Node] : TSort::_Sortable[Node]
                                             | [T] (^() { (T) -> void } -> void each_node, ^(T) { (T) -> void } -> void each_child) { (Array[T]) -> void } -> void
                                             | [T] (^() { (T) -> void } -> void each_node, ^(T) { (T) -> void } -> void each_child) -> Enumerator[Array[T], void]
 
+  # <!--
+  #   rdoc-file=lib/tsort.rb
+  #   - each_strongly_connected_component_from(node, each_child, id_map={}, stack=[]) { |nodes| ... }
+  # -->
   # Iterates over strongly connected components in a graph. The graph is
   # represented by *node* and *each_child*.
   #
@@ -170,6 +180,10 @@ module TSort[Node] : TSort::_Sortable[Node]
                                                  | [T] (T node, ^(T) { (T) -> void } -> void each_child, ?untyped id_map, ?untyped stack) { (Array[T]) -> void } -> void
                                                  | [T] (T node, ^(T) { (T) -> void } -> void each_child, ?untyped id_map, ?untyped stack) -> Enumerator[Array[T], void]
 
+  # <!--
+  #   rdoc-file=lib/tsort.rb
+  #   - strongly_connected_components(each_node, each_child)
+  # -->
   # Returns strongly connected components as an array of arrays of nodes. The
   # array is sorted from children to parents. Each elements of the array
   # represents a strongly connected component.
@@ -194,6 +208,10 @@ module TSort[Node] : TSort::_Sortable[Node]
   def self.strongly_connected_components: [T] (_EachNode[T] each_node, _EachChild[T] each_child) -> Array[Array[T]]
                                         | [T] (^() { (T) -> void } -> void each_node, ^(T) { (T) -> void } -> void each_child) -> Array[Array[T]]
 
+  # <!--
+  #   rdoc-file=lib/tsort.rb
+  #   - tsort(each_node, each_child)
+  # -->
   # Returns a topologically sorted array of nodes. The array is sorted from
   # children to parents, i.e. the first element has no child and the last node has
   # no parent.
@@ -218,6 +236,10 @@ module TSort[Node] : TSort::_Sortable[Node]
   def self.tsort: [T] (_EachNode[T] each_node, _EachChild[T] each_child) -> Array[T]
                 | [T] (^() { (T) -> void } -> void each_node, ^(T) { (T) -> void } -> void each_child) -> Array[T]
 
+  # <!--
+  #   rdoc-file=lib/tsort.rb
+  #   - tsort_each(each_node, each_child) { |node| ... }
+  # -->
   # The iterator version of the TSort.tsort method.
   #
   # The graph is represented by *each_node* and *each_child*. *each_node* should
@@ -239,6 +261,10 @@ module TSort[Node] : TSort::_Sortable[Node]
                      | [T] (^() { (T) -> void } -> void each_node, ^(T) { (T) -> void } -> void each_child) { (T) -> void } -> void
                      | [T] (^() { (T) -> void } -> void each_node, ^(T) { (T) -> void } -> void each_child) -> Enumerator[T, void]
 
+  # <!--
+  #   rdoc-file=lib/tsort.rb
+  #   - each_strongly_connected_component() { |nodes| ... }
+  # -->
   # The iterator version of the #strongly_connected_components method.
   # *`obj*.each_strongly_connected_component` is similar to
   # *`obj*.strongly_connected_components.each`, but modification of *obj* during
@@ -271,6 +297,10 @@ module TSort[Node] : TSort::_Sortable[Node]
   def each_strongly_connected_component: () { (Array[Node]) -> void } -> void
                                        | () -> Enumerator[Array[Node], void]
 
+  # <!--
+  #   rdoc-file=lib/tsort.rb
+  #   - each_strongly_connected_component_from(node, id_map={}, stack=[]) { |nodes| ... }
+  # -->
   # Iterates over strongly connected component in the subgraph reachable from
   # *node*.
   #
@@ -300,6 +330,10 @@ module TSort[Node] : TSort::_Sortable[Node]
   def each_strongly_connected_component_from: (Node, ?untyped id_map, ?untyped stack) { (Array[Node]) -> void } -> void
                                             | (Node, ?untyped id_map, ?untyped stack) -> Enumerator[Array[Node], void]
 
+  # <!--
+  #   rdoc-file=lib/tsort.rb
+  #   - strongly_connected_components()
+  # -->
   # Returns strongly connected components as an array of arrays of nodes. The
   # array is sorted from children to parents. Each elements of the array
   # represents a strongly connected component.
@@ -321,6 +355,10 @@ module TSort[Node] : TSort::_Sortable[Node]
   #
   def strongly_connected_components: () -> Array[Array[Node]]
 
+  # <!--
+  #   rdoc-file=lib/tsort.rb
+  #   - tsort()
+  # -->
   # Returns a topologically sorted array of nodes. The array is sorted from
   # children to parents, i.e. the first element has no child and the last node has
   # no parent.
@@ -344,6 +382,10 @@ module TSort[Node] : TSort::_Sortable[Node]
   #
   def tsort: () -> Array[Node]
 
+  # <!--
+  #   rdoc-file=lib/tsort.rb
+  #   - tsort_each() { |node| ... }
+  # -->
   # The iterator version of the #tsort method. *`obj*.tsort_each` is similar to
   # *`obj*.tsort.each`, but modification of *obj* during the iteration may lead to
   # unexpected results.