rbs 2.0.0 → 2.2.2

data/stdlib/forwardable/0/forwardable.rbs

@@ -1,3 +1,4 @@
+# <!-- rdoc-file=lib/forwardable.rb -->
 # The Forwardable module provides delegation of specified methods to a
 # designated object, using the methods #def_delegator and #def_delegators.
 #
@@ -61,7 +62,7 @@
 #       def_delegators :@q, :clear, :first, :push, :shift, :size
 #     end
 #
-#     q = Queue.new
+#     q = Thread::Queue.new
 #     q.enq 1, 2, 3, 4, 5
 #     q.push 6
 #
@@ -94,18 +95,36 @@
 # `delegate.rb`.
 #
 module Forwardable
+  # <!-- rdoc-file=lib/forwardable.rb -->
+  # Version of `forwardable.rb`
+  #
   VERSION: String
 
   FORWARDABLE_VERSION: String
 
+  # <!--
+  #   rdoc-file=lib/forwardable.rb
+  #   - delegate method => accessor
+  #   - delegate [method, method, ...] => accessor
+  # -->
   # Takes a hash as its argument.  The key is a symbol or an array of symbols.
   # These symbols correspond to method names, instance variable names, or constant
   # names (see def_delegator).  The value is the accessor to which the methods
   # will be delegated.
+  #
   def instance_delegate: (Hash[Symbol | Array[Symbol], Symbol] hash) -> void
 
+  # <!--
+  #   rdoc-file=lib/forwardable.rb
+  #   - delegate(hash)
+  # -->
+  #
   alias delegate instance_delegate
 
+  # <!--
+  #   rdoc-file=lib/forwardable.rb
+  #   - def_instance_delegators(accessor, *methods)
+  # -->
   # Shortcut for defining multiple delegator methods, but with no provision for
   # using a different name.  The following two code samples have the same effect:
   #
@@ -117,8 +136,17 @@ module Forwardable
   #
   def def_instance_delegators: (Symbol | String accessor, *Symbol methods) -> void
 
+  # <!--
+  #   rdoc-file=lib/forwardable.rb
+  #   - def_delegators(accessor, *methods)
+  # -->
+  #
   alias def_delegators def_instance_delegators
 
+  # <!--
+  #   rdoc-file=lib/forwardable.rb
+  #   - def_instance_delegator(accessor, method, ali = method)
+  # -->
   # Define `method` as delegator instance method with an optional alias name
   # `ali`. Method calls to `ali` will be delegated to `accessor.method`.
   # `accessor` should be a method name, instance variable name, or constant name.
@@ -145,9 +173,15 @@ module Forwardable
   #
   def def_instance_delegator: (Symbol | String accessor, Symbol method, ?Symbol ali) -> void
 
+  # <!--
+  #   rdoc-file=lib/forwardable.rb
+  #   - def_delegator(accessor, method, ali = method)
+  # -->
+  #
   alias def_delegator def_instance_delegator
 end
 
+# <!-- rdoc-file=lib/forwardable.rb -->
 # SingleForwardable can be used to setup delegation at the object level as well.
 #
 #     printer = String.new
@@ -175,13 +209,28 @@ end
 # def_instance_delegator and def_single_delegator, etc.
 #
 module SingleForwardable
+  # <!--
+  #   rdoc-file=lib/forwardable.rb
+  #   - delegate method => accessor
+  #   - delegate [method, method, ...] => accessor
+  # -->
   # Takes a hash as its argument.  The key is a symbol or an array of symbols.
   # These symbols correspond to method names.  The value is the accessor to which
   # the methods will be delegated.
+  #
   def single_delegate: (Hash[Symbol | Array[Symbol], Symbol] hash) -> void
 
+  # <!--
+  #   rdoc-file=lib/forwardable.rb
+  #   - delegate(hash)
+  # -->
+  #
   alias delegate single_delegate
 
+  # <!--
+  #   rdoc-file=lib/forwardable.rb
+  #   - def_single_delegators(accessor, *methods)
+  # -->
   # Shortcut for defining multiple delegator methods, but with no provision for
   # using a different name.  The following two code samples have the same effect:
   #
@@ -193,12 +242,27 @@ module SingleForwardable
   #
   def def_single_delegators: (Symbol | String accessor, *Symbol methods) -> void
 
+  # <!--
+  #   rdoc-file=lib/forwardable.rb
+  #   - def_delegators(accessor, *methods)
+  # -->
+  #
   alias def_delegators def_single_delegators
 
+  # <!--
+  #   rdoc-file=lib/forwardable.rb
+  #   - def_single_delegator(accessor, method, new_name=method)
+  # -->
   # Defines a method *method* which delegates to *accessor* (i.e. it calls the
   # method of the same name in *accessor*).  If *new_name* is provided, it is used
   # as the name for the delegate method. Returns the name of the method defined.
+  #
   def def_single_delegator: (Symbol | String accessor, Symbol method, ?Symbol ali) -> void
 
+  # <!--
+  #   rdoc-file=lib/forwardable.rb
+  #   - def_delegator(accessor, method, ali = method)
+  # -->
+  #
   alias def_delegator def_single_delegator
 end

data/stdlib/io-console/0/io-console.rbs

@@ -1,3 +1,4 @@
+%a{annotate:rdoc:skip}
 class IO
   class ConsoleMode
     def echo=: (bool) -> bool
@@ -5,100 +6,276 @@ class IO
     def raw!: (?min: int, ?time: int, ?intr: bool) -> self
   end
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - IO.console      -> #<File:/dev/tty>
+  #   - IO.console(sym, *args)
+  # -->
   # Returns an File instance opened console.
   #
   # If `sym` is given, it will be sent to the opened console with `args` and the
   # result will be returned instead of the console IO itself.
+  #
+  # You must require 'io/console' to use this method.
+  #
   def self.console: () -> File?
                   | (:close) -> nil
                   | (Symbol sym, *untyped args) -> untyped
 
-  # returns console window size
+  # <!--
+  #   rdoc-file=ext/io/console/lib/console/size.rb
+  #   - console_size()
+  # -->
   #
-  # You must require 'io/console/size' to use this method.
-  def self.console_size: () -> [Integer, Integer]
+  def self.console_size: () -> [ Integer, Integer ]
 
+  # <!--
+  #   rdoc-file=ext/io/console/lib/console/size.rb
+  #   - default_console_size()
+  # -->
   # fallback to console window size
   #
-  # You must require 'io/console/size' to use this method.
-  def self.default_console_size: -> [Integer, Integer]
+  def self.default_console_size: () -> [ Integer, Integer ]
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - beep()
+  # -->
+  #
   def beep: () -> self
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - check_winsize_changed()
+  # -->
+  #
   def check_winsize_changed: () { () -> void } -> self
+
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - clear_screen()
+  # -->
+  #
   def clear_screen: () -> self
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - io.console_mode       -> mode
+  # -->
   # Returns a data represents the current console mode.
+  #
+  # You must require 'io/console' to use this method.
+  #
   def console_mode: () -> IO::ConsoleMode
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - io.console_mode = mode
+  # -->
   # Sets the console mode to `mode`.
+  #
+  # You must require 'io/console' to use this method.
+  #
   def console_mode=: (IO::ConsoleMode mode) -> IO::ConsoleMode
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - io.cooked {|io| }
+  # -->
   # Yields `self` within cooked mode.
   #
   #     STDIN.cooked(&:gets)
   #
   # will read and return a line with echo back and line editing.
+  #
+  # You must require 'io/console' to use this method.
+  #
   def cooked: [T] () { (self) -> T } -> T
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - io.cooked!
+  # -->
   # Enables cooked mode.
   #
   # If the terminal mode needs to be back, use io.cooked { ... }.
+  #
+  # You must require 'io/console' to use this method.
+  #
   def cooked!: () -> self
 
-  def cursor: () -> [Integer, Integer]
-  def cursor=: ([Integer, Integer]) -> [Integer, Integer]
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - cursor()
+  # -->
+  #
+  def cursor: () -> [ Integer, Integer ]
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - cursor=(p1)
+  # -->
+  #
+  def cursor=: ([ Integer, Integer ]) -> [ Integer, Integer ]
+
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - cursor_down(p1)
+  # -->
+  #
   def cursor_down: (int) -> self
+
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - cursor_left(p1)
+  # -->
+  #
   def cursor_left: (int) -> self
+
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - cursor_right(p1)
+  # -->
+  #
   def cursor_right: (int) -> self
+
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - cursor_up(p1)
+  # -->
+  #
   def cursor_up: (int) -> self
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - io.echo = flag
+  # -->
   # Enables/disables echo back. On some platforms, all combinations of this flags
   # and raw/cooked mode may not be valid.
+  #
+  # You must require 'io/console' to use this method.
+  #
   def echo=: (bool flag) -> bool
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - io.echo?       -> true or false
+  # -->
   # Returns `true` if echo back is enabled.
+  #
+  # You must require 'io/console' to use this method.
+  #
   def echo?: () -> bool
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - erase_line(p1)
+  # -->
+  #
   def erase_line: (0 | 1 | 2 | nil) -> self
+
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - erase_screen(p1)
+  # -->
+  #
   def erase_screen: (0 | 1 | 2 | 3 | nil) -> self
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - io.getch(min: nil, time: nil, intr: nil) -> char
+  # -->
   # Reads and returns a character in raw mode.
   #
   # See IO#raw for details on the parameters.
+  #
+  # You must require 'io/console' to use this method.
+  #
   def getch: (?min: int, ?time: int, ?intr: bool) -> String
 
-  # Reads and returns a line without echo back.
-  # Prints +prompt+ unless it is +nil+.
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - io.getpass(prompt=nil)       -> string
+  # -->
+  # Reads and returns a line without echo back. Prints `prompt` unless it is
+  # `nil`.
+  #
+  # The newline character that terminates the read line is removed from the
+  # returned string, see String#chomp!.
+  #
+  # You must require 'io/console' to use this method.
   #
-  # The newline character that terminates the
-  # read line is removed from the returned string,
-  # see String#chomp!.
   def getpass: (?String) -> String
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - goto(p1, p2)
+  # -->
+  #
   def goto: (int, int) -> self
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - goto_column(p1)
+  # -->
+  #
   def goto_column: (int) -> self
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - io.iflush
+  # -->
   # Flushes input buffer in kernel.
+  #
+  # You must require 'io/console' to use this method.
+  #
   def iflush: () -> self
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - io.ioflush
+  # -->
   # Flushes input and output buffers in kernel.
+  #
+  # You must require 'io/console' to use this method.
+  #
   def ioflush: () -> self
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - io.noecho {|io| }
+  # -->
   # Yields `self` with disabling echo back.
   #
   #     STDIN.noecho(&:gets)
   #
   # will read and return a line without echo back.
+  #
+  # You must require 'io/console' to use this method.
+  #
   def noecho: [T] () { (self) -> T } -> T
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - io.oflush
+  # -->
   # Flushes output buffer in kernel.
+  #
+  # You must require 'io/console' to use this method.
+  #
   def oflush: () -> self
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - pressed?(p1)
+  # -->
+  #
   def pressed?: (Integer | Symbol | String) -> bool
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - io.raw(min: nil, time: nil, intr: nil) {|io| }
+  # -->
   # Yields `self` within raw mode, and returns the result of the block.
   #
   #     STDIN.raw(&:gets)
@@ -115,23 +292,58 @@ class IO
   # special characters.
   #
   # Refer to the manual page of termios for further details.
+  #
+  # You must require 'io/console' to use this method.
+  #
   def raw: [T] (?min: int, ?time: int, ?intr: bool) { (self) -> T } -> T
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - io.raw!(min: nil, time: nil, intr: nil) -> io
+  # -->
   # Enables raw mode, and returns `io`.
   #
   # If the terminal mode needs to be back, use `io.raw { ... }`.
   #
   # See IO#raw for details on the parameters.
+  #
+  # You must require 'io/console' to use this method.
+  #
   def raw!: (?min: int, ?time: int, ?intr: bool) -> self
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - scroll_backward(p1)
+  # -->
+  #
   def scroll_backward: (int) -> self
+
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - scroll_forward(p1)
+  # -->
+  #
   def scroll_forward: (int) -> self
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - io.winsize     -> [rows, columns]
+  # -->
   # Returns console size.
-  def winsize: () -> [Integer, Integer]
+  #
+  # You must require 'io/console' to use this method.
+  #
+  def winsize: () -> [ Integer, Integer ]
 
+  # <!--
+  #   rdoc-file=ext/io/console/console.c
+  #   - io.winsize = [rows, columns]
+  # -->
   # Tries to set console size.  The effect depends on the platform and the running
   # environment.
-  def winsize=: ([Integer, Integer]) -> [Integer, Integer]
-              | ([Integer, Integer, Integer, Integer]) -> [Integer, Integer, Integer, Integer]
+  #
+  # You must require 'io/console' to use this method.
+  #
+  def winsize=: ([ Integer, Integer ]) -> [ Integer, Integer ]
+              | ([ Integer, Integer, Integer, Integer ]) -> [ Integer, Integer, Integer, Integer ]
 end