rbs 2.8.4 → 3.8.1

data/stdlib/rdoc/0/rdoc.rbs

@@ -1,9 +1,3 @@
-# <!-- rdoc-file=lib/rdoc/rubygems_hook.rb -->
-# Gem::RDoc provides methods to generate RDoc and ri data for installed gems
-# upon gem installation.
-#
-# This file is automatically required by RubyGems 1.9 and newer.
-#
 # <!-- rdoc-file=lib/rdoc.rb -->
 # RDoc produces documentation for Ruby source files by parsing the source and
 # extracting the definition for classes, modules, methods, includes and
@@ -21,8 +15,7 @@
 # If you want to use RDoc to create documentation for your Ruby source files,
 # see RDoc::Markup and refer to `rdoc --help` for command line usage.
 #
-# If you want to set the default markup format see
-# RDoc::Markup@Supported+Formats
+# If you want to set the default markup format see RDoc::Markup@Markup+Formats
 #
 # If you want to store rdoc configuration in your gem (such as the default
 # markup format) see RDoc::Options@Saved+Options
@@ -56,340 +49,19 @@
 #     of Keiju ISHITSUKA of Nippon Rational Inc, who produced the Ruby parser
 #     for irb and the rtags package.
 #
+# <!-- rdoc-file=lib/rdoc/rubygems_hook.rb -->
+# This class is referenced by RubyGems to create documents. All implementations
+# are moved to the above RubyGemsHook.
+#
+# This class does nothing when this RDoc is installed as a normal gem or a
+# bundled gem.
+#
+# This class does generate/remove documents for compatibility when this RDoc is
+# installed as a default gem.
+#
+# We can remove this when all maintained RubyGems remove `rubygems/rdoc.rb`.
+#
 module RDoc
-  # <!-- rdoc-file=lib/rdoc/parser.rb -->
-  # A parser is simple a class that subclasses RDoc::Parser and implements #scan
-  # to fill in an RDoc::TopLevel with parsed data.
-  #
-  # The initialize method takes an RDoc::TopLevel to fill with parsed content, the
-  # name of the file to be parsed, the content of the file, an RDoc::Options
-  # object and an RDoc::Stats object to inform the user of parsed items.  The scan
-  # method is then called to parse the file and must return the RDoc::TopLevel
-  # object.  By calling super these items will be set for you.
-  #
-  # In order to be used by RDoc the parser needs to register the file extensions
-  # it can parse.  Use ::parse_files_matching to register extensions.
-  #
-  #     require 'rdoc'
-  #
-  #     class RDoc::Parser::Xyz < RDoc::Parser
-  #       parse_files_matching /\.xyz$/
-  #
-  #       def initialize top_level, file_name, content, options, stats
-  #         super
-  #
-  #         # extra initialization if needed
-  #       end
-  #
-  #       def scan
-  #         # parse file and fill in @top_level
-  #       end
-  #     end
-  #
-  class Parser
-    # <!--
-    #   rdoc-file=lib/rdoc/parser.rb
-    #   - parse_files_matching(regexp)
-    # -->
-    # Record which file types this parser can understand.
-    #
-    # It is ok to call this multiple times.
-    #
-    def self?.parse_files_matching: (Regexp path) -> void
-
-    # <!--
-    #   rdoc-file=lib/rdoc/parser.rb
-    #   - new(top_level, file_name, content, options, stats)
-    # -->
-    # Creates a new Parser storing `top_level`, `file_name`, `content`, `options`
-    # and `stats` in instance variables.  In +@preprocess+ an
-    # RDoc::Markup::PreProcess object is created which allows processing of
-    # directives.
-    #
-    def initialize: (RDoc::TopLevel top_level, String filename, String content, Hash[untyped, untyped] options, RDoc::Stats stats) -> void
-
-    def scan: () -> RDoc::TopLevel
-  end
-
-  # <!-- rdoc-file=lib/rdoc/code_object.rb -->
-  # Base class for the RDoc code tree.
-  #
-  # We contain the common stuff for contexts (which are containers) and other
-  # elements (methods, attributes and so on)
-  #
-  # Here's the tree of the CodeObject subclasses:
-  #
-  # *   RDoc::Context
-  #     *   RDoc::TopLevel
-  #     *   RDoc::ClassModule
-  #         *   RDoc::AnonClass (never used so far)
-  #         *   RDoc::NormalClass
-  #         *   RDoc::NormalModule
-  #         *   RDoc::SingleClass
-  #
-  #
-  # *   RDoc::MethodAttr
-  #     *   RDoc::Attr
-  #     *   RDoc::AnyMethod
-  #         *   RDoc::GhostMethod
-  #         *   RDoc::MetaMethod
-  #
-  #
-  # *   RDoc::Alias
-  # *   RDoc::Constant
-  # *   RDoc::Mixin
-  #     *   RDoc::Require
-  #     *   RDoc::Include
-  #
-  class CodeObject
-    # <!-- rdoc-file=lib/rdoc/code_object.rb -->
-    # Our comment
-    #
-    attr_reader comment: RDoc::Comment
-
-    # <!--
-    #   rdoc-file=lib/rdoc/code_object.rb
-    #   - new()
-    # -->
-    # Creates a new CodeObject that will document itself and its children
-    #
-    def initialize: () -> void
-
-    # <!--
-    #   rdoc-file=lib/rdoc/code_object.rb
-    #   - comment=(comment)
-    # -->
-    # Replaces our comment with `comment`, unless it is empty.
-    #
-    def comment=: (RDoc::Comment | String) -> RDoc::Comment
-  end
-
-  # <!-- rdoc-file=lib/rdoc/context.rb -->
-  # A Context is something that can hold modules, classes, methods, attributes,
-  # aliases, requires, and includes. Classes, modules, and files are all Contexts.
-  #
-  class Context < CodeObject
-    include Comparable
-
-    # <!-- rdoc-file=lib/rdoc/context.rb -->
-    # Types of methods
-    #
-    TYPES: ::Array["class" | "instance"]
-
-    TOMDOC_TITLES: ::Array[nil | "Public" | "Internal" | "Deprecated"]
-
-    type class_types = singleton(RDoc::NormalClass) | singleton(RDoc::SingleClass)
-
-    # <!--
-    #   rdoc-file=lib/rdoc/context.rb
-    #   - new()
-    # -->
-    # Creates an unnamed empty context with public current visibility
-    #
-    def initialize: () -> void
-
-    # <!--
-    #   rdoc-file=lib/rdoc/context.rb
-    #   - add_alias(an_alias)
-    # -->
-    # Adds `an_alias` that is automatically resolved
-    #
-    def add_alias: (RDoc::Alias an_alias) -> RDoc::Alias
-
-    # <!--
-    #   rdoc-file=lib/rdoc/context.rb
-    #   - add_attribute(attribute)
-    # -->
-    # Adds `attribute` if not already there. If it is (as method(s) or attribute),
-    # updates the comment if it was empty.
-    #
-    # The attribute is registered only if it defines a new method. For instance,
-    # `attr_reader :foo` will not be registered if method `foo` exists, but
-    # `attr_accessor :foo` will be registered if method `foo` exists, but `foo=`
-    # does not.
-    #
-    def add_attribute: (RDoc::Attr attribute) -> RDoc::Attr
-
-    # <!--
-    #   rdoc-file=lib/rdoc/context.rb
-    #   - add_class(class_type, given_name, superclass = '::Object')
-    # -->
-    # Adds a class named `given_name` with `superclass`.
-    #
-    # Both `given_name` and `superclass` may contain '::', and are interpreted
-    # relative to the `self` context. This allows handling correctly examples like
-    # these:
-    #     class RDoc::Gauntlet < Gauntlet
-    #     module Mod
-    #       class Object   # implies < ::Object
-    #       class SubObject < Object  # this is _not_ ::Object
-    #
-    # Given `class Container::Item` RDoc assumes `Container` is a module unless it
-    # later sees `class Container`.  `add_class` automatically upgrades `given_name`
-    # to a class in this case.
-    #
-    def add_class: (class_types class_type, ::String given_name, ?::String superclass) -> (RDoc::NormalClass | RDoc::SingleClass)
-
-    # <!--
-    #   rdoc-file=lib/rdoc/context.rb
-    #   - add_constant(constant)
-    # -->
-    # Adds `constant` if not already there. If it is, updates the comment, value
-    # and/or is_alias_for of the known constant if they were empty/nil.
-    #
-    def add_constant: (RDoc::Constant constant) -> RDoc::Constant
-
-    # <!--
-    #   rdoc-file=lib/rdoc/context.rb
-    #   - add_include(include)
-    # -->
-    # Adds included module `include` which should be an RDoc::Include
-    #
-    def add_include: (RDoc::Include `include`) -> RDoc::Include
-
-    # <!--
-    #   rdoc-file=lib/rdoc/context.rb
-    #   - add_extend(ext)
-    # -->
-    # Adds extension module `ext` which should be an RDoc::Extend
-    #
-    def add_extend: (RDoc::Extend ext) -> RDoc::Extend
-
-    # <!--
-    #   rdoc-file=lib/rdoc/context.rb
-    #   - add_method(method)
-    # -->
-    # Adds `method` if not already there. If it is (as method or attribute), updates
-    # the comment if it was empty.
-    #
-    def add_method: (RDoc::AnyMethod method) -> RDoc::AnyMethod
-
-    # <!--
-    #   rdoc-file=lib/rdoc/context.rb
-    #   - add_module(class_type, name)
-    # -->
-    # Adds a module named `name`.  If RDoc already knows `name` is a class then that
-    # class is returned instead.  See also #add_class.
-    #
-    def add_module: (singleton(RDoc::NormalModule) class_type, String name) -> RDoc::NormalModule
-
-    # <!--
-    #   rdoc-file=lib/rdoc/context.rb
-    #   - find_module_named(name)
-    # -->
-    # Find a module with `name` using ruby's scoping rules
-    #
-    def find_module_named: (untyped name) -> (untyped | self)
-
-    # <!--
-    #   rdoc-file=lib/rdoc/context.rb
-    #   - full_name()
-    # -->
-    # The full name for this context.  This method is overridden by subclasses.
-    #
-    def full_name: () -> "(unknown)"
-
-    def to_s: () -> ::String
-
-    # <!--
-    #   rdoc-file=lib/rdoc/context.rb
-    #   - top_level()
-    # -->
-    # Return the TopLevel that owns us
-    #
-    def top_level: () -> RDoc::TopLevel
-  end
-
-  # <!-- rdoc-file=lib/rdoc/top_level.rb -->
-  # A TopLevel context is a representation of the contents of a single file
-  #
-  class TopLevel < Context
-    MARSHAL_VERSION: 0
-
-    # <!--
-    #   rdoc-file=lib/rdoc/top_level.rb
-    #   - new(absolute_name, relative_name = absolute_name)
-    # -->
-    # Creates a new TopLevel for the file at `absolute_name`.  If documentation is
-    # being generated outside the source dir `relative_name` is relative to the
-    # source directory.
-    #
-    def initialize: (String absolute_name, ?String relative_name) -> void
-
-    # <!--
-    #   rdoc-file=lib/rdoc/top_level.rb
-    #   - ==(other)
-    # -->
-    # An RDoc::TopLevel is equal to another with the same relative_name
-    #
-    def ==: (untyped other) -> bool
-
-    # <!--
-    #   rdoc-file=lib/rdoc/top_level.rb
-    #   - eql?(other)
-    # -->
-    #
-    alias eql? ==
-
-    # <!--
-    #   rdoc-file=lib/rdoc/top_level.rb
-    #   - add_alias(an_alias)
-    # -->
-    # Adds `an_alias` to `Object` instead of `self`.
-    #
-    def add_alias: (RDoc::Alias an_alias) -> RDoc::Alias
-
-    # <!--
-    #   rdoc-file=lib/rdoc/top_level.rb
-    #   - add_constant(constant)
-    # -->
-    # Adds `constant` to `Object` instead of `self`.
-    #
-    def add_constant: (RDoc::Constant constant) -> RDoc::Constant
-
-    # <!--
-    #   rdoc-file=lib/rdoc/top_level.rb
-    #   - add_include(include)
-    # -->
-    # Adds `include` to `Object` instead of `self`.
-    #
-    def add_include: (RDoc::Include `include`) -> RDoc::Include
-
-    # <!--
-    #   rdoc-file=lib/rdoc/top_level.rb
-    #   - add_method(method)
-    # -->
-    # Adds `method` to `Object` instead of `self`.
-    #
-    def add_method: (RDoc::AnyMethod method) -> RDoc::AnyMethod
-
-    # <!--
-    #   rdoc-file=lib/rdoc/top_level.rb
-    #   - find_class_or_module(name)
-    # -->
-    # See RDoc::TopLevel::find_class_or_module
-    #
-    def find_class_or_module: (::String name) -> RDoc::Context
-
-    # <!--
-    #   rdoc-file=lib/rdoc/top_level.rb
-    #   - find_module_named(name)
-    # -->
-    # Finds a module or class with `name`
-    #
-    def find_module_named: (String name) -> RDoc::Context
-
-    # <!--
-    #   rdoc-file=lib/rdoc/top_level.rb
-    #   - full_name()
-    # -->
-    # Returns the relative name of this file
-    #
-    def full_name: () -> String
-
-    def to_s: () -> ::String
-  end
-
   # <!-- rdoc-file=lib/rdoc/token_stream.rb -->
   # A TokenStream is a list of tokens, gathered during the parse of some entity
   # (say a method). Entities populate these streams by being registered with the
@@ -422,45 +94,6 @@ module RDoc
     alias start_collecting_tokens collect_tokens
   end
 
-  # <!-- rdoc-file=lib/rdoc/comment.rb -->
-  # A comment holds the text comment for a RDoc::CodeObject and provides a unified
-  # way of cleaning it up and parsing it into an RDoc::Markup::Document.
-  #
-  # Each comment may have a different markup format set by #format=.  By default
-  # 'rdoc' is used.  The :markup: directive tells RDoc which format to use.
-  #
-  # See RDoc::Markup@Other+directives for instructions on adding an alternate
-  # format.
-  #
-  class Comment
-    # <!-- rdoc-file=lib/rdoc/comment.rb -->
-    # The format of this comment.  Defaults to RDoc::Markup
-    #
-    attr_reader format: String
-
-    # <!-- rdoc-file=lib/rdoc/comment.rb -->
-    # The RDoc::TopLevel this comment was found in
-    #
-    attr_accessor location: String
-
-    # <!--
-    #   rdoc-file=lib/rdoc/comment.rb
-    #   - new(text = nil, location = nil, language = nil)
-    # -->
-    # Creates a new comment with `text` that is found in the RDoc::TopLevel
-    # `location`.
-    #
-    def initialize: (?String? text, ?RDoc::Context? location, ?String? language) -> void
-
-    # <!--
-    #   rdoc-file=lib/rdoc/comment.rb
-    #   - format=(format)
-    # -->
-    # Sets the format of this comment and resets any parsed document
-    #
-    def format=: (String format) -> void
-  end
-
   # <!-- rdoc-file=lib/rdoc/class_module.rb -->
   # ClassModule is the base class for objects representing either a class or a
   # module.

data/stdlib/rdoc/0/ri.rbs

@@ -0,0 +1,17 @@
+%a{annotate:rdoc:skip}
+module RDoc
+  # <!-- rdoc-file=lib/rdoc/ri.rb -->
+  # Namespace for the ri command line tool's implementation.
+  #
+  # See `ri --help` for details.
+  #
+  module RI
+    module Paths
+      type path_type = :system | :site | :home | :gem | :extra
+
+      type gem_filter = :latest | :all
+
+      def self.each: (?bool system, ?bool site, ?bool home, ?gem_filter | false gems, *String extra_dirs) { (String, path_type) -> void } -> void
+    end
+  end
+end

data/stdlib/rdoc/0/store.rbs

@@ -0,0 +1,48 @@
+%a{annotate:rdoc:skip}
+module RDoc
+  # <!-- rdoc-file=lib/rdoc/store.rb -->
+  # A set of rdoc data for a single project (gem, path, etc.).
+  #
+  # The store manages reading and writing ri data for a project and maintains a
+  # cache of methods, classes and ancestors in the store.
+  #
+  # The store maintains a #cache of its contents for faster lookup.  After adding
+  # items to the store it must be flushed using #save_cache.  The cache contains
+  # the following structures:
+  #
+  #     @cache = {
+  #       :ancestors        => {}, # class name => ancestor names
+  #       :attributes       => {}, # class name => attributes
+  #       :class_methods    => {}, # class name => class methods
+  #       :instance_methods => {}, # class name => instance methods
+  #       :modules          => [], # classes and modules in this store
+  #       :pages            => [], # page names
+  #     }
+  #
+  class Store
+    # <!--
+    #   rdoc-file=lib/rdoc/store.rb
+    #   - new(path = nil, type = nil)
+    # -->
+    # Creates a new Store of `type` that will load or save to `path`
+    #
+    def initialize: (?String? path, ?Symbol? type) -> void
+
+    # <!--
+    #   rdoc-file=lib/rdoc/store.rb
+    #   - find_class_or_module(name)
+    # -->
+    # Finds the class or module with `name`
+    #
+    def find_class_or_module: (String) -> ClassModule?
+
+    # <!--
+    #   rdoc-file=lib/rdoc/store.rb
+    #   - load_all()
+    # -->
+    # Loads all items from this store into memory.  This recreates a documentation
+    # tree for use by a generator
+    #
+    def load_all: () -> void
+  end
+end

data/stdlib/rdoc/0/top_level.rbs

@@ -0,0 +1,97 @@
+%a{annotate:rdoc:skip}
+module RDoc
+  # <!-- rdoc-file=lib/rdoc/top_level.rb -->
+  # A TopLevel context is a representation of the contents of a single file
+  #
+  class TopLevel < Context
+    MARSHAL_VERSION: 0
+
+    # <!-- rdoc-file=lib/rdoc/top_level.rb -->
+    # Relative name of this file
+    #
+    attr_accessor relative_name: String
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - new(absolute_name, relative_name = absolute_name)
+    # -->
+    # Creates a new TopLevel for the file at `absolute_name`.  If documentation is
+    # being generated outside the source dir `relative_name` is relative to the
+    # source directory.
+    #
+    def initialize: (String absolute_name, ?String relative_name) -> void
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - ==(other)
+    # -->
+    # An RDoc::TopLevel is equal to another with the same relative_name
+    #
+    def ==: (untyped other) -> bool
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - eql?(other)
+    # -->
+    #
+    alias eql? ==
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - add_alias(an_alias)
+    # -->
+    # Adds `an_alias` to `Object` instead of `self`.
+    #
+    def add_alias: (RDoc::Alias an_alias) -> RDoc::Alias
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - add_constant(constant)
+    # -->
+    # Adds `constant` to `Object` instead of `self`.
+    #
+    def add_constant: (RDoc::Constant constant) -> RDoc::Constant
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - add_include(include)
+    # -->
+    # Adds `include` to `Object` instead of `self`.
+    #
+    def add_include: (RDoc::Include `include`) -> RDoc::Include
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - add_method(method)
+    # -->
+    # Adds `method` to `Object` instead of `self`.
+    #
+    def add_method: (RDoc::AnyMethod method) -> RDoc::AnyMethod
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - find_class_or_module(name)
+    # -->
+    # See RDoc::TopLevel::find_class_or_module
+    #
+    def find_class_or_module: (::String name) -> RDoc::Context
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - find_module_named(name)
+    # -->
+    # Finds a module or class with `name`
+    #
+    def find_module_named: (String name) -> RDoc::Context
+
+    # <!--
+    #   rdoc-file=lib/rdoc/top_level.rb
+    #   - full_name()
+    # -->
+    # Returns the relative name of this file
+    #
+    def full_name: () -> String
+
+    def to_s: () -> ::String
+  end
+end