diff --git a/.vscode/settings.json b/.vscode/settings.json index d5edcab..c59afc6 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -16,5 +16,6 @@ "Ruby LSP Shoulda Context": { "enabled": true } - } + }, + "rubyLsp.featureFlags": { "fullTestDiscovery": true } } \ No newline at end of file diff --git a/Gemfile b/Gemfile index 9eb924d..305ce68 100644 --- a/Gemfile +++ b/Gemfile @@ -22,5 +22,5 @@ group :development do gem "pry" gem "sorbet-static-and-runtime" gem "tapioca", require: false - gem "ruby-lsp", "~> 0.23.15" + gem "ruby-lsp", "~> 0.23.20" end diff --git a/Gemfile.lock b/Gemfile.lock index 42ea57d..2c1c683 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -56,7 +56,7 @@ GEM prism (~> 1.0) rbs (>= 3.4.4) sorbet-runtime (>= 0.5.9204) - rbs (3.9.2) + rbs (3.9.3) logger rdoc (6.13.1) psych (>= 4.0.0) @@ -83,7 +83,7 @@ GEM rubocop (~> 1.62) rubocop-sorbet (0.10.0) rubocop (>= 1) - ruby-lsp (0.23.15) + ruby-lsp (0.23.20) language_server-protocol (~> 3.17.0) prism (>= 1.2, < 2.0) rbs (>= 3, < 4) @@ -137,7 +137,7 @@ DEPENDENCIES rubocop-rake (~> 0.6.0) rubocop-shopify (~> 2.14) rubocop-sorbet (~> 0.7) - ruby-lsp (~> 0.23.15) + ruby-lsp (~> 0.23.20) ruby-lsp-shoulda-context! shoulda-context (~> 2.0) sorbet-static-and-runtime diff --git a/lib/ruby_lsp/ruby-lsp-shoulda-context/addon.rb b/lib/ruby_lsp/ruby-lsp-shoulda-context/addon.rb index 78359de..40412e6 100644 --- a/lib/ruby_lsp/ruby-lsp-shoulda-context/addon.rb +++ b/lib/ruby_lsp/ruby-lsp-shoulda-context/addon.rb @@ -4,10 +4,10 @@ require "ruby_lsp/addon" require "ruby_lsp/internal" -require_relative "code_lens" require_relative "../shoulda_context/version" +require_relative "listeners/test_discovery" -RubyLsp::Addon.depend_on_ruby_lsp!("~> 0.23.0") +RubyLsp::Addon.depend_on_ruby_lsp!("~> 0.23.17") module RubyLsp module ShouldaContext @@ -41,13 +41,31 @@ def name sig do override.params( - response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens], - uri: URI::Generic, + response_builder: ResponseBuilders::TestCollection, dispatcher: Prism::Dispatcher, + uri: URI::Generic, ).void end - def create_code_lens_listener(response_builder, uri, dispatcher) - CodeLens.new(response_builder, uri, dispatcher, T.must(@global_state), enabled: @enabled) + def create_discover_tests_listener(response_builder, dispatcher, uri) + global_state = @global_state + return unless global_state + return unless @enabled + + ShouldaTestStyle.new( + response_builder, + global_state, + dispatcher, + uri, + ) + end + + sig do + params( + items: T::Array[T::Hash[String, T.untyped]], + ).returns(T::Array[String]) + end + def resolve_test_commands(items) + ShouldaTestStyle.resolve_test_commands(items) end sig { override.returns(String) } diff --git a/lib/ruby_lsp/ruby-lsp-shoulda-context/code_lens.rb b/lib/ruby_lsp/ruby-lsp-shoulda-context/code_lens.rb deleted file mode 100644 index 8e8495e..0000000 --- a/lib/ruby_lsp/ruby-lsp-shoulda-context/code_lens.rb +++ /dev/null @@ -1,213 +0,0 @@ -# typed: strict -# frozen_string_literal: true - -module RubyLsp - module ShouldaContext - class CodeLens - extend T::Sig - extend T::Generic - - include ::RubyLsp::Requests::Support::Common - - REQUIRED_LIBRARY = T.let("shoulda-context", String) - - ResponseType = type_member { { fixed: T::Array[::RubyLsp::Interface::CodeLens] } } - - sig do - params( - response_builder: RubyLsp::ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens], - uri: URI::Generic, - dispatcher: Prism::Dispatcher, - global_state: RubyLsp::GlobalState, - enabled: T::Boolean, - ).void - end - def initialize(response_builder, uri, dispatcher, global_state, enabled:) - return unless enabled - - @response_builder = response_builder - @global_state = global_state - - # Listener is only initialized if uri.to_standardized_path is valid - @path = T.let(uri.to_standardized_path, String) - @class_name = T.let("", String) - @group_id = T.let(1, Integer) - @group_id_stack = T.let([], T::Array[Integer]) - @pattern = T.let("test_: ", String) - dispatcher.register(self, :on_call_node_enter, :on_call_node_leave, :on_class_node_enter, :on_class_node_leave) - - @base_command = T.let(initialize_base_command, String) - end - - sig { returns(String) } - def initialize_base_command - cmd = File.exist?(File.join(Dir.pwd, "bin", "rails")) ? "bin/rails test" : "ruby -ITest" - begin - Bundler.with_original_env { Bundler.default_lockfile } - "bundle exec #{cmd}" - rescue Bundler::GemfileNotFound - cmd - end - end - - sig { params(node: Prism::CallNode).void } - def on_call_node_enter(node) - case node.message - when "should" - name = generate_name(node) - - # If is top level should without context the DSL is different - if @group_id_stack.length == 1 - @pattern += "#{@class_name} " - end - - @pattern += "should #{name} " - add_test_code_lens(node, name: name, kind: :example) - when "context" - return unless valid_group?(node) - - name = generate_name(node) - @pattern += "#{name} " - add_test_code_lens(node, name: name, kind: :group) - - @group_id_stack.push(@group_id) - @group_id += 1 - end - end - - sig { params(node: Prism::CallNode).void } - def on_call_node_leave(node) - case node.message - when "should" - name = generate_name(node) - - @pattern = remove_last_pattern_in_string(@pattern, "should #{name} ") - - # If is top level should without context the DSL is different - if @group_id_stack.length == 1 - @pattern = remove_last_pattern_in_string(@pattern, "#{@class_name} ") - end - when "context" - return unless valid_group?(node) - - name = generate_name(node) - @pattern = remove_last_pattern_in_string(@pattern, "#{name} ") - @group_id_stack.pop - end - end - - sig { params(node: Prism::ClassNode).void } - def on_class_node_enter(node) - class_name = node.constant_path.slice - @class_name = remove_last_pattern_in_string(class_name, "Test") - - if class_name.end_with?("Test") - add_test_code_lens( - node, - name: class_name, - kind: :class, - ) - end - - @group_id_stack.push(@group_id) - @group_id += 1 - end - - sig { params(node: Prism::ClassNode).void } - def on_class_node_leave(node) - @group_id_stack.pop - end - - private - - sig { params(string: String, pattern: String).returns(String) } - def remove_last_pattern_in_string(string, pattern) - string.sub(/#{pattern}$/, "") - end - - sig { params(node: Prism::CallNode).returns(T::Boolean) } - def valid_group?(node) - !node.block.nil? - end - - sig { params(node: Prism::CallNode).returns(String) } - def generate_name(node) - arguments = node.arguments&.arguments - - if arguments - argument = arguments.first - - case argument - when Prism::StringNode - argument.content - when Prism::CallNode - "<#{argument.name}>" - when nil - "" - else - argument.slice - end - else - "" - end - end - - sig { params(node: Prism::Node, name: String, kind: Symbol).void } - def add_test_code_lens(node, name:, kind:) - return unless are_required_libraries_installed? - - if kind == :class - pattern = "#{@class_name}Test" - kind = :group - else - pattern = @pattern.strip - end - command = "#{@base_command} #{@path} --name \"/#{pattern}/\"" - - grouping_data = { group_id: @group_id_stack.last, kind: kind } - grouping_data[:id] = @group_id if kind == :group - - arguments = [ - @path, - name, - command, - { - start_line: node.location.start_line - 1, - start_column: node.location.start_column, - end_line: node.location.end_line - 1, - end_column: node.location.end_column, - }, - ] - - @response_builder << create_code_lens( - node, - title: "Run", - command_name: "rubyLsp.runTest", - arguments: arguments, - data: { type: "test", **grouping_data }, - ) - - @response_builder << create_code_lens( - node, - title: "Run In Terminal", - command_name: "rubyLsp.runTestInTerminal", - arguments: arguments, - data: { type: "test_in_terminal", **grouping_data }, - ) - - @response_builder << create_code_lens( - node, - title: "Debug", - command_name: "rubyLsp.debugTest", - arguments: arguments, - data: { type: "debug", **grouping_data }, - ) - end - - sig { returns(T::Boolean) } - def are_required_libraries_installed? - Bundler.locked_gems.dependencies.keys.include?(REQUIRED_LIBRARY) - end - end - end -end diff --git a/lib/ruby_lsp/ruby-lsp-shoulda-context/listeners/test_discovery.rb b/lib/ruby_lsp/ruby-lsp-shoulda-context/listeners/test_discovery.rb new file mode 100644 index 0000000..a922913 --- /dev/null +++ b/lib/ruby_lsp/ruby-lsp-shoulda-context/listeners/test_discovery.rb @@ -0,0 +1,287 @@ +# typed: strict +# frozen_string_literal: true + +module RubyLsp + module ShouldaContext + class ShouldaTestStyle < Listeners::TestDiscovery + extend T::Sig + include Requests::Support::Common + + class << self + extend T::Sig + + # Return a minimal set of test commands + # to run the given test items + sig { params(items: T::Array[T::Hash[String, T.untyped]]).returns(T::Array[String]) } + def resolve_test_commands(items) + # A nested hash of file_path => test_regex to ensure we build the + # minimum amount of commands needed to execute the requested tests. + aggregated_tests = Hash.new { |hash, key| hash[key] = Set.new } + + # Full files are paths that should be executed as a whole + full_files = [] + queue = items.dup + + until queue.empty? + item = T.must(queue.shift) + tags = Set.new(item[:tags]) + next unless tags.include?("framework:shoulda") + + children = item[:children] + uri = URI(item[:uri]) + path = uri.to_standardized_path + next unless path + + if tags.include?("test_dir") + if children.empty? + full_files.concat(Dir.glob( + "#{path}/**/{*_test,test_*}.rb", + File::Constants::FNM_EXTGLOB | File::Constants::FNM_PATHNAME, + )) + end + elsif tags.include?("test_file") + full_files << path if children.empty? + elsif tags.include?("test_group") + # If this is a class (contains "::"), process it with its children + if item[:id].include?("::") || item[:id].end_with?("Test") + process_test_group(aggregated_tests, path, item, []) + end + # NOTE: We intentionally don't process non-class groups at the top level + end + + queue.concat(children) unless children.empty? + end + + commands = [] + + aggregated_tests.each do |file_path, test_patterns| + test_patterns.each do |pattern| + commands << "#{BASE_COMMAND} -ITest #{file_path} --name \"/#{pattern}/\"" + end + end + + unless full_files.empty? + commands << "echo \"debug\"; #{BASE_COMMAND} -Itest -e \"ARGV.each { |f| require f }\" #{full_files.join(" ")}" + end + + commands + end + + private + + # Process a test group and all its children recursively to build the test regex pattern + def process_test_group(aggregated_tests, file_path, item, pattern_parts) + pattern_parts = pattern_parts.dup + + # Check if this is a class (test group with ::) + is_class = item[:id].include?("::") + + if is_class + # For class, store the full class name + class_name = item[:id] + # Start with the class prefix for further patterns + updated_pattern = ["#{class_name}#test_:"] + elsif pattern_parts.empty? + # For context, add the context name to the pattern + # This should not happen as the first item should always be a class + updated_pattern = ["test_: #{item[:label]}"] + else + # Add this context to the existing pattern + updated_pattern = pattern_parts.dup + updated_pattern[-1] = "#{updated_pattern[-1]} #{item[:label]}" + end + + children = item[:children] || [] + + if children.empty? + # If no children, add the pattern that matches the group itself + pattern = updated_pattern.join(" ") + aggregated_tests[file_path].add(pattern) + else + children.each do |child| + if (child[:tags] || []).include?("test_group") + # Recursively process nested test groups + process_test_group(aggregated_tests, file_path, child, updated_pattern) + else + # Handle should items + should_pattern = updated_pattern.dup + # Add "should" and the should label + should_pattern[-1] = "#{should_pattern[-1]} should #{child[:label]}" + aggregated_tests[file_path].add(should_pattern.join(" ")) + end + end + end + end + + BASE_COMMAND = begin + Bundler.with_original_env { Bundler.default_lockfile } + "bundle exec ruby" + rescue Bundler::GemfileNotFound + "ruby" + end + end + + sig { params(response_builder: ResponseBuilders::TestCollection, global_state: GlobalState, dispatcher: Prism::Dispatcher, uri: URI::Generic).void } + def initialize(response_builder, global_state, dispatcher, uri) + super + @response_builder = response_builder + @uri = uri + @visibility_stack = T.let([], T::Array[Symbol]) + @nesting = T.let([], T::Array[String]) + @context_block_nesting = T.let([], T::Array[String]) + + dispatcher.register( + self, + :on_class_node_enter, + :on_class_node_leave, + :on_call_node_enter, + :on_call_node_leave, + ) + end + + sig { params(node: Prism::ClassNode).void } + def on_class_node_enter(node) + @nesting << constant_name(node.constant_path) + + # TODO: Improve based on ancestor classes + class_name = @nesting.join("::") + return unless class_name.end_with?("Test") + + test_item = Requests::Support::TestItem.new( + class_name, + class_name, + @uri, + range_from_node(node), + framework: :shoulda, + ) + + @response_builder.add(test_item) + @response_builder.add_code_lens(test_item) + end + + sig { params(node: Prism::ClassNode).void } + def on_class_node_leave(node) + @nesting.pop + end + + sig { params(node: Prism::CallNode).void } + def on_call_node_enter(node) + case node.name + when :context + handle_context(node) + when :should + handle_should(node) + end + end + + sig { params(node: Prism::CallNode).void } + def on_call_node_leave(node) + return unless node.name == :context + + handle_context_leave(node) + end + + private + + sig { params(node: Prism::CallNode).void } + def handle_context(node) + return unless valid_context?(node) + + description = extract_description(node) + return unless description + + add_to_parent_test_group(description, node) + + @context_block_nesting << description + end + + sig { params(node: Prism::CallNode).void } + def handle_context_leave(node) + return unless valid_context?(node) + + @context_block_nesting.pop + end + + sig { params(node: Prism::CallNode).void } + def handle_should(node) + return unless in_test_class? + + description = extract_description(node) + return unless description + + add_to_parent_test_group(description, node) + end + + sig { params(node: Prism::CallNode).returns(T.nilable(String)) } + def extract_description(node) + first_argument = node.arguments&.arguments&.first + return unless first_argument + + case first_argument + when Prism::StringNode + first_argument.content + when Prism::CallNode + "<#{first_argument.slice}>" + else + first_argument.slice + end + end + + sig { params(node: Prism::CallNode).returns(T::Boolean) } + def valid_context?(node) + return false unless in_test_class? + return false if node.block.nil? + + first_argument = node.arguments&.arguments&.first + return false unless first_argument.is_a?(Prism::StringNode) + + true + end + + sig { params(description: String, node: Prism::CallNode).void } + def add_to_parent_test_group(description, node) + parent_test_group = find_parent_test_group + + return unless parent_test_group + + test_item = Requests::Support::TestItem.new( + description, + description, + @uri, + range_from_node(node), + framework: :shoulda, + ) + + parent_test_group.add(test_item) + @response_builder.add_code_lens(test_item) + end + + sig { returns(T.nilable(Requests::Support::TestItem)) } + def find_parent_test_group + root_group_name = RubyIndexer::Index.actual_nesting(@nesting, nil).join("::") + return unless root_group_name + + root_test_group = @response_builder[root_group_name] + return root_test_group if @context_block_nesting.empty? + + test_group = root_test_group + + @context_block_nesting.each do |description| + test_group = test_group[description] + end + + test_group + end + + sig { returns(T::Boolean) } + def in_test_class? + return false if @nesting.empty? + + class_name = @nesting.join("::") + return false unless class_name.end_with?("Test") + + true + end + end + end +end diff --git a/sorbet/rbi/gems/date@3.4.1.rbi b/sorbet/rbi/gems/date@3.4.1.rbi new file mode 100644 index 0000000..1dcd7c8 --- /dev/null +++ b/sorbet/rbi/gems/date@3.4.1.rbi @@ -0,0 +1,75 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for types exported from the `date` gem. +# Please instead update this file by running `bin/tapioca gem date`. + + +# source://date//lib/date.rb#6 +class Date + include ::Comparable + + # call-seq: + # infinite? -> false + # + # Returns +false+ + # + # @return [Boolean] + # + # source://date//lib/date.rb#13 + def infinite?; end +end + +# source://date//lib/date.rb#17 +class Date::Infinity < ::Numeric + # @return [Infinity] a new instance of Infinity + # + # source://date//lib/date.rb#19 + def initialize(d = T.unsafe(nil)); end + + # source://date//lib/date.rb#33 + def +@; end + + # source://date//lib/date.rb#32 + def -@; end + + # source://date//lib/date.rb#35 + def <=>(other); end + + # source://date//lib/date.rb#30 + def abs; end + + # source://date//lib/date.rb#51 + def coerce(other); end + + # @return [Boolean] + # + # source://date//lib/date.rb#26 + def finite?; end + + # @return [Boolean] + # + # source://date//lib/date.rb#27 + def infinite?; end + + # @return [Boolean] + # + # source://date//lib/date.rb#28 + def nan?; end + + # source://date//lib/date.rb#59 + def to_f; end + + # @return [Boolean] + # + # source://date//lib/date.rb#25 + def zero?; end + + protected + + # source://date//lib/date.rb#21 + def d; end +end + +# source://date//lib/date.rb#7 +Date::VERSION = T.let(T.unsafe(nil), String) diff --git a/sorbet/rbi/gems/io-console@0.7.2.rbi b/sorbet/rbi/gems/io-console@0.8.0.rbi similarity index 100% rename from sorbet/rbi/gems/io-console@0.7.2.rbi rename to sorbet/rbi/gems/io-console@0.8.0.rbi diff --git a/sorbet/rbi/gems/pp@0.6.2.rbi b/sorbet/rbi/gems/pp@0.6.2.rbi new file mode 100644 index 0000000..0a82eb8 --- /dev/null +++ b/sorbet/rbi/gems/pp@0.6.2.rbi @@ -0,0 +1,368 @@ +# typed: false + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for types exported from the `pp` gem. +# Please instead update this file by running `bin/tapioca gem pp`. + + +class Array + include ::Enumerable + + # source://pp//lib/pp.rb#402 + def pretty_print(q); end + + # source://pp//lib/pp.rb#410 + def pretty_print_cycle(q); end +end + +class Data + # source://pp//lib/pp.rb#456 + def pretty_print(q); end + + # source://pp//lib/pp.rb#484 + def pretty_print_cycle(q); end +end + +class File::Stat + include ::Comparable + + # source://pp//lib/pp.rb#518 + def pretty_print(q); end +end + +class Hash + include ::Enumerable + + # source://pp//lib/pp.rb#416 + def pretty_print(q); end + + # source://pp//lib/pp.rb#420 + def pretty_print_cycle(q); end +end + +module Kernel + # Returns a pretty printed object as a string. + # + # See the PP module for more information. + # + # source://pp//lib/pp.rb#685 + def pretty_inspect; end + + private + + # prints arguments in pretty form. + # + # +#pp+ returns argument(s). + # + # source://pp//lib/pp.rb#692 + def pp(*objs); end + + class << self + # prints arguments in pretty form. + # + # +#pp+ returns argument(s). + # + # source://pp//lib/pp.rb#692 + def pp(*objs); end + end +end + +class MatchData + # source://pp//lib/pp.rb#601 + def pretty_print(q); end +end + +# A pretty-printer for Ruby objects. +# +# +# == What PP Does +# +# Standard output by #p returns this: +# #, @group_queue=#], []]>, @buffer=[], @newline="\n", @group_stack=[#], @buffer_width=0, @indent=0, @maxwidth=79, @output_width=2, @output=#> +# +# Pretty-printed output returns this: +# #, +# @group_queue= +# #], +# []]>, +# @group_stack= +# [#], +# @indent=0, +# @maxwidth=79, +# @newline="\n", +# @output=#, +# @output_width=2> +# +# +# == Usage +# +# pp(obj) #=> obj +# pp obj #=> obj +# pp(obj1, obj2, ...) #=> [obj1, obj2, ...] +# pp() #=> nil +# +# Output obj(s) to $> in pretty printed format. +# +# It returns obj(s). +# +# +# == Output Customization +# +# To define a customized pretty printing function for your classes, +# redefine method #pretty_print(pp) in the class. +# Note that require 'pp' is needed before redefining #pretty_print(pp). +# +# #pretty_print takes the +pp+ argument, which is an instance of the PP class. +# The method uses #text, #breakable, #nest, #group and #pp to print the +# object. +# +# +# == Pretty-Print JSON +# +# To pretty-print JSON refer to JSON#pretty_generate. +# +# +# == Author +# Tanaka Akira +class PP < ::PrettyPrint + include ::PP::PPMethods + + class << self + # :stopdoc: + # + # source://pp//lib/pp.rb#116 + def mcall(obj, mod, meth, *args, &block); end + + # Outputs +obj+ to +out+ in pretty printed format of + # +width+ columns in width. + # + # If +out+ is omitted, $> is assumed. + # If +width+ is omitted, the width of +out+ is assumed (see + # width_for). + # + # PP.pp returns +out+. + # + # source://pp//lib/pp.rb#96 + def pp(obj, out = T.unsafe(nil), width = T.unsafe(nil)); end + + # Returns the sharing detection flag as a boolean value. + # It is false by default. + # + # source://pp//lib/pp.rb#125 + def sharing_detection; end + + # Returns the sharing detection flag as a boolean value. + # It is false by default. + # + # source://pp//lib/pp.rb#129 + def sharing_detection=(b); end + + # Outputs +obj+ to +out+ like PP.pp but with no indent and + # newline. + # + # PP.singleline_pp returns +out+. + # + # source://pp//lib/pp.rb#108 + def singleline_pp(obj, out = T.unsafe(nil)); end + + # Returns the usable width for +out+. + # As the width of +out+: + # 1. If +out+ is assigned to a tty device, its width is used. + # 2. Otherwise, or it could not get the value, the +COLUMN+ + # environment variable is assumed to be set to the width. + # 3. If +COLUMN+ is not set to a non-zero number, 80 is assumed. + # + # And finally, returns the above width value - 1. + # * This -1 is for Windows command prompt, which moves the cursor to + # the next line if it reaches the last column. + # + # source://pp//lib/pp.rb#79 + def width_for(out); end + end +end + +module PP::ObjectMixin + # A default pretty printing method for general objects. + # It calls #pretty_print_instance_variables to list instance variables. + # + # If +self+ has a customized (redefined) #inspect method, + # the result of self.inspect is used but it obviously has no + # line break hints. + # + # This module provides predefined #pretty_print methods for some of + # the most commonly used built-in classes for convenience. + # + # source://pp//lib/pp.rb#353 + def pretty_print(q); end + + # A default pretty printing method for general objects that are + # detected as part of a cycle. + # + # source://pp//lib/pp.rb#370 + def pretty_print_cycle(q); end + + # Is #inspect implementation using #pretty_print. + # If you implement #pretty_print, it can be used as follows. + # + # alias inspect pretty_print_inspect + # + # However, doing this requires that every class that #inspect is called on + # implement #pretty_print, or a RuntimeError will be raised. + # + # source://pp//lib/pp.rb#392 + def pretty_print_inspect; end + + # Returns a sorted array of instance variable names. + # + # This method should return an array of names of instance variables as symbols or strings as: + # +[:@a, :@b]+. + # + # source://pp//lib/pp.rb#381 + def pretty_print_instance_variables; end +end + +# Module that defines helper methods for pretty_print. +module PP::PPMethods + # Check whether the object_id +id+ is in the current buffer of objects + # to be pretty printed. Used to break cycles in chains of objects to be + # pretty printed. + # + # source://pp//lib/pp.rb#169 + def check_inspect_key(id); end + + # A convenience method which is same as follows: + # + # text ',' + # breakable + # + # source://pp//lib/pp.rb#232 + def comma_breakable; end + + # Yields to a block + # and preserves the previous set of objects being printed. + # + # source://pp//lib/pp.rb#147 + def guard_inspect_key; end + + # A convenience method, like object_group, but also reformats the Object's + # object_id. + # + # source://pp//lib/pp.rb#222 + def object_address_group(obj, &block); end + + # A convenience method which is same as follows: + # + # group(1, '#<' + obj.class.name, '>') { ... } + # + # source://pp//lib/pp.rb#216 + def object_group(obj, &block); end + + # Removes an object from the set of objects being pretty printed. + # + # source://pp//lib/pp.rb#182 + def pop_inspect_key(id); end + + # Adds +obj+ to the pretty printing buffer + # using Object#pretty_print or Object#pretty_print_cycle. + # + # Object#pretty_print_cycle is used when +obj+ is already + # printed, a.k.a the object reference chain has a cycle. + # + # source://pp//lib/pp.rb#191 + def pp(obj); end + + # A pretty print for a Hash + # + # source://pp//lib/pp.rb#291 + def pp_hash(obj); end + + # A pretty print for a pair of Hash + # + # source://pp//lib/pp.rb#303 + def pp_hash_pair(k, v); end + + # A present standard failsafe for pretty printing any given Object + # + # source://pp//lib/pp.rb#275 + def pp_object(obj); end + + # Adds the object_id +id+ to the set of objects being pretty printed, so + # as to not repeat objects. + # + # source://pp//lib/pp.rb#177 + def push_inspect_key(id); end + + # Adds a separated list. + # The list is separated by comma with breakable space, by default. + # + # #seplist iterates the +list+ using +iter_method+. + # It yields each object to the block given for #seplist. + # The procedure +separator_proc+ is called between each yields. + # + # If the iteration is zero times, +separator_proc+ is not called at all. + # + # If +separator_proc+ is nil or not given, + # +lambda { comma_breakable }+ is used. + # If +iter_method+ is not given, :each is used. + # + # For example, following 3 code fragments has similar effect. + # + # q.seplist([1,2,3]) {|v| xxx v } + # + # q.seplist([1,2,3], lambda { q.comma_breakable }, :each) {|v| xxx v } + # + # xxx 1 + # q.comma_breakable + # xxx 2 + # q.comma_breakable + # xxx 3 + # + # source://pp//lib/pp.rb#261 + def seplist(list, sep = T.unsafe(nil), iter_method = T.unsafe(nil)); end +end + +class PP::SingleLine < ::PrettyPrint::SingleLine + include ::PP::PPMethods +end + +# The version string +# +# source://pp//lib/pp.rb#67 +PP::VERSION = T.let(T.unsafe(nil), String) + +class Range + include ::Enumerable + + # source://pp//lib/pp.rb#490 + def pretty_print(q); end +end + +class RubyVM::AbstractSyntaxTree::Node + # source://pp//lib/pp.rb#640 + def pretty_print(q); end + + # source://pp//lib/pp.rb#627 + def pretty_print_children(q, names = T.unsafe(nil)); end +end + +class String + include ::Comparable + + # source://pp//lib/pp.rb#502 + def pretty_print(q); end +end + +class Struct + include ::Enumerable + + # source://pp//lib/pp.rb#436 + def pretty_print(q); end + + # source://pp//lib/pp.rb#450 + def pretty_print_cycle(q); end +end diff --git a/sorbet/rbi/gems/prettyprint@0.2.0.rbi b/sorbet/rbi/gems/prettyprint@0.2.0.rbi new file mode 100644 index 0000000..af822d8 --- /dev/null +++ b/sorbet/rbi/gems/prettyprint@0.2.0.rbi @@ -0,0 +1,477 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for types exported from the `prettyprint` gem. +# Please instead update this file by running `bin/tapioca gem prettyprint`. + + +# This class implements a pretty printing algorithm. It finds line breaks and +# nice indentations for grouped structure. +# +# By default, the class assumes that primitive elements are strings and each +# byte in the strings have single column in width. But it can be used for +# other situations by giving suitable arguments for some methods: +# * newline object and space generation block for PrettyPrint.new +# * optional width argument for PrettyPrint#text +# * PrettyPrint#breakable +# +# There are several candidate uses: +# * text formatting using proportional fonts +# * multibyte characters which has columns different to number of bytes +# * non-string formatting +# +# == Bugs +# * Box based formatting? +# * Other (better) model/algorithm? +# +# Report any bugs at http://bugs.ruby-lang.org +# +# == References +# Christian Lindig, Strictly Pretty, March 2000, +# https://lindig.github.io/papers/strictly-pretty-2000.pdf +# +# Philip Wadler, A prettier printer, March 1998, +# https://homepages.inf.ed.ac.uk/wadler/topics/language-design.html#prettier +# +# == Author +# Tanaka Akira +class PrettyPrint + # Creates a buffer for pretty printing. + # + # +output+ is an output target. If it is not specified, '' is assumed. It + # should have a << method which accepts the first argument +obj+ of + # PrettyPrint#text, the first argument +sep+ of PrettyPrint#breakable, the + # first argument +newline+ of PrettyPrint.new, and the result of a given + # block for PrettyPrint.new. + # + # +maxwidth+ specifies maximum line length. If it is not specified, 79 is + # assumed. However actual outputs may overflow +maxwidth+ if long + # non-breakable texts are provided. + # + # +newline+ is used for line breaks. "\n" is used if it is not specified. + # + # The block is used to generate spaces. {|width| ' ' * width} is used if it + # is not given. + # + # @return [PrettyPrint] a new instance of PrettyPrint + # + # source://prettyprint//lib/prettyprint.rb#84 + def initialize(output = T.unsafe(nil), maxwidth = T.unsafe(nil), newline = T.unsafe(nil), &genspace); end + + # Breaks the buffer into lines that are shorter than #maxwidth + # + # source://prettyprint//lib/prettyprint.rb#162 + def break_outmost_groups; end + + # This says "you can break a line here if necessary", and a +width+\-column + # text +sep+ is inserted if a line is not broken at the point. + # + # If +sep+ is not specified, " " is used. + # + # If +width+ is not specified, +sep.length+ is used. You will have to + # specify this when +sep+ is a multibyte character, for example. + # + # source://prettyprint//lib/prettyprint.rb#226 + def breakable(sep = T.unsafe(nil), width = T.unsafe(nil)); end + + # Returns the group most recently added to the stack. + # + # Contrived example: + # out = "" + # => "" + # q = PrettyPrint.new(out) + # => #, @output_width=0, @buffer_width=0, @buffer=[], @group_stack=[#], @group_queue=#]]>, @indent=0> + # q.group { + # q.text q.current_group.inspect + # q.text q.newline + # q.group(q.current_group.depth + 1) { + # q.text q.current_group.inspect + # q.text q.newline + # q.group(q.current_group.depth + 1) { + # q.text q.current_group.inspect + # q.text q.newline + # q.group(q.current_group.depth + 1) { + # q.text q.current_group.inspect + # q.text q.newline + # } + # } + # } + # } + # => 284 + # puts out + # # + # # + # # + # # + # + # source://prettyprint//lib/prettyprint.rb#157 + def current_group; end + + # This is similar to #breakable except + # the decision to break or not is determined individually. + # + # Two #fill_breakable under a group may cause 4 results: + # (break,break), (break,non-break), (non-break,break), (non-break,non-break). + # This is different to #breakable because two #breakable under a group + # may cause 2 results: + # (break,break), (non-break,non-break). + # + # The text +sep+ is inserted if a line is not broken at this point. + # + # If +sep+ is not specified, " " is used. + # + # If +width+ is not specified, +sep.length+ is used. You will have to + # specify this when +sep+ is a multibyte character, for example. + # + # source://prettyprint//lib/prettyprint.rb#214 + def fill_breakable(sep = T.unsafe(nil), width = T.unsafe(nil)); end + + # outputs buffered data. + # + # source://prettyprint//lib/prettyprint.rb#290 + def flush; end + + # A lambda or Proc, that takes one argument, of an Integer, and returns + # the corresponding number of spaces. + # + # By default this is: + # lambda {|n| ' ' * n} + # + # source://prettyprint//lib/prettyprint.rb#120 + def genspace; end + + # Groups line break hints added in the block. The line break hints are all + # to be used or not. + # + # If +indent+ is specified, the method call is regarded as nested by + # nest(indent) { ... }. + # + # If +open_obj+ is specified, text open_obj, open_width is called + # before grouping. If +close_obj+ is specified, text close_obj, + # close_width is called after grouping. + # + # source://prettyprint//lib/prettyprint.rb#251 + def group(indent = T.unsafe(nil), open_obj = T.unsafe(nil), close_obj = T.unsafe(nil), open_width = T.unsafe(nil), close_width = T.unsafe(nil)); end + + # The PrettyPrint::GroupQueue of groups in stack to be pretty printed + # + # source://prettyprint//lib/prettyprint.rb#126 + def group_queue; end + + # Takes a block and queues a new group that is indented 1 level further. + # + # source://prettyprint//lib/prettyprint.rb#262 + def group_sub; end + + # The number of spaces to be indented + # + # source://prettyprint//lib/prettyprint.rb#123 + def indent; end + + # The maximum width of a line, before it is separated in to a newline + # + # This defaults to 79, and should be an Integer + # + # source://prettyprint//lib/prettyprint.rb#108 + def maxwidth; end + + # Increases left margin after newline with +indent+ for line breaks added in + # the block. + # + # source://prettyprint//lib/prettyprint.rb#279 + def nest(indent); end + + # The value that is appended to +output+ to add a new line. + # + # This defaults to "\n", and should be String + # + # source://prettyprint//lib/prettyprint.rb#113 + def newline; end + + # The output object. + # + # This defaults to '', and should accept the << method + # + # source://prettyprint//lib/prettyprint.rb#103 + def output; end + + # This adds +obj+ as a text of +width+ columns in width. + # + # If +width+ is not specified, obj.length is used. + # + # source://prettyprint//lib/prettyprint.rb#182 + def text(obj, width = T.unsafe(nil)); end + + class << self + # This is a convenience method which is same as follows: + # + # begin + # q = PrettyPrint.new(output, maxwidth, newline, &genspace) + # ... + # q.flush + # output + # end + # + # @yield [q] + # + # source://prettyprint//lib/prettyprint.rb#47 + def format(output = T.unsafe(nil), maxwidth = T.unsafe(nil), newline = T.unsafe(nil), genspace = T.unsafe(nil)); end + + # This is similar to PrettyPrint::format but the result has no breaks. + # + # +maxwidth+, +newline+ and +genspace+ are ignored. + # + # The invocation of +breakable+ in the block doesn't break a line and is + # treated as just an invocation of +text+. + # + # @yield [q] + # + # source://prettyprint//lib/prettyprint.rb#61 + def singleline_format(output = T.unsafe(nil), maxwidth = T.unsafe(nil), newline = T.unsafe(nil), genspace = T.unsafe(nil)); end + end +end + +# The Breakable class is used for breaking up object information +# +# This class is intended for internal use of the PrettyPrint buffers. +class PrettyPrint::Breakable + # Create a new Breakable object. + # + # Arguments: + # * +sep+ String of the separator + # * +width+ Integer width of the +sep+ + # * +q+ parent PrettyPrint object, to base from + # + # @return [Breakable] a new instance of Breakable + # + # source://prettyprint//lib/prettyprint.rb#347 + def initialize(sep, width, q); end + + # The number of spaces to indent. + # + # This is inferred from +q+ within PrettyPrint, passed in ::new + # + # source://prettyprint//lib/prettyprint.rb#367 + def indent; end + + # Holds the separator String + # + # The +sep+ argument from ::new + # + # source://prettyprint//lib/prettyprint.rb#359 + def obj; end + + # Render the String text of the objects that have been added to this + # Breakable object. + # + # Output the text to +out+, and increment the width to +output_width+ + # + # source://prettyprint//lib/prettyprint.rb#373 + def output(out, output_width); end + + # The width of +obj+ / +sep+ + # + # source://prettyprint//lib/prettyprint.rb#362 + def width; end +end + +# The Group class is used for making indentation easier. +# +# While this class does neither the breaking into newlines nor indentation, +# it is used in a stack (as well as a queue) within PrettyPrint, to group +# objects. +# +# For information on using groups, see PrettyPrint#group +# +# This class is intended for internal use of the PrettyPrint buffers. +class PrettyPrint::Group + # Create a Group object + # + # Arguments: + # * +depth+ - this group's relation to previous groups + # + # @return [Group] a new instance of Group + # + # source://prettyprint//lib/prettyprint.rb#401 + def initialize(depth); end + + # Makes a break for this Group, and returns true + # + # source://prettyprint//lib/prettyprint.rb#414 + def break; end + + # Boolean of whether this Group has made a break + # + # @return [Boolean] + # + # source://prettyprint//lib/prettyprint.rb#419 + def break?; end + + # Array to hold the Breakable objects for this Group + # + # source://prettyprint//lib/prettyprint.rb#411 + def breakables; end + + # This group's relation to previous groups + # + # source://prettyprint//lib/prettyprint.rb#408 + def depth; end + + # Boolean of whether this Group has been queried for being first + # + # This is used as a predicate, and ought to be called first. + # + # @return [Boolean] + # + # source://prettyprint//lib/prettyprint.rb#426 + def first?; end +end + +# The GroupQueue class is used for managing the queue of Group to be pretty +# printed. +# +# This queue groups the Group objects, based on their depth. +# +# This class is intended for internal use of the PrettyPrint buffers. +class PrettyPrint::GroupQueue + # Create a GroupQueue object + # + # Arguments: + # * +groups+ - one or more PrettyPrint::Group objects + # + # @return [GroupQueue] a new instance of GroupQueue + # + # source://prettyprint//lib/prettyprint.rb#447 + def initialize(*groups); end + + # Remote +group+ from this queue + # + # source://prettyprint//lib/prettyprint.rb#479 + def delete(group); end + + # Returns the outer group of the queue + # + # source://prettyprint//lib/prettyprint.rb#463 + def deq; end + + # Enqueue +group+ + # + # This does not strictly append the group to the end of the queue, + # but instead adds it in line, base on the +group.depth+ + # + # source://prettyprint//lib/prettyprint.rb#456 + def enq(group); end +end + +# PrettyPrint::SingleLine is used by PrettyPrint.singleline_format +# +# It is passed to be similar to a PrettyPrint object itself, by responding to: +# * #text +# * #breakable +# * #nest +# * #group +# * #flush +# * #first? +# +# but instead, the output has no line breaks +class PrettyPrint::SingleLine + # Create a PrettyPrint::SingleLine object + # + # Arguments: + # * +output+ - String (or similar) to store rendered text. Needs to respond to '<<' + # * +maxwidth+ - Argument position expected to be here for compatibility. + # This argument is a noop. + # * +newline+ - Argument position expected to be here for compatibility. + # This argument is a noop. + # + # @return [SingleLine] a new instance of SingleLine + # + # source://prettyprint//lib/prettyprint.rb#505 + def initialize(output, maxwidth = T.unsafe(nil), newline = T.unsafe(nil)); end + + # Appends +sep+ to the text to be output. By default +sep+ is ' ' + # + # +width+ argument is here for compatibility. It is a noop argument. + # + # source://prettyprint//lib/prettyprint.rb#520 + def breakable(sep = T.unsafe(nil), width = T.unsafe(nil)); end + + # This is used as a predicate, and ought to be called first. + # + # @return [Boolean] + # + # source://prettyprint//lib/prettyprint.rb#552 + def first?; end + + # Method present for compatibility, but is a noop + # + # source://prettyprint//lib/prettyprint.rb#548 + def flush; end + + # Opens a block for grouping objects to be pretty printed. + # + # Arguments: + # * +indent+ - noop argument. Present for compatibility. + # * +open_obj+ - text appended before the &blok. Default is '' + # * +close_obj+ - text appended after the &blok. Default is '' + # * +open_width+ - noop argument. Present for compatibility. + # * +close_width+ - noop argument. Present for compatibility. + # + # source://prettyprint//lib/prettyprint.rb#539 + def group(indent = T.unsafe(nil), open_obj = T.unsafe(nil), close_obj = T.unsafe(nil), open_width = T.unsafe(nil), close_width = T.unsafe(nil)); end + + # Takes +indent+ arg, but does nothing with it. + # + # Yields to a block. + # + # source://prettyprint//lib/prettyprint.rb#527 + def nest(indent); end + + # Add +obj+ to the text to be output. + # + # +width+ argument is here for compatibility. It is a noop argument. + # + # source://prettyprint//lib/prettyprint.rb#513 + def text(obj, width = T.unsafe(nil)); end +end + +# The Text class is the means by which to collect strings from objects. +# +# This class is intended for internal use of the PrettyPrint buffers. +class PrettyPrint::Text + # Creates a new text object. + # + # This constructor takes no arguments. + # + # The workflow is to append a PrettyPrint::Text object to the buffer, and + # being able to call the buffer.last() to reference it. + # + # As there are objects, use PrettyPrint::Text#add to include the objects + # and the width to utilized by the String version of this object. + # + # @return [Text] a new instance of Text + # + # source://prettyprint//lib/prettyprint.rb#312 + def initialize; end + + # Include +obj+ in the objects to be pretty printed, and increment + # this Text object's total width by +width+ + # + # source://prettyprint//lib/prettyprint.rb#330 + def add(obj, width); end + + # Render the String text of the objects that have been added to this Text object. + # + # Output the text to +out+, and increment the width to +output_width+ + # + # source://prettyprint//lib/prettyprint.rb#323 + def output(out, output_width); end + + # The total width of the objects included in this Text object. + # + # source://prettyprint//lib/prettyprint.rb#318 + def width; end +end + +# source://prettyprint//lib/prettyprint.rb#36 +PrettyPrint::VERSION = T.let(T.unsafe(nil), String) diff --git a/sorbet/rbi/gems/psych@5.1.2.rbi b/sorbet/rbi/gems/psych@5.2.3.rbi similarity index 90% rename from sorbet/rbi/gems/psych@5.1.2.rbi rename to sorbet/rbi/gems/psych@5.2.3.rbi index 7ef4ae4..a98c089 100644 --- a/sorbet/rbi/gems/psych@5.1.2.rbi +++ b/sorbet/rbi/gems/psych@5.2.3.rbi @@ -79,7 +79,7 @@ end # Psych.safe_load_file("data.yml", permitted_classes: [Date]) # Psych.load_file("trusted_database.yml") # -# ==== Exception handling +# ==== \Exception handling # # begin # # The second argument changes only the exception contents @@ -143,7 +143,7 @@ end # # Returns Psych::Nodes::Document # Psych.parse_file('database.yml') # -# ==== Exception handling +# ==== \Exception handling # # begin # # The second argument changes only the exception contents @@ -229,24 +229,24 @@ end # source://psych//lib/psych/versions.rb#3 module Psych class << self - # source://psych//lib/psych.rb#682 + # source://psych//lib/psych.rb#700 def add_builtin_type(type_tag, &block); end # :stopdoc: # - # source://psych//lib/psych.rb#676 + # source://psych//lib/psych.rb#694 def add_domain_type(domain, type_tag, &block); end - # source://psych//lib/psych.rb#692 + # source://psych//lib/psych.rb#710 def add_tag(tag, klass); end - # source://psych//lib/psych.rb#708 + # source://psych//lib/psych.rb#726 def config; end - # source://psych//lib/psych.rb#720 + # source://psych//lib/psych.rb#738 def domain_types; end - # source://psych//lib/psych.rb#732 + # source://psych//lib/psych.rb#750 def domain_types=(value); end # call-seq: @@ -267,6 +267,7 @@ module Psych # # Default: 2. # [:line_width] Max character to wrap line at. + # For unlimited line width use -1. # # Default: 0 (meaning "wrap at 81"). # [:canonical] Write "canonical" YAML form (very verbose, yet @@ -277,6 +278,10 @@ module Psych # # Default: false. # + # [:stringify_names] Dump symbol keys in Hash objects as string. + # + # Default: false. + # # Example: # # # Dump an array, get back a YAML string @@ -291,7 +296,10 @@ module Psych # # Dump an array to an IO with indentation set # Psych.dump(['a', ['b']], StringIO.new, indentation: 3) # - # source://psych//lib/psych.rb#505 + # # Dump hash with symbol keys as string + # Psych.dump({a: "b"}, stringify_names: true) # => "---\na: b\n" + # + # source://psych//lib/psych.rb#515 def dump(o, io = T.unsafe(nil), options = T.unsafe(nil)); end # Dump a list of objects as separate documents to a document stream. @@ -300,20 +308,20 @@ module Psych # # Psych.dump_stream("foo\n ", {}) # => "--- ! \"foo\\n \"\n--- {}\n" # - # source://psych//lib/psych.rb#595 + # source://psych//lib/psych.rb#613 def dump_stream(*objects); end - # source://psych//lib/psych.rb#716 + # source://psych//lib/psych.rb#734 def dump_tags; end - # source://psych//lib/psych.rb#728 + # source://psych//lib/psych.rb#746 def dump_tags=(value); end # Load +yaml+ in to a Ruby data structure. If multiple documents are # provided, the object contained in the first document will be returned. # +filename+ will be used in the exception message if any exception # is raised while parsing. If +yaml+ is empty, it returns - # the specified +fallback+ return value, which defaults to +false+. + # the specified +fallback+ return value, which defaults to +nil+. # # Raises a Psych::SyntaxError when a YAML syntax error is detected. # @@ -338,15 +346,15 @@ module Psych # Raises a TypeError when `yaml` parameter is NilClass. This method is # similar to `safe_load` except that `Symbol` objects are allowed by default. # - # source://psych//lib/psych.rb#368 + # source://psych//lib/psych.rb#370 def load(yaml, permitted_classes: T.unsafe(nil), permitted_symbols: T.unsafe(nil), aliases: T.unsafe(nil), filename: T.unsafe(nil), fallback: T.unsafe(nil), symbolize_names: T.unsafe(nil), freeze: T.unsafe(nil), strict_integer: T.unsafe(nil)); end # Loads the document contained in +filename+. Returns the yaml contained in # +filename+ as a Ruby object, or if the file is empty, it returns - # the specified +fallback+ return value, which defaults to +false+. + # the specified +fallback+ return value, which defaults to +nil+. # See load for options. # - # source://psych//lib/psych.rb#669 + # source://psych//lib/psych.rb#687 def load_file(filename, **kwargs); end # Load multiple documents given in +yaml+. Returns the parsed documents @@ -363,13 +371,13 @@ module Psych # end # list # => ['foo', 'bar'] # - # source://psych//lib/psych.rb#626 + # source://psych//lib/psych.rb#644 def load_stream(yaml, filename: T.unsafe(nil), fallback: T.unsafe(nil), **kwargs); end - # source://psych//lib/psych.rb#712 + # source://psych//lib/psych.rb#730 def load_tags; end - # source://psych//lib/psych.rb#724 + # source://psych//lib/psych.rb#742 def load_tags=(value); end # Parse a YAML string in +yaml+. Returns the Psych::Nodes::Document. @@ -391,14 +399,14 @@ module Psych # # See Psych::Nodes for more information about YAML AST. # - # source://psych//lib/psych.rb#398 + # source://psych//lib/psych.rb#400 def parse(yaml, filename: T.unsafe(nil)); end # Parse a file at +filename+. Returns the Psych::Nodes::Document. # # Raises a Psych::SyntaxError when a YAML syntax error is detected. # - # source://psych//lib/psych.rb#410 + # source://psych//lib/psych.rb#412 def parse_file(filename, fallback: T.unsafe(nil)); end # Parse a YAML string in +yaml+. Returns the Psych::Nodes::Stream. @@ -430,15 +438,15 @@ module Psych # # See Psych::Nodes for more information about YAML AST. # - # source://psych//lib/psych.rb#452 + # source://psych//lib/psych.rb#454 def parse_stream(yaml, filename: T.unsafe(nil), &block); end # Returns a default parser # - # source://psych//lib/psych.rb#419 + # source://psych//lib/psych.rb#421 def parser; end - # source://psych//lib/psych.rb#688 + # source://psych//lib/psych.rb#706 def remove_type(type_tag); end # call-seq: @@ -479,6 +487,7 @@ module Psych # # Default: 2. # [:line_width] Max character to wrap line at. + # For unlimited line width use -1. # # Default: 0 (meaning "wrap at 81"). # [:canonical] Write "canonical" YAML form (very verbose, yet @@ -489,6 +498,10 @@ module Psych # # Default: false. # + # [:stringify_names] Dump symbol keys in Hash objects as string. + # + # Default: false. + # # Example: # # # Dump an array, get back a YAML string @@ -503,7 +516,10 @@ module Psych # # Dump an array to an IO with indentation set # Psych.safe_dump(['a', ['b']], StringIO.new, indentation: 3) # - # source://psych//lib/psych.rb#578 + # # Dump hash with symbol keys as string + # Psych.dump({a: "b"}, stringify_names: true) # => "---\na: b\n" + # + # source://psych//lib/psych.rb#596 def safe_dump(o, io = T.unsafe(nil), options = T.unsafe(nil)); end # Safely load the yaml string in +yaml+. By default, only the following @@ -550,20 +566,20 @@ module Psych # Psych.safe_load("---\n foo: bar") # => {"foo"=>"bar"} # Psych.safe_load("---\n foo: bar", symbolize_names: true) # => {:foo=>"bar"} # - # source://psych//lib/psych.rb#322 + # source://psych//lib/psych.rb#324 def safe_load(yaml, permitted_classes: T.unsafe(nil), permitted_symbols: T.unsafe(nil), aliases: T.unsafe(nil), filename: T.unsafe(nil), fallback: T.unsafe(nil), symbolize_names: T.unsafe(nil), freeze: T.unsafe(nil), strict_integer: T.unsafe(nil)); end # Safely loads the document contained in +filename+. Returns the yaml contained in # +filename+ as a Ruby object, or if the file is empty, it returns - # the specified +fallback+ return value, which defaults to +false+. + # the specified +fallback+ return value, which defaults to +nil+. # See safe_load for options. # - # source://psych//lib/psych.rb#658 + # source://psych//lib/psych.rb#676 def safe_load_file(filename, **kwargs); end # Dump Ruby +object+ to a JSON string. # - # source://psych//lib/psych.rb#605 + # source://psych//lib/psych.rb#623 def to_json(object); end # Load +yaml+ in to a Ruby data structure. If multiple documents are @@ -598,7 +614,7 @@ module Psych # YAML documents that are supplied via user input. Instead, please use the # load method or the safe_load method. # - # source://psych//lib/psych.rb#271 + # source://psych//lib/psych.rb#273 def unsafe_load(yaml, filename: T.unsafe(nil), fallback: T.unsafe(nil), symbolize_names: T.unsafe(nil), freeze: T.unsafe(nil), strict_integer: T.unsafe(nil)); end # Load the document contained in +filename+. Returns the yaml contained in @@ -609,7 +625,7 @@ module Psych # YAML documents that are supplied via user input. Instead, please use the # safe_load_file method. # - # source://psych//lib/psych.rb#647 + # source://psych//lib/psych.rb#665 def unsafe_load_file(filename, **kwargs); end end end @@ -1377,7 +1393,7 @@ end # The base class for any Node in a YAML parse tree. This class should # never be instantiated. # -# source://psych//lib/psych/nodes/node.rb#11 +# source://psych//lib/psych/nodes/node.rb#10 class Psych::Nodes::Node include ::Enumerable @@ -1385,7 +1401,7 @@ class Psych::Nodes::Node # # @return [Node] a new instance of Node # - # source://psych//lib/psych/nodes/node.rb#33 + # source://psych//lib/psych/nodes/node.rb#32 def initialize; end # @return [Boolean] @@ -1395,7 +1411,7 @@ class Psych::Nodes::Node # The children of this node # - # source://psych//lib/psych/nodes/node.rb#15 + # source://psych//lib/psych/nodes/node.rb#14 def children; end # @return [Boolean] @@ -1406,27 +1422,27 @@ class Psych::Nodes::Node # Iterate over each node in the tree. Yields each node to +block+ depth # first. # - # source://psych//lib/psych/nodes/node.rb#40 + # source://psych//lib/psych/nodes/node.rb#39 def each(&block); end # The column number where this node ends # - # source://psych//lib/psych/nodes/node.rb#30 + # source://psych//lib/psych/nodes/node.rb#29 def end_column; end # The column number where this node ends # - # source://psych//lib/psych/nodes/node.rb#30 + # source://psych//lib/psych/nodes/node.rb#29 def end_column=(_arg0); end # The line number where this node ends # - # source://psych//lib/psych/nodes/node.rb#27 + # source://psych//lib/psych/nodes/node.rb#26 def end_line; end # The line number where this node ends # - # source://psych//lib/psych/nodes/node.rb#27 + # source://psych//lib/psych/nodes/node.rb#26 def end_line=(_arg0); end # @return [Boolean] @@ -1446,22 +1462,22 @@ class Psych::Nodes::Node # The column number where this node start # - # source://psych//lib/psych/nodes/node.rb#24 + # source://psych//lib/psych/nodes/node.rb#23 def start_column; end # The column number where this node start # - # source://psych//lib/psych/nodes/node.rb#24 + # source://psych//lib/psych/nodes/node.rb#23 def start_column=(_arg0); end # The line number where this node start # - # source://psych//lib/psych/nodes/node.rb#21 + # source://psych//lib/psych/nodes/node.rb#20 def start_line; end # The line number where this node start # - # source://psych//lib/psych/nodes/node.rb#21 + # source://psych//lib/psych/nodes/node.rb#20 def start_line=(_arg0); end # @return [Boolean] @@ -1471,35 +1487,35 @@ class Psych::Nodes::Node # An associated tag # - # source://psych//lib/psych/nodes/node.rb#18 + # source://psych//lib/psych/nodes/node.rb#17 def tag; end # Convert this node to Ruby. # # See also Psych::Visitors::ToRuby # - # source://psych//lib/psych/nodes/node.rb#49 + # source://psych//lib/psych/nodes/node.rb#48 def to_ruby(symbolize_names: T.unsafe(nil), freeze: T.unsafe(nil), strict_integer: T.unsafe(nil)); end # Convert this node to YAML. # # See also Psych::Visitors::Emitter # - # source://psych//lib/psych/nodes/node.rb#58 + # source://psych//lib/psych/nodes/node.rb#57 def to_yaml(io = T.unsafe(nil), options = T.unsafe(nil)); end # Convert this node to Ruby. # # See also Psych::Visitors::ToRuby # - # source://psych//lib/psych/nodes/node.rb#49 + # source://psych//lib/psych/nodes/node.rb#48 def transform(symbolize_names: T.unsafe(nil), freeze: T.unsafe(nil), strict_integer: T.unsafe(nil)); end # Convert this node to YAML. # # See also Psych::Visitors::Emitter # - # source://psych//lib/psych/nodes/node.rb#58 + # source://psych//lib/psych/nodes/node.rb#57 def yaml(io = T.unsafe(nil), options = T.unsafe(nil)); end end @@ -1809,12 +1825,12 @@ class Psych::ScalarScanner # Parse and return an int from +string+ # - # source://psych//lib/psych/scalar_scanner.rb#109 + # source://psych//lib/psych/scalar_scanner.rb#108 def parse_int(string); end # Parse and return a Time from +string+ # - # source://psych//lib/psych/scalar_scanner.rb#115 + # source://psych//lib/psych/scalar_scanner.rb#114 def parse_time(string); end # Tokenize +string+ returning the Ruby object @@ -1829,7 +1845,7 @@ end # source://psych//lib/psych/scalar_scanner.rb#22 Psych::ScalarScanner::INTEGER_LEGACY = T.let(T.unsafe(nil), Regexp) -# Taken from http://yaml.org/type/int.html +# Taken from http://yaml.org/type/int.html and modified to ensure at least one numerical symbol exists # # source://psych//lib/psych/scalar_scanner.rb#15 Psych::ScalarScanner::INTEGER_STRICT = T.let(T.unsafe(nil), Regexp) @@ -2096,29 +2112,29 @@ class Psych::Visitors::JSONTree < ::Psych::Visitors::YAMLTree end end -# source://psych//lib/psych/visitors/to_ruby.rb#430 +# source://psych//lib/psych/visitors/to_ruby.rb#429 class Psych::Visitors::NoAliasRuby < ::Psych::Visitors::ToRuby # @raise [AliasesNotEnabled] # - # source://psych//lib/psych/visitors/to_ruby.rb#431 + # source://psych//lib/psych/visitors/to_ruby.rb#430 def visit_Psych_Nodes_Alias(o); end end -# source://psych//lib/psych/visitors/yaml_tree.rb#540 +# source://psych//lib/psych/visitors/yaml_tree.rb#537 class Psych::Visitors::RestrictedYAMLTree < ::Psych::Visitors::YAMLTree # @return [RestrictedYAMLTree] a new instance of RestrictedYAMLTree # - # source://psych//lib/psych/visitors/yaml_tree.rb#552 + # source://psych//lib/psych/visitors/yaml_tree.rb#549 def initialize(emitter, ss, options); end - # source://psych//lib/psych/visitors/yaml_tree.rb#565 + # source://psych//lib/psych/visitors/yaml_tree.rb#562 def accept(target); end - # source://psych//lib/psych/visitors/yaml_tree.rb#577 + # source://psych//lib/psych/visitors/yaml_tree.rb#574 def visit_Symbol(sym); end end -# source://psych//lib/psych/visitors/yaml_tree.rb#541 +# source://psych//lib/psych/visitors/yaml_tree.rb#538 Psych::Visitors::RestrictedYAMLTree::DEFAULT_PERMITTED_CLASSES = T.let(T.unsafe(nil), Hash) # This class walks a YAML AST, converting each node to Ruby @@ -2138,53 +2154,53 @@ class Psych::Visitors::ToRuby < ::Psych::Visitors::Visitor # source://psych//lib/psych/visitors/to_ruby.rb#21 def class_loader; end - # source://psych//lib/psych/visitors/to_ruby.rb#327 + # source://psych//lib/psych/visitors/to_ruby.rb#326 def visit_Psych_Nodes_Alias(o); end - # source://psych//lib/psych/visitors/to_ruby.rb#319 + # source://psych//lib/psych/visitors/to_ruby.rb#318 def visit_Psych_Nodes_Document(o); end - # source://psych//lib/psych/visitors/to_ruby.rb#165 + # source://psych//lib/psych/visitors/to_ruby.rb#164 def visit_Psych_Nodes_Mapping(o); end - # source://psych//lib/psych/visitors/to_ruby.rb#129 + # source://psych//lib/psych/visitors/to_ruby.rb#128 def visit_Psych_Nodes_Scalar(o); end - # source://psych//lib/psych/visitors/to_ruby.rb#133 + # source://psych//lib/psych/visitors/to_ruby.rb#132 def visit_Psych_Nodes_Sequence(o); end - # source://psych//lib/psych/visitors/to_ruby.rb#323 + # source://psych//lib/psych/visitors/to_ruby.rb#322 def visit_Psych_Nodes_Stream(o); end private - # source://psych//lib/psych/visitors/to_ruby.rb#395 + # source://psych//lib/psych/visitors/to_ruby.rb#394 def deduplicate(key); end # source://psych//lib/psych/visitors/to_ruby.rb#51 def deserialize(o); end - # source://psych//lib/psych/visitors/to_ruby.rb#412 + # source://psych//lib/psych/visitors/to_ruby.rb#411 def init_with(o, h, node); end - # source://psych//lib/psych/visitors/to_ruby.rb#404 + # source://psych//lib/psych/visitors/to_ruby.rb#403 def merge_key(hash, key, val); end - # source://psych//lib/psych/visitors/to_ruby.rb#333 + # source://psych//lib/psych/visitors/to_ruby.rb#332 def register(node, object); end - # source://psych//lib/psych/visitors/to_ruby.rb#338 + # source://psych//lib/psych/visitors/to_ruby.rb#337 def register_empty(object); end # Convert +klassname+ to a Class # - # source://psych//lib/psych/visitors/to_ruby.rb#425 + # source://psych//lib/psych/visitors/to_ruby.rb#424 def resolve_class(klassname); end - # source://psych//lib/psych/visitors/to_ruby.rb#407 + # source://psych//lib/psych/visitors/to_ruby.rb#406 def revive(klass, node); end - # source://psych//lib/psych/visitors/to_ruby.rb#344 + # source://psych//lib/psych/visitors/to_ruby.rb#343 def revive_hash(hash, o, tagged = T.unsafe(nil)); end class << self @@ -2224,174 +2240,174 @@ end class Psych::Visitors::YAMLTree < ::Psych::Visitors::Visitor # @return [YAMLTree] a new instance of YAMLTree # - # source://psych//lib/psych/visitors/yaml_tree.rb#55 + # source://psych//lib/psych/visitors/yaml_tree.rb#51 def initialize(emitter, ss, options); end - # source://psych//lib/psych/visitors/yaml_tree.rb#102 + # source://psych//lib/psych/visitors/yaml_tree.rb#99 def <<(object); end - # source://psych//lib/psych/visitors/yaml_tree.rb#122 + # source://psych//lib/psych/visitors/yaml_tree.rb#119 def accept(target); end - # source://psych//lib/psych/visitors/yaml_tree.rb#91 + # source://psych//lib/psych/visitors/yaml_tree.rb#88 def finish; end # Returns the value of attribute finished. # - # source://psych//lib/psych/visitors/yaml_tree.rb#44 + # source://psych//lib/psych/visitors/yaml_tree.rb#40 def finished; end # Returns the value of attribute finished. # - # source://psych//lib/psych/visitors/yaml_tree.rb#44 + # source://psych//lib/psych/visitors/yaml_tree.rb#40 def finished?; end - # source://psych//lib/psych/visitors/yaml_tree.rb#102 + # source://psych//lib/psych/visitors/yaml_tree.rb#99 def push(object); end - # source://psych//lib/psych/visitors/yaml_tree.rb#85 + # source://psych//lib/psych/visitors/yaml_tree.rb#82 def start(encoding = T.unsafe(nil)); end # Returns the value of attribute started. # - # source://psych//lib/psych/visitors/yaml_tree.rb#44 + # source://psych//lib/psych/visitors/yaml_tree.rb#40 def started; end # Returns the value of attribute started. # - # source://psych//lib/psych/visitors/yaml_tree.rb#44 + # source://psych//lib/psych/visitors/yaml_tree.rb#40 def started?; end - # source://psych//lib/psych/visitors/yaml_tree.rb#97 + # source://psych//lib/psych/visitors/yaml_tree.rb#94 def tree; end - # source://psych//lib/psych/visitors/yaml_tree.rb#350 + # source://psych//lib/psych/visitors/yaml_tree.rb#347 def visit_Array(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#376 + # source://psych//lib/psych/visitors/yaml_tree.rb#373 def visit_BasicObject(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#250 + # source://psych//lib/psych/visitors/yaml_tree.rb#247 def visit_BigDecimal(o); end # @raise [TypeError] # - # source://psych//lib/psych/visitors/yaml_tree.rb#313 + # source://psych//lib/psych/visitors/yaml_tree.rb#310 def visit_Class(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#223 + # source://psych//lib/psych/visitors/yaml_tree.rb#220 def visit_Complex(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#194 + # source://psych//lib/psych/visitors/yaml_tree.rb#191 def visit_Date(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#198 + # source://psych//lib/psych/visitors/yaml_tree.rb#195 def visit_DateTime(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#152 + # source://psych//lib/psych/visitors/yaml_tree.rb#149 def visit_Delegator(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#147 + # source://psych//lib/psych/visitors/yaml_tree.rb#144 def visit_Encoding(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#358 + # source://psych//lib/psych/visitors/yaml_tree.rb#355 def visit_Enumerator(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#182 + # source://psych//lib/psych/visitors/yaml_tree.rb#179 def visit_Exception(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#233 + # source://psych//lib/psych/visitors/yaml_tree.rb#230 def visit_FalseClass(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#239 + # source://psych//lib/psych/visitors/yaml_tree.rb#236 def visit_Float(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#326 + # source://psych//lib/psych/visitors/yaml_tree.rb#323 def visit_Hash(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#233 + # source://psych//lib/psych/visitors/yaml_tree.rb#230 def visit_Integer(o); end # @raise [TypeError] # - # source://psych//lib/psych/visitors/yaml_tree.rb#308 + # source://psych//lib/psych/visitors/yaml_tree.rb#305 def visit_Module(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#186 + # source://psych//lib/psych/visitors/yaml_tree.rb#183 def visit_NameError(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#364 + # source://psych//lib/psych/visitors/yaml_tree.rb#361 def visit_NilClass(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#152 + # source://psych//lib/psych/visitors/yaml_tree.rb#149 def visit_Object(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#139 + # source://psych//lib/psych/visitors/yaml_tree.rb#136 def visit_Psych_Omap(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#339 + # source://psych//lib/psych/visitors/yaml_tree.rb#336 def visit_Psych_Set(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#318 + # source://psych//lib/psych/visitors/yaml_tree.rb#315 def visit_Range(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#210 + # source://psych//lib/psych/visitors/yaml_tree.rb#207 def visit_Rational(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#190 + # source://psych//lib/psych/visitors/yaml_tree.rb#187 def visit_Regexp(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#254 + # source://psych//lib/psych/visitors/yaml_tree.rb#251 def visit_String(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#168 + # source://psych//lib/psych/visitors/yaml_tree.rb#165 def visit_Struct(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#368 + # source://psych//lib/psych/visitors/yaml_tree.rb#365 def visit_Symbol(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#205 + # source://psych//lib/psych/visitors/yaml_tree.rb#202 def visit_Time(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#233 + # source://psych//lib/psych/visitors/yaml_tree.rb#230 def visit_TrueClass(o); end private # @return [Boolean] # - # source://psych//lib/psych/visitors/yaml_tree.rb#390 + # source://psych//lib/psych/visitors/yaml_tree.rb#387 def binary?(string); end - # source://psych//lib/psych/visitors/yaml_tree.rb#497 + # source://psych//lib/psych/visitors/yaml_tree.rb#494 def dump_coder(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#466 + # source://psych//lib/psych/visitors/yaml_tree.rb#463 def dump_exception(o, msg); end - # source://psych//lib/psych/visitors/yaml_tree.rb#532 + # source://psych//lib/psych/visitors/yaml_tree.rb#529 def dump_ivars(target); end - # source://psych//lib/psych/visitors/yaml_tree.rb#463 + # source://psych//lib/psych/visitors/yaml_tree.rb#460 def dump_list(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#510 + # source://psych//lib/psych/visitors/yaml_tree.rb#507 def emit_coder(c, o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#484 + # source://psych//lib/psych/visitors/yaml_tree.rb#481 def format_time(time, utc = T.unsafe(nil)); end - # source://psych//lib/psych/visitors/yaml_tree.rb#492 + # source://psych//lib/psych/visitors/yaml_tree.rb#489 def register(target, yaml_obj); end - # source://psych//lib/psych/visitors/yaml_tree.rb#394 + # source://psych//lib/psych/visitors/yaml_tree.rb#391 def visit_array_subclass(o); end - # source://psych//lib/psych/visitors/yaml_tree.rb#425 + # source://psych//lib/psych/visitors/yaml_tree.rb#422 def visit_hash_subclass(o); end class << self - # source://psych//lib/psych/visitors/yaml_tree.rb#48 + # source://psych//lib/psych/visitors/yaml_tree.rb#44 def create(options = T.unsafe(nil), emitter = T.unsafe(nil)); end end end @@ -2403,17 +2419,17 @@ class Psych::Visitors::YAMLTree::Registrar # source://psych//lib/psych/visitors/yaml_tree.rb#17 def initialize; end - # source://psych//lib/psych/visitors/yaml_tree.rb#35 + # source://psych//lib/psych/visitors/yaml_tree.rb#31 def id_for(target); end # @return [Boolean] # - # source://psych//lib/psych/visitors/yaml_tree.rb#29 + # source://psych//lib/psych/visitors/yaml_tree.rb#27 def key?(target); end - # source://psych//lib/psych/visitors/yaml_tree.rb#39 + # source://psych//lib/psych/visitors/yaml_tree.rb#35 def node_for(target); end - # source://psych//lib/psych/visitors/yaml_tree.rb#24 + # source://psych//lib/psych/visitors/yaml_tree.rb#23 def register(target, node); end end diff --git a/sorbet/rbi/gems/rbs@3.9.2.rbi b/sorbet/rbi/gems/rbs@3.9.3.rbi similarity index 100% rename from sorbet/rbi/gems/rbs@3.9.2.rbi rename to sorbet/rbi/gems/rbs@3.9.3.rbi diff --git a/sorbet/rbi/gems/rdoc@6.6.2.rbi b/sorbet/rbi/gems/rdoc@6.13.1.rbi similarity index 80% rename from sorbet/rbi/gems/rdoc@6.6.2.rbi rename to sorbet/rbi/gems/rdoc@6.13.1.rbi index a00a115..5266a20 100644 --- a/sorbet/rbi/gems/rdoc@6.6.2.rbi +++ b/sorbet/rbi/gems/rdoc@6.13.1.rbi @@ -32,7 +32,7 @@ end # 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 +# 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 @@ -66,10 +66,10 @@ end # work of Keiju ISHITSUKA of Nippon Rational Inc, who produced the Ruby # parser for irb and the rtags package. # -# source://rdoc//lib/rdoc.rb#58 +# source://rdoc//lib/rdoc.rb#56 module RDoc class << self - # Seaches and returns the directory for settings. + # Searches and returns the directory for settings. # # 1. $HOME/.rdoc directory, if it exists. # 2. The +rdoc+ directory under the path specified by the @@ -79,12 +79,12 @@ module RDoc # Other than the home directory, the containing directory will be # created automatically. # - # source://rdoc//lib/rdoc.rb#134 + # source://rdoc//lib/rdoc.rb#132 def home; end # Loads the best available YAML library. # - # source://rdoc//lib/rdoc.rb#107 + # source://rdoc//lib/rdoc.rb#105 def load_yaml; end end end @@ -95,96 +95,86 @@ end # TODO implement Alias as a proxy to a method/attribute, inheriting from # MethodAttr # -# source://rdoc//lib/rdoc/alias.rb#9 +# source://rdoc//lib/rdoc/code_object/alias.rb#9 class RDoc::Alias < ::RDoc::CodeObject # Creates a new Alias with a token stream of +text+ that aliases +old_name+ # to +new_name+, has +comment+ and is a +singleton+ context. # # @return [Alias] a new instance of Alias # - # source://rdoc//lib/rdoc/alias.rb#37 - def initialize(text, old_name, new_name, comment, singleton = T.unsafe(nil)); end + # source://rdoc//lib/rdoc/code_object/alias.rb#37 + def initialize(text, old_name, new_name, comment, singleton: T.unsafe(nil)); end # Order by #singleton then #new_name # - # source://rdoc//lib/rdoc/alias.rb#50 + # source://rdoc//lib/rdoc/code_object/alias.rb#50 def <=>(other); end # HTML fragment reference for this alias # - # source://rdoc//lib/rdoc/alias.rb#57 + # source://rdoc//lib/rdoc/code_object/alias.rb#57 def aref; end - # Full old name including namespace - # - # source://rdoc//lib/rdoc/alias.rb#65 - def full_old_name; end - # HTML id-friendly version of +#new_name+. # - # source://rdoc//lib/rdoc/alias.rb#72 + # source://rdoc//lib/rdoc/code_object/alias.rb#65 def html_name; end - # source://rdoc//lib/rdoc/alias.rb#76 + # source://rdoc//lib/rdoc/code_object/alias.rb#69 def inspect; end # Aliased method's name # - # source://rdoc//lib/rdoc/alias.rb#14 + # source://rdoc//lib/rdoc/code_object/alias.rb#14 def name; end # '::' for the alias of a singleton method/attribute, '#' for instance-level. # - # source://rdoc//lib/rdoc/alias.rb#87 + # source://rdoc//lib/rdoc/code_object/alias.rb#80 def name_prefix; end # Aliased method's name # - # source://rdoc//lib/rdoc/alias.rb#14 + # source://rdoc//lib/rdoc/code_object/alias.rb#14 def new_name; end # Aliasee method's name # - # source://rdoc//lib/rdoc/alias.rb#21 + # source://rdoc//lib/rdoc/code_object/alias.rb#21 def old_name; end # New name with prefix '::' or '#'. # - # source://rdoc//lib/rdoc/alias.rb#101 + # source://rdoc//lib/rdoc/code_object/alias.rb#94 def pretty_name; end # New name with prefix '::' or '#'. # - # source://rdoc//lib/rdoc/alias.rb#101 + # source://rdoc//lib/rdoc/code_object/alias.rb#94 def pretty_new_name; end # Old name with prefix '::' or '#'. # - # source://rdoc//lib/rdoc/alias.rb#94 + # source://rdoc//lib/rdoc/code_object/alias.rb#87 def pretty_old_name; end # Is this an alias declared in a singleton context? # - # source://rdoc//lib/rdoc/alias.rb#26 + # source://rdoc//lib/rdoc/code_object/alias.rb#26 def singleton; end - # Is this an alias declared in a singleton context? - # - # source://rdoc//lib/rdoc/alias.rb#26 - def singleton=(_arg0); end - # Source file token stream # - # source://rdoc//lib/rdoc/alias.rb#31 + # source://rdoc//lib/rdoc/code_object/alias.rb#31 def text; end - # source://rdoc//lib/rdoc/alias.rb#107 + # source://rdoc//lib/rdoc/code_object/alias.rb#100 def to_s; end end # AnyMethod is the base class for objects representing methods # -# source://rdoc//lib/rdoc/any_method.rb#5 +# source://rdoc//lib/rdoc/code_object/any_method.rb#5 class RDoc::AnyMethod < ::RDoc::MethodAttr include ::RDoc::TokenStream @@ -192,39 +182,39 @@ class RDoc::AnyMethod < ::RDoc::MethodAttr # # @return [AnyMethod] a new instance of AnyMethod # - # source://rdoc//lib/rdoc/any_method.rb#46 - def initialize(text, name); end + # source://rdoc//lib/rdoc/code_object/any_method.rb#42 + def initialize(text, name, singleton: T.unsafe(nil)); end # Adds +an_alias+ as an alias for this method in +context+. # - # source://rdoc//lib/rdoc/any_method.rb#59 + # source://rdoc//lib/rdoc/code_object/any_method.rb#55 def add_alias(an_alias, context = T.unsafe(nil)); end # Prefix for +aref+ is 'method'. # - # source://rdoc//lib/rdoc/any_method.rb#76 + # source://rdoc//lib/rdoc/code_object/any_method.rb#71 def aref_prefix; end # The call_seq or the param_seq with method name, if there is no call_seq. # # Use this for displaying a method's argument lists. # - # source://rdoc//lib/rdoc/any_method.rb#85 + # source://rdoc//lib/rdoc/code_object/any_method.rb#80 def arglists; end # The C function that implements this method (if it was defined in a C file) # - # source://rdoc//lib/rdoc/any_method.rb#27 + # source://rdoc//lib/rdoc/code_object/any_method.rb#27 def c_function; end # The C function that implements this method (if it was defined in a C file) # - # source://rdoc//lib/rdoc/any_method.rb#27 + # source://rdoc//lib/rdoc/code_object/any_method.rb#27 def c_function=(_arg0); end # Different ways to call this method # - # source://rdoc//lib/rdoc/any_method.rb#96 + # source://rdoc//lib/rdoc/code_object/any_method.rb#91 def call_seq; end # Sets the different ways you can call this method. If an empty +call_seq+ @@ -232,45 +222,45 @@ class RDoc::AnyMethod < ::RDoc::MethodAttr # # See also #param_seq # - # source://rdoc//lib/rdoc/any_method.rb#112 + # source://rdoc//lib/rdoc/code_object/any_method.rb#107 def call_seq=(call_seq); end # If true this method uses +super+ to call a superclass version # - # source://rdoc//lib/rdoc/any_method.rb#39 + # source://rdoc//lib/rdoc/code_object/any_method.rb#35 def calls_super; end # If true this method uses +super+ to call a superclass version # - # source://rdoc//lib/rdoc/any_method.rb#39 + # source://rdoc//lib/rdoc/code_object/any_method.rb#35 def calls_super=(_arg0); end # Don't rename \#initialize to \::new # - # source://rdoc//lib/rdoc/any_method.rb#22 + # source://rdoc//lib/rdoc/code_object/any_method.rb#22 def dont_rename_initialize; end # Don't rename \#initialize to \::new # - # source://rdoc//lib/rdoc/any_method.rb#22 + # source://rdoc//lib/rdoc/code_object/any_method.rb#22 def dont_rename_initialize=(_arg0); end # Whether the method has a call-seq. # # @return [Boolean] # - # source://rdoc//lib/rdoc/any_method.rb#121 + # source://rdoc//lib/rdoc/code_object/any_method.rb#116 def has_call_seq?; end # Loads is_alias_for from the internal name. Returns nil if the alias # cannot be found. # - # source://rdoc//lib/rdoc/any_method.rb#129 + # source://rdoc//lib/rdoc/code_object/any_method.rb#124 def is_alias_for; end # Dumps this AnyMethod for use by ri. See also #marshal_load # - # source://rdoc//lib/rdoc/any_method.rb#147 + # source://rdoc//lib/rdoc/code_object/any_method.rb#142 def marshal_dump; end # Loads this AnyMethod from +array+. For a loaded AnyMethod the following @@ -279,46 +269,36 @@ class RDoc::AnyMethod < ::RDoc::MethodAttr # * #full_name # * #parent_name # - # source://rdoc//lib/rdoc/any_method.rb#184 + # source://rdoc//lib/rdoc/code_object/any_method.rb#179 def marshal_load(array); end # Method name # # If the method has no assigned name, it extracts it from #call_seq. # - # source://rdoc//lib/rdoc/any_method.rb#233 + # source://rdoc//lib/rdoc/code_object/any_method.rb#228 def name; end # A list of this method's method and yield parameters. +call-seq+ params # are preferred over parsed method and block params. # - # source://rdoc//lib/rdoc/any_method.rb#246 + # source://rdoc//lib/rdoc/code_object/any_method.rb#241 def param_list; end # Pretty parameter list for this method. If the method's parameters were # given by +call-seq+ it is preferred over the parsed values. # - # source://rdoc//lib/rdoc/any_method.rb#278 + # source://rdoc//lib/rdoc/code_object/any_method.rb#273 def param_seq; end - # Parameters for this method - # - # source://rdoc//lib/rdoc/any_method.rb#34 - def params; end - - # Parameters for this method - # - # source://rdoc//lib/rdoc/any_method.rb#34 - def params=(_arg0); end - # The section title of the method (if defined in a C file via +:category:+) # - # source://rdoc//lib/rdoc/any_method.rb#30 + # source://rdoc//lib/rdoc/code_object/any_method.rb#30 def section_title; end # The section title of the method (if defined in a C file via +:category:+) # - # source://rdoc//lib/rdoc/any_method.rb#30 + # source://rdoc//lib/rdoc/code_object/any_method.rb#30 def section_title=(_arg0); end # Whether to skip the method description, true for methods that have @@ -326,24 +306,24 @@ class RDoc::AnyMethod < ::RDoc::MethodAttr # # @return [Boolean] # - # source://rdoc//lib/rdoc/any_method.rb#310 + # source://rdoc//lib/rdoc/code_object/any_method.rb#305 def skip_description?; end # Sets the store for this method and its referenced code objects. # - # source://rdoc//lib/rdoc/any_method.rb#317 + # source://rdoc//lib/rdoc/code_object/any_method.rb#312 def store=(store); end # For methods that +super+, find the superclass method that would be called. # - # source://rdoc//lib/rdoc/any_method.rb#326 + # source://rdoc//lib/rdoc/code_object/any_method.rb#321 def superclass_method; end protected # call_seq without deduplication and alias lookup. # - # source://rdoc//lib/rdoc/any_method.rb#345 + # source://rdoc//lib/rdoc/code_object/any_method.rb#340 def _call_seq; end private @@ -351,36 +331,36 @@ class RDoc::AnyMethod < ::RDoc::MethodAttr # call_seq with alias examples information removed, if this # method is an alias method. # - # source://rdoc//lib/rdoc/any_method.rb#355 + # source://rdoc//lib/rdoc/code_object/any_method.rb#350 def deduplicate_call_seq(call_seq); end end # An attribute created by \#attr, \#attr_reader, \#attr_writer or # \#attr_accessor # -# source://rdoc//lib/rdoc/attr.rb#6 +# source://rdoc//lib/rdoc/code_object/attr.rb#6 class RDoc::Attr < ::RDoc::MethodAttr # Creates a new Attr with body +text+, +name+, read/write status +rw+ and # +comment+. +singleton+ marks this as a class attribute. # # @return [Attr] a new instance of Attr # - # source://rdoc//lib/rdoc/attr.rb#25 - def initialize(text, name, rw, comment, singleton = T.unsafe(nil)); end + # source://rdoc//lib/rdoc/code_object/attr.rb#25 + def initialize(text, name, rw, comment, singleton: T.unsafe(nil)); end # Attributes are equal when their names, singleton and rw are identical # - # source://rdoc//lib/rdoc/attr.rb#36 + # source://rdoc//lib/rdoc/code_object/attr.rb#35 def ==(other); end # Add +an_alias+ as an attribute in +context+. # - # source://rdoc//lib/rdoc/attr.rb#46 + # source://rdoc//lib/rdoc/code_object/attr.rb#45 def add_alias(an_alias, context); end # The #aref prefix for attributes # - # source://rdoc//lib/rdoc/attr.rb#61 + # source://rdoc//lib/rdoc/code_object/attr.rb#58 def aref_prefix; end # Attributes never call super. See RDoc::AnyMethod#calls_super @@ -388,20 +368,20 @@ class RDoc::Attr < ::RDoc::MethodAttr # An RDoc::Attr can show up in the method list in some situations (see # Gem::ConfigFile) # - # source://rdoc//lib/rdoc/attr.rb#71 + # source://rdoc//lib/rdoc/code_object/attr.rb#68 def calls_super; end # Returns attr_reader, attr_writer or attr_accessor as appropriate. # - # source://rdoc//lib/rdoc/attr.rb#78 + # source://rdoc//lib/rdoc/code_object/attr.rb#75 def definition; end - # source://rdoc//lib/rdoc/attr.rb#86 + # source://rdoc//lib/rdoc/code_object/attr.rb#83 def inspect; end # Dumps this Attr for use by ri. See also #marshal_load # - # source://rdoc//lib/rdoc/attr.rb#102 + # source://rdoc//lib/rdoc/code_object/attr.rb#99 def marshal_dump; end # Loads this Attr from +array+. For a loaded Attr the following @@ -410,23 +390,23 @@ class RDoc::Attr < ::RDoc::MethodAttr # * #full_name # * #parent_name # - # source://rdoc//lib/rdoc/attr.rb#124 + # source://rdoc//lib/rdoc/code_object/attr.rb#121 def marshal_load(array); end - # source://rdoc//lib/rdoc/attr.rb#151 + # source://rdoc//lib/rdoc/code_object/attr.rb#148 def pretty_print(q); end # Is the attribute readable ('R'), writable ('W') or both ('RW')? # - # source://rdoc//lib/rdoc/attr.rb#19 + # source://rdoc//lib/rdoc/code_object/attr.rb#19 def rw; end # Is the attribute readable ('R'), writable ('W') or both ('RW')? # - # source://rdoc//lib/rdoc/attr.rb#19 + # source://rdoc//lib/rdoc/code_object/attr.rb#19 def rw=(_arg0); end - # source://rdoc//lib/rdoc/attr.rb#162 + # source://rdoc//lib/rdoc/code_object/attr.rb#159 def to_s; end # Attributes do not have token streams. @@ -434,14 +414,14 @@ class RDoc::Attr < ::RDoc::MethodAttr # An RDoc::Attr can show up in the method list in some situations (see # Gem::ConfigFile) # - # source://rdoc//lib/rdoc/attr.rb#172 + # source://rdoc//lib/rdoc/code_object/attr.rb#169 def token_stream; end end # ClassModule is the base class for objects representing either a class or a # module. # -# source://rdoc//lib/rdoc/class_module.rb#6 +# source://rdoc//lib/rdoc/code_object/class_module.rb#6 class RDoc::ClassModule < ::RDoc::Context # Creates a new ClassModule with +name+ with optional +superclass+ # @@ -449,17 +429,17 @@ class RDoc::ClassModule < ::RDoc::Context # # @return [ClassModule] a new instance of ClassModule # - # source://rdoc//lib/rdoc/class_module.rb#111 + # source://rdoc//lib/rdoc/code_object/class_module.rb#108 def initialize(name, superclass = T.unsafe(nil)); end # Adds +comment+ to this ClassModule's list of comments at +location+. This # method is preferred over #comment= since it allows ri data to be updated # across multiple runs. # - # source://rdoc//lib/rdoc/class_module.rb#127 + # source://rdoc//lib/rdoc/code_object/class_module.rb#123 def add_comment(comment, location); end - # source://rdoc//lib/rdoc/class_module.rb#148 + # source://rdoc//lib/rdoc/code_object/class_module.rb#144 def add_things(my_things, other_things); end # Ancestors list for this ClassModule: the list of included modules @@ -473,23 +453,23 @@ class RDoc::ClassModule < ::RDoc::Context # which is the order suitable for searching methods/attributes # in the ancestors. The superclass, if any, comes last. # - # source://rdoc//lib/rdoc/class_module.rb#171 + # source://rdoc//lib/rdoc/code_object/class_module.rb#167 def ancestors; end # HTML fragment reference for this module or class. See # RDoc::NormalClass#aref and RDoc::NormalModule#aref # - # source://rdoc//lib/rdoc/class_module.rb#183 + # source://rdoc//lib/rdoc/code_object/class_module.rb#179 def aref; end # @raise [NotImplementedError] # - # source://rdoc//lib/rdoc/class_module.rb#175 + # source://rdoc//lib/rdoc/code_object/class_module.rb#171 def aref_prefix; end # Clears the comment. Used by the Ruby parser. # - # source://rdoc//lib/rdoc/class_module.rb#195 + # source://rdoc//lib/rdoc/code_object/class_module.rb#191 def clear_comment; end # This method is deprecated, use #add_comment instead. @@ -497,34 +477,34 @@ class RDoc::ClassModule < ::RDoc::Context # Appends +comment+ to the current comment, but separated by a rule. Works # more like +=. # - # source://rdoc//lib/rdoc/class_module.rb#205 + # source://rdoc//lib/rdoc/code_object/class_module.rb#201 def comment=(comment); end # Comment and the location it came from. Use #add_comment to add comments # - # source://rdoc//lib/rdoc/class_module.rb#35 + # source://rdoc//lib/rdoc/code_object/class_module.rb#35 def comment_location; end # Comment and the location it came from. Use #add_comment to add comments # - # source://rdoc//lib/rdoc/class_module.rb#35 + # source://rdoc//lib/rdoc/code_object/class_module.rb#35 def comment_location=(_arg0); end # Prepares this ClassModule for use by a generator. # # See RDoc::Store#complete # - # source://rdoc//lib/rdoc/class_module.rb#223 + # source://rdoc//lib/rdoc/code_object/class_module.rb#219 def complete(min_visibility); end # Constants that are aliases for this class or module # - # source://rdoc//lib/rdoc/class_module.rb#30 + # source://rdoc//lib/rdoc/code_object/class_module.rb#30 def constant_aliases; end # Constants that are aliases for this class or module # - # source://rdoc//lib/rdoc/class_module.rb#30 + # source://rdoc//lib/rdoc/code_object/class_module.rb#30 def constant_aliases=(_arg0); end # Handy wrapper for marking up this class or module's comment @@ -532,12 +512,6 @@ class RDoc::ClassModule < ::RDoc::Context # source://rdoc//lib/rdoc/generator/markup.rb#131 def description; end - # source://rdoc//lib/rdoc/class_module.rb#37 - def diagram; end - - # source://rdoc//lib/rdoc/class_module.rb#37 - def diagram=(_arg0); end - # Ancestors list for this ClassModule: the list of included modules # (classes will add their superclass if any). # @@ -551,12 +525,12 @@ class RDoc::ClassModule < ::RDoc::Context # # Ancestors of this class or module only # - # source://rdoc//lib/rdoc/class_module.rb#171 + # source://rdoc//lib/rdoc/code_object/class_module.rb#167 def direct_ancestors; end # Does this ClassModule or any of its methods have document_self set? # - # source://rdoc//lib/rdoc/class_module.rb#233 + # source://rdoc//lib/rdoc/code_object/class_module.rb#231 def document_self_or_methods; end # Does this class or module have a comment with content or is @@ -564,53 +538,63 @@ class RDoc::ClassModule < ::RDoc::Context # # @return [Boolean] # - # source://rdoc//lib/rdoc/class_module.rb#241 + # source://rdoc//lib/rdoc/code_object/class_module.rb#239 def documented?; end # Iterates the ancestors of this class or module for which an # RDoc::ClassModule exists. # - # source://rdoc//lib/rdoc/class_module.rb#251 + # source://rdoc//lib/rdoc/code_object/class_module.rb#249 def each_ancestor; end + # source://rdoc//lib/rdoc/code_object/class_module.rb#849 + def embed_mixins; end + # Looks for a symbol in the #ancestors. See Context#find_local_symbol. # - # source://rdoc//lib/rdoc/class_module.rb#264 + # source://rdoc//lib/rdoc/code_object/class_module.rb#262 def find_ancestor_local_symbol(symbol); end # Finds a class or module with +name+ in this namespace or its descendants # - # source://rdoc//lib/rdoc/class_module.rb#276 + # source://rdoc//lib/rdoc/code_object/class_module.rb#274 def find_class_named(name); end # Return the fully qualified name of this class or module # - # source://rdoc//lib/rdoc/class_module.rb#289 + # source://rdoc//lib/rdoc/code_object/class_module.rb#287 def full_name; end + # Return array of fully qualified nesting namespaces. + # + # For example, if full_name is +A::B::C+, this method returns ["A", "A::B", "A::B::C"] + # + # source://rdoc//lib/rdoc/code_object/class_module.rb#307 + def fully_qualified_nesting_namespaces; end + # Class or module this constant is an alias for # - # source://rdoc//lib/rdoc/class_module.rb#42 + # source://rdoc//lib/rdoc/code_object/class_module.rb#40 def is_alias_for; end # Class or module this constant is an alias for # - # source://rdoc//lib/rdoc/class_module.rb#42 + # source://rdoc//lib/rdoc/code_object/class_module.rb#40 def is_alias_for=(_arg0); end # TODO: filter included items by #display? # - # source://rdoc//lib/rdoc/class_module.rb#300 + # source://rdoc//lib/rdoc/code_object/class_module.rb#317 def marshal_dump; end - # source://rdoc//lib/rdoc/class_module.rb#346 + # source://rdoc//lib/rdoc/code_object/class_module.rb#363 def marshal_load(array); end # Merges +class_module+ into this ClassModule. # # The data in +class_module+ is preferred over the receiver. # - # source://rdoc//lib/rdoc/class_module.rb#435 + # source://rdoc//lib/rdoc/code_object/class_module.rb#453 def merge(class_module); end # Merges collection +mine+ with +other+ preferring other. +other_files+ is @@ -627,52 +611,57 @@ class RDoc::ClassModule < ::RDoc::Context # end # end # - # source://rdoc//lib/rdoc/class_module.rb#519 + # source://rdoc//lib/rdoc/code_object/class_module.rb#538 def merge_collections(mine, other, other_files, &block); end # Merges the comments in this ClassModule with the comments in the other # ClassModule +cm+. # - # source://rdoc//lib/rdoc/class_module.rb#531 + # source://rdoc//lib/rdoc/code_object/class_module.rb#550 def merge_sections(cm); end # Does this object represent a module? # # @return [Boolean] # - # source://rdoc//lib/rdoc/class_module.rb#570 + # source://rdoc//lib/rdoc/code_object/class_module.rb#589 def module?; end # Allows overriding the initial name. # # Used for modules and classes that are constant aliases. # - # source://rdoc//lib/rdoc/class_module.rb#579 + # source://rdoc//lib/rdoc/code_object/class_module.rb#598 def name=(new_name); end # Name to use to generate the url: # modules and classes that are aliases for another # module or class return the name of the latter. # - # source://rdoc//lib/rdoc/class_module.rb#622 + # source://rdoc//lib/rdoc/code_object/class_module.rb#643 def name_for_path; end + # Return array of full_name splitted by +::+. + # + # source://rdoc//lib/rdoc/code_object/class_module.rb#298 + def nesting_namespaces; end + # Returns the classes and modules that are not constants # aliasing another class or module. For use by formatters # only (caches its result). # - # source://rdoc//lib/rdoc/class_module.rb#631 + # source://rdoc//lib/rdoc/code_object/class_module.rb#652 def non_aliases; end # Parses +comment_location+ into an RDoc::Markup::Document composed of # multiple RDoc::Markup::Documents with their file set. # - # source://rdoc//lib/rdoc/class_module.rb#587 + # source://rdoc//lib/rdoc/code_object/class_module.rb#606 def parse(comment_location); end # Path to this class or module for use with HTML generator output. # - # source://rdoc//lib/rdoc/class_module.rb#613 + # source://rdoc//lib/rdoc/code_object/class_module.rb#632 def path; end # Updates the child modules or classes of class/module +parent+ by @@ -682,41 +671,53 @@ class RDoc::ClassModule < ::RDoc::Context # parent.classes_hash and +all_hash+ is ::all_modules_hash or # ::all_classes_hash. # - # source://rdoc//lib/rdoc/class_module.rb#643 + # source://rdoc//lib/rdoc/code_object/class_module.rb#664 def remove_nodoc_children; end - # source://rdoc//lib/rdoc/class_module.rb#657 + # source://rdoc//lib/rdoc/code_object/class_module.rb#678 def remove_things(my_things, other_files); end # Search record used by RDoc::Generator::JsonIndex # - # source://rdoc//lib/rdoc/class_module.rb#672 + # source://rdoc//lib/rdoc/code_object/class_module.rb#693 def search_record; end # Sets the store for this class or module and its contained code objects. # - # source://rdoc//lib/rdoc/class_module.rb#687 + # source://rdoc//lib/rdoc/code_object/class_module.rb#708 def store=(store); end + # Get all super classes of this class in an array. The last element might be + # a string if the name is unknown. + # + # source://rdoc//lib/rdoc/code_object/class_module.rb#751 + def super_classes; end + # Get the superclass of this class. Attempts to retrieve the superclass # object, returns the name if it is not known. # - # source://rdoc//lib/rdoc/class_module.rb#701 + # source://rdoc//lib/rdoc/code_object/class_module.rb#722 def superclass; end # Set the superclass of this class to +superclass+ # + # where +superclass+ is one of: + # + # - +nil+ + # - a String containing the full name of the superclass + # - the RDoc::ClassModule representing the superclass + # # @raise [NoMethodError] # - # source://rdoc//lib/rdoc/class_module.rb#708 + # source://rdoc//lib/rdoc/code_object/class_module.rb#735 def superclass=(superclass); end - # source://rdoc//lib/rdoc/class_module.rb#713 + # source://rdoc//lib/rdoc/code_object/class_module.rb#761 def to_s; end # 'module' or 'class' # - # source://rdoc//lib/rdoc/class_module.rb#724 + # source://rdoc//lib/rdoc/code_object/class_module.rb#772 def type; end # Updates the child modules & classes by replacing the ones that are @@ -733,7 +734,7 @@ class RDoc::ClassModule < ::RDoc::Context # the aliased modules are included in the constants of the class/module, # that are listed separately. # - # source://rdoc//lib/rdoc/class_module.rb#743 + # source://rdoc//lib/rdoc/code_object/class_module.rb#791 def update_aliases; end # Deletes from #extends those whose module has been removed from the @@ -741,7 +742,7 @@ class RDoc::ClassModule < ::RDoc::Context # -- # FIXME: like update_includes, extends are not reliably removed # - # source://rdoc//lib/rdoc/class_module.rb#791 + # source://rdoc//lib/rdoc/code_object/class_module.rb#839 def update_extends; end # Deletes from #includes those whose module has been removed from the @@ -749,16 +750,21 @@ class RDoc::ClassModule < ::RDoc::Context # -- # FIXME: includes are not reliably removed, see _possible_bug test case # - # source://rdoc//lib/rdoc/class_module.rb#776 + # source://rdoc//lib/rdoc/code_object/class_module.rb#824 def update_includes; end + private + + # source://rdoc//lib/rdoc/code_object/class_module.rb#878 + def prepare_to_embed(code_object, singleton = T.unsafe(nil)); end + class << self # Return a RDoc::ClassModule of class +class_type+ that is a copy # of module +module+. Used to promote modules to classes. # -- # TODO move to RDoc::NormalClass (I think) # - # source://rdoc//lib/rdoc/class_module.rb#50 + # source://rdoc//lib/rdoc/code_object/class_module.rb#48 def from_module(class_type, mod); end end end @@ -784,11 +790,12 @@ end # * RDoc::MetaMethod # * RDoc::Alias # * RDoc::Constant +# * RDoc::Require # * RDoc::Mixin -# * RDoc::Require # * RDoc::Include +# * RDoc::Extend # -# source://rdoc//lib/rdoc/code_object.rb#28 +# source://rdoc//lib/rdoc/code_object.rb#29 class RDoc::CodeObject include ::RDoc::Text include ::RDoc::Generator::Markup @@ -797,12 +804,12 @@ class RDoc::CodeObject # # @return [CodeObject] a new instance of CodeObject # - # source://rdoc//lib/rdoc/code_object.rb#102 + # source://rdoc//lib/rdoc/code_object.rb#101 def initialize; end # Our comment # - # source://rdoc//lib/rdoc/code_object.rb#35 + # source://rdoc//lib/rdoc/code_object.rb#36 def comment; end # Replaces our comment with +comment+, unless it is empty. @@ -820,41 +827,41 @@ class RDoc::CodeObject # # @return [Boolean] # - # source://rdoc//lib/rdoc/code_object.rb#163 + # source://rdoc//lib/rdoc/code_object.rb#162 def display?; end # Do we document our children? # - # source://rdoc//lib/rdoc/code_object.rb#40 + # source://rdoc//lib/rdoc/code_object.rb#41 def document_children; end # Enables or disables documentation of this CodeObject's children unless it # has been turned off by :enddoc: # - # source://rdoc//lib/rdoc/code_object.rb#172 + # source://rdoc//lib/rdoc/code_object.rb#171 def document_children=(document_children); end # Do we document ourselves? # - # source://rdoc//lib/rdoc/code_object.rb#45 + # source://rdoc//lib/rdoc/code_object.rb#46 def document_self; end # Enables or disables documentation of this CodeObject unless it has been # turned off by :enddoc:. If the argument is +nil+ it means the # - # source://rdoc//lib/rdoc/code_object.rb#183 + # source://rdoc//lib/rdoc/code_object.rb#182 def document_self=(document_self); end # Does this object have a comment with content or is #received_nodoc true? # # @return [Boolean] # - # source://rdoc//lib/rdoc/code_object.rb#194 + # source://rdoc//lib/rdoc/code_object.rb#193 def documented?; end # Are we done documenting (ie, did we come across a :enddoc:)? # - # source://rdoc//lib/rdoc/code_object.rb#50 + # source://rdoc//lib/rdoc/code_object.rb#51 def done_documenting; end # Turns documentation on/off, and turns on/off #document_self @@ -864,30 +871,24 @@ class RDoc::CodeObject # the object will refuse to turn #document_self or # will have no effect in the current file. # - # source://rdoc//lib/rdoc/code_object.rb#207 + # source://rdoc//lib/rdoc/code_object.rb#206 def done_documenting=(value); end - # Yields each parent of this CodeObject. See also - # RDoc::ClassModule#each_ancestor - # - # source://rdoc//lib/rdoc/code_object.rb#218 - def each_parent; end - # Which file this code object was defined in # - # source://rdoc//lib/rdoc/code_object.rb#55 + # source://rdoc//lib/rdoc/code_object.rb#56 def file; end # File name where this CodeObject was found. # # See also RDoc::Context#in_files # - # source://rdoc//lib/rdoc/code_object.rb#233 + # source://rdoc//lib/rdoc/code_object.rb#218 def file_name; end # Force documentation of this CodeObject # - # source://rdoc//lib/rdoc/code_object.rb#60 + # source://rdoc//lib/rdoc/code_object.rb#61 def force_documentation; end # Force the documentation of this object unless documentation @@ -895,14 +896,14 @@ class RDoc::CodeObject # -- # HACK untested, was assigning to an ivar # - # source://rdoc//lib/rdoc/code_object.rb#245 + # source://rdoc//lib/rdoc/code_object.rb#230 def force_documentation=(value); end # Sets the full_name overriding any computed full name. # # Set to +nil+ to clear RDoc's cached value # - # source://rdoc//lib/rdoc/code_object.rb#254 + # source://rdoc//lib/rdoc/code_object.rb#239 def full_name=(full_name); end # Use this to ignore a CodeObject and all its children until found again @@ -920,7 +921,7 @@ class RDoc::CodeObject # reopened it should not be displayed. The ignore flag allows this to # occur. # - # source://rdoc//lib/rdoc/code_object.rb#274 + # source://rdoc//lib/rdoc/code_object.rb#259 def ignore; end # Has this class been ignored? @@ -929,7 +930,7 @@ class RDoc::CodeObject # # @return [Boolean] # - # source://rdoc//lib/rdoc/code_object.rb#287 + # source://rdoc//lib/rdoc/code_object.rb#272 def ignored?; end # Initializes state for visibility of this CodeObject and its children. @@ -939,86 +940,91 @@ class RDoc::CodeObject # Line in #file where this CodeObject was defined # - # source://rdoc//lib/rdoc/code_object.rb#65 + # source://rdoc//lib/rdoc/code_object.rb#66 def line; end # Line in #file where this CodeObject was defined # - # source://rdoc//lib/rdoc/code_object.rb#65 + # source://rdoc//lib/rdoc/code_object.rb#66 def line=(_arg0); end # Hash of arbitrary metadata for this CodeObject # - # source://rdoc//lib/rdoc/code_object.rb#70 + # source://rdoc//lib/rdoc/code_object.rb#71 def metadata; end + # When mixed-in to a class, this points to the Context in which it was originally defined. + # + # source://rdoc//lib/rdoc/code_object.rb#96 + def mixin_from; end + + # When mixed-in to a class, this points to the Context in which it was originally defined. + # + # source://rdoc//lib/rdoc/code_object.rb#96 + def mixin_from=(_arg0); end + # The options instance from the store this CodeObject is attached to, or a # default options instance if the CodeObject is not attached. # # This is used by Text#snippet # - # source://rdoc//lib/rdoc/code_object.rb#297 + # source://rdoc//lib/rdoc/code_object.rb#282 def options; end # Our parent CodeObject. The parent may be missing for classes loaded from # legacy RI data stores. # - # source://rdoc//lib/rdoc/code_object.rb#309 + # source://rdoc//lib/rdoc/code_object.rb#290 def parent; end # Sets the parent CodeObject # - # source://rdoc//lib/rdoc/code_object.rb#75 + # source://rdoc//lib/rdoc/code_object.rb#76 def parent=(_arg0); end - # File name of our parent - # - # source://rdoc//lib/rdoc/code_object.rb#331 - def parent_file_name; end - # Name of our parent # - # source://rdoc//lib/rdoc/code_object.rb#338 + # source://rdoc//lib/rdoc/code_object.rb#312 def parent_name; end - # source://rdoc//lib/rdoc/code_object.rb#80 + # source://rdoc//lib/rdoc/code_object.rb#81 def received_nodoc; end # Records the RDoc::TopLevel (file) where this code object was defined # - # source://rdoc//lib/rdoc/code_object.rb#345 + # source://rdoc//lib/rdoc/code_object.rb#319 def record_location(top_level); end # The section this CodeObject is in. Sections allow grouping of constants, # attributes and methods inside a class or module. # - # source://rdoc//lib/rdoc/code_object.rb#355 + # source://rdoc//lib/rdoc/code_object.rb#329 def section; end # Set the section this CodeObject is in # - # source://rdoc//lib/rdoc/code_object.rb#85 + # source://rdoc//lib/rdoc/code_object.rb#86 def section=(_arg0); end # Enable capture of documentation unless documentation has been # turned off by :enddoc: # - # source://rdoc//lib/rdoc/code_object.rb#365 + # source://rdoc//lib/rdoc/code_object.rb#339 def start_doc; end # Disable capture of documentation # - # source://rdoc//lib/rdoc/code_object.rb#377 + # source://rdoc//lib/rdoc/code_object.rb#351 def stop_doc; end # The RDoc::Store for this object. # - # source://rdoc//lib/rdoc/code_object.rb#90 + # source://rdoc//lib/rdoc/code_object.rb#91 def store; end # Sets the +store+ that contains this CodeObject # - # source://rdoc//lib/rdoc/code_object.rb#387 + # source://rdoc//lib/rdoc/code_object.rb#361 def store=(store); end # Use this to suppress a CodeObject and all its children until the next file @@ -1026,7 +1032,7 @@ class RDoc::CodeObject # documentation will be displayed while an ignored item with documentation # may not be displayed. # - # source://rdoc//lib/rdoc/code_object.rb#404 + # source://rdoc//lib/rdoc/code_object.rb#378 def suppress; end # Has this class been suppressed? @@ -1035,22 +1041,8 @@ class RDoc::CodeObject # # @return [Boolean] # - # source://rdoc//lib/rdoc/code_object.rb#417 + # source://rdoc//lib/rdoc/code_object.rb#391 def suppressed?; end - - # We are the model of the code, but we know that at some point we will be - # worked on by viewers. By implementing the Viewable protocol, viewers can - # associated themselves with these objects. - # - # source://rdoc//lib/rdoc/code_object.rb#97 - def viewer; end - - # We are the model of the code, but we know that at some point we will be - # worked on by viewers. By implementing the Viewable protocol, viewers can - # associated themselves with these objects. - # - # source://rdoc//lib/rdoc/code_object.rb#97 - def viewer=(_arg0); end end # source://rdoc//lib/rdoc/comment.rb#12 @@ -1078,12 +1070,12 @@ class RDoc::Comment # # @return [Boolean] # - # source://rdoc//lib/rdoc/comment.rb#128 + # source://rdoc//lib/rdoc/comment.rb#125 def empty?; end # HACK dubious # - # source://rdoc//lib/rdoc/comment.rb#135 + # source://rdoc//lib/rdoc/comment.rb#132 def encode!(encoding); end # Look for a 'call-seq' in the comment to override the normal parameter @@ -1102,7 +1094,7 @@ class RDoc::Comment # # ARGF.to_a(sep, limit) -> array # # source://rdoc//lib/rdoc/comment.rb#95 - def extract_call_seq(method); end + def extract_call_seq; end # The RDoc::TopLevel this comment was found in # @@ -1118,10 +1110,10 @@ class RDoc::Comment # Sets the format of this comment and resets any parsed document # - # source://rdoc//lib/rdoc/comment.rb#143 + # source://rdoc//lib/rdoc/comment.rb#140 def format=(format); end - # source://rdoc//lib/rdoc/comment.rb#148 + # source://rdoc//lib/rdoc/comment.rb#145 def inspect; end # Line where this Comment was written @@ -1146,20 +1138,20 @@ class RDoc::Comment # Normalizes the text. See RDoc::Text#normalize_comment for details # - # source://rdoc//lib/rdoc/comment.rb#157 + # source://rdoc//lib/rdoc/comment.rb#154 def normalize; end # Was this text normalized? # # @return [Boolean] # - # source://rdoc//lib/rdoc/comment.rb#171 + # source://rdoc//lib/rdoc/comment.rb#168 def normalized?; end # Parses the comment into an RDoc::Markup::Document. The parsed document is # cached until the text is changed. # - # source://rdoc//lib/rdoc/comment.rb#179 + # source://rdoc//lib/rdoc/comment.rb#176 def parse; end # Removes private sections from this comment. Private sections are flush to @@ -1174,7 +1166,7 @@ class RDoc::Comment # * public # */ # - # source://rdoc//lib/rdoc/comment.rb#200 + # source://rdoc//lib/rdoc/comment.rb#197 def remove_private; end # The text for this comment @@ -1188,7 +1180,7 @@ class RDoc::Comment # # @raise [RDoc::Error] # - # source://rdoc//lib/rdoc/comment.rb#214 + # source://rdoc//lib/rdoc/comment.rb#211 def text=(text); end # The text for this comment @@ -1202,7 +1194,7 @@ class RDoc::Comment # # @return [Boolean] # - # source://rdoc//lib/rdoc/comment.rb#225 + # source://rdoc//lib/rdoc/comment.rb#222 def tomdoc?; end private @@ -1212,27 +1204,34 @@ class RDoc::Comment # # source://rdoc//lib/rdoc/comment.rb#70 def initialize_copy(copy); end + + class << self + # Create a new parsed comment from a document + # + # source://rdoc//lib/rdoc/comment.rb#229 + def from_document(document); end + end end # A constant # -# source://rdoc//lib/rdoc/constant.rb#5 +# source://rdoc//lib/rdoc/code_object/constant.rb#5 class RDoc::Constant < ::RDoc::CodeObject # Creates a new constant with +name+, +value+ and +comment+ # # @return [Constant] a new instance of Constant # - # source://rdoc//lib/rdoc/constant.rb#32 + # source://rdoc//lib/rdoc/code_object/constant.rb#32 def initialize(name, value, comment); end # Constants are ordered by name # - # source://rdoc//lib/rdoc/constant.rb#47 + # source://rdoc//lib/rdoc/code_object/constant.rb#47 def <=>(other); end # Constants are equal when their #parent and #name is the same # - # source://rdoc//lib/rdoc/constant.rb#56 + # source://rdoc//lib/rdoc/code_object/constant.rb#56 def ==(other); end # A constant is documented if it has a comment, or is an alias @@ -1240,30 +1239,30 @@ class RDoc::Constant < ::RDoc::CodeObject # # @return [Boolean] # - # source://rdoc//lib/rdoc/constant.rb#66 + # source://rdoc//lib/rdoc/code_object/constant.rb#66 def documented?; end # Full constant name including namespace # - # source://rdoc//lib/rdoc/constant.rb#81 + # source://rdoc//lib/rdoc/code_object/constant.rb#81 def full_name; end - # source://rdoc//lib/rdoc/constant.rb#99 + # source://rdoc//lib/rdoc/code_object/constant.rb#99 def inspect; end # The module or class this constant is an alias for # - # source://rdoc//lib/rdoc/constant.rb#88 + # source://rdoc//lib/rdoc/code_object/constant.rb#88 def is_alias_for; end # Sets the module or class this is constant is an alias for. # - # source://rdoc//lib/rdoc/constant.rb#12 + # source://rdoc//lib/rdoc/code_object/constant.rb#12 def is_alias_for=(_arg0); end # Dumps this Constant for use by ri. See also #marshal_load # - # source://rdoc//lib/rdoc/constant.rb#109 + # source://rdoc//lib/rdoc/code_object/constant.rb#109 def marshal_dump; end # Loads this Constant from +array+. For a loaded Constant the following @@ -1272,53 +1271,53 @@ class RDoc::Constant < ::RDoc::CodeObject # * #full_name # * #parent_name # - # source://rdoc//lib/rdoc/constant.rb#135 + # source://rdoc//lib/rdoc/code_object/constant.rb#135 def marshal_load(array); end # The constant's name # - # source://rdoc//lib/rdoc/constant.rb#17 + # source://rdoc//lib/rdoc/code_object/constant.rb#17 def name; end # The constant's name # - # source://rdoc//lib/rdoc/constant.rb#17 + # source://rdoc//lib/rdoc/code_object/constant.rb#17 def name=(_arg0); end # Path to this constant for use with HTML generator output. # - # source://rdoc//lib/rdoc/constant.rb#153 + # source://rdoc//lib/rdoc/code_object/constant.rb#153 def path; end - # source://rdoc//lib/rdoc/constant.rb#157 + # source://rdoc//lib/rdoc/code_object/constant.rb#157 def pretty_print(q); end # Sets the store for this class or module and its contained code objects. # - # source://rdoc//lib/rdoc/constant.rb#171 + # source://rdoc//lib/rdoc/code_object/constant.rb#171 def store=(store); end - # source://rdoc//lib/rdoc/constant.rb#177 + # source://rdoc//lib/rdoc/code_object/constant.rb#177 def to_s; end # The constant's value # - # source://rdoc//lib/rdoc/constant.rb#22 + # source://rdoc//lib/rdoc/code_object/constant.rb#22 def value; end # The constant's value # - # source://rdoc//lib/rdoc/constant.rb#22 + # source://rdoc//lib/rdoc/code_object/constant.rb#22 def value=(_arg0); end # The constant's visibility # - # source://rdoc//lib/rdoc/constant.rb#27 + # source://rdoc//lib/rdoc/code_object/constant.rb#27 def visibility; end # The constant's visibility # - # source://rdoc//lib/rdoc/constant.rb#27 + # source://rdoc//lib/rdoc/code_object/constant.rb#27 def visibility=(_arg0); end end @@ -1326,7 +1325,7 @@ end # aliases, requires, and includes. Classes, modules, and files are all # Contexts. # -# source://rdoc//lib/rdoc/context.rb#7 +# source://rdoc//lib/rdoc/code_object/context.rb#7 class RDoc::Context < ::RDoc::CodeObject include ::Comparable @@ -1334,12 +1333,12 @@ class RDoc::Context < ::RDoc::CodeObject # # @return [Context] a new instance of Context # - # source://rdoc//lib/rdoc/context.rb#123 + # source://rdoc//lib/rdoc/code_object/context.rb#123 def initialize; end # Contexts are sorted by full_name # - # source://rdoc//lib/rdoc/context.rb#171 + # source://rdoc//lib/rdoc/code_object/context.rb#171 def <=>(other); end # Adds an item of type +klass+ with the given +name+ and +comment+ to the @@ -1347,12 +1346,12 @@ class RDoc::Context < ::RDoc::CodeObject # # Currently only RDoc::Extend and RDoc::Include are supported. # - # source://rdoc//lib/rdoc/context.rb#183 + # source://rdoc//lib/rdoc/code_object/context.rb#183 def add(klass, name, comment); end # Adds +an_alias+ that is automatically resolved # - # source://rdoc//lib/rdoc/context.rb#198 + # source://rdoc//lib/rdoc/code_object/context.rb#198 def add_alias(an_alias); end # Adds +attribute+ if not already there. If it is (as method(s) or attribute), @@ -1363,7 +1362,7 @@ class RDoc::Context < ::RDoc::CodeObject # if method +foo+ exists, but attr_accessor :foo will be registered # if method +foo+ exists, but foo= does not. # - # source://rdoc//lib/rdoc/context.rb#225 + # source://rdoc//lib/rdoc/code_object/context.rb#225 def add_attribute(attribute); end # Adds a class named +given_name+ with +superclass+. @@ -1380,7 +1379,7 @@ class RDoc::Context < ::RDoc::CodeObject # unless it later sees class Container. +add_class+ automatically # upgrades +given_name+ to a class in this case. # - # source://rdoc//lib/rdoc/context.rb#288 + # source://rdoc//lib/rdoc/code_object/context.rb#288 def add_class(class_type, given_name, superclass = T.unsafe(nil)); end # Adds the class or module +mod+ to the modules or @@ -1389,51 +1388,51 @@ class RDoc::Context < ::RDoc::CodeObject # unless #done_documenting is +true+. Sets the #parent of +mod+ # to +self+, and its #section to #current_section. Returns +mod+. # - # source://rdoc//lib/rdoc/context.rb#404 + # source://rdoc//lib/rdoc/code_object/context.rb#404 def add_class_or_module(mod, self_hash, all_hash); end # 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. # - # source://rdoc//lib/rdoc/context.rb#429 + # source://rdoc//lib/rdoc/code_object/context.rb#429 def add_constant(constant); end # Adds extension module +ext+ which should be an RDoc::Extend # - # source://rdoc//lib/rdoc/context.rb#463 + # source://rdoc//lib/rdoc/code_object/context.rb#463 def add_extend(ext); end # Adds included module +include+ which should be an RDoc::Include # - # source://rdoc//lib/rdoc/context.rb#454 + # source://rdoc//lib/rdoc/code_object/context.rb#454 def add_include(include); end # Adds +method+ if not already there. If it is (as method or attribute), # updates the comment if it was empty. # - # source://rdoc//lib/rdoc/context.rb#473 + # source://rdoc//lib/rdoc/code_object/context.rb#473 def add_method(method); end # Adds a module named +name+. If RDoc already knows +name+ is a class then # that class is returned instead. See also #add_class. # - # source://rdoc//lib/rdoc/context.rb#506 + # source://rdoc//lib/rdoc/code_object/context.rb#506 def add_module(class_type, name); end # Adds an alias from +from+ (a class or module) to +name+ which was defined # in +file+. # - # source://rdoc//lib/rdoc/context.rb#527 + # source://rdoc//lib/rdoc/code_object/context.rb#527 def add_module_alias(from, from_name, to, file); end # Adds a module by +RDoc::NormalModule+ instance. See also #add_module. # - # source://rdoc//lib/rdoc/context.rb#519 + # source://rdoc//lib/rdoc/code_object/context.rb#519 def add_module_by_normal_module(mod); end # Adds +require+ to this context's top level # - # source://rdoc//lib/rdoc/context.rb#568 + # source://rdoc//lib/rdoc/code_object/context.rb#568 def add_require(require); end # Returns a section with +title+, creating it if it doesn't already exist. @@ -1443,17 +1442,17 @@ class RDoc::Context < ::RDoc::CodeObject # # See also RDoc::Context::Section # - # source://rdoc//lib/rdoc/context.rb#586 + # source://rdoc//lib/rdoc/code_object/context.rb#586 def add_section(title, comment = T.unsafe(nil)); end # Adds +thing+ to the collection +array+ # - # source://rdoc//lib/rdoc/context.rb#600 + # source://rdoc//lib/rdoc/code_object/context.rb#600 def add_to(array, thing); end # Class/module aliases # - # source://rdoc//lib/rdoc/context.rb#25 + # source://rdoc//lib/rdoc/code_object/context.rb#25 def aliases; end # Is there any content? @@ -1463,88 +1462,81 @@ class RDoc::Context < ::RDoc::CodeObject # # Includes and extends are also checked unless includes == false. # - # source://rdoc//lib/rdoc/context.rb#616 + # source://rdoc//lib/rdoc/code_object/context.rb#616 def any_content(includes = T.unsafe(nil)); end # All attr* methods # - # source://rdoc//lib/rdoc/context.rb#30 + # source://rdoc//lib/rdoc/code_object/context.rb#30 def attributes; end # Block params to be used in the next MethodAttr parsed under this context # - # source://rdoc//lib/rdoc/context.rb#35 + # source://rdoc//lib/rdoc/code_object/context.rb#35 def block_params; end # Block params to be used in the next MethodAttr parsed under this context # - # source://rdoc//lib/rdoc/context.rb#35 + # source://rdoc//lib/rdoc/code_object/context.rb#35 def block_params=(_arg0); end # Creates the full name for a child with +name+ # - # source://rdoc//lib/rdoc/context.rb#632 + # source://rdoc//lib/rdoc/code_object/context.rb#632 def child_name(name); end # Class attributes # - # source://rdoc//lib/rdoc/context.rb#645 + # source://rdoc//lib/rdoc/code_object/context.rb#645 def class_attributes; end # Class methods # - # source://rdoc//lib/rdoc/context.rb#652 + # source://rdoc//lib/rdoc/code_object/context.rb#652 def class_method_list; end # Array of classes in this context # - # source://rdoc//lib/rdoc/context.rb#659 + # source://rdoc//lib/rdoc/code_object/context.rb#659 def classes; end # All classes and modules in this namespace # - # source://rdoc//lib/rdoc/context.rb#666 + # source://rdoc//lib/rdoc/code_object/context.rb#666 def classes_and_modules; end # Hash of classes keyed by class name # - # source://rdoc//lib/rdoc/context.rb#673 + # source://rdoc//lib/rdoc/code_object/context.rb#673 def classes_hash; end # Constants defined # - # source://rdoc//lib/rdoc/context.rb#40 + # source://rdoc//lib/rdoc/code_object/context.rb#40 def constants; end # Hash of registered constants. # - # source://rdoc//lib/rdoc/context.rb#118 + # source://rdoc//lib/rdoc/code_object/context.rb#118 def constants_hash; end # Current visibility of this line # - # source://rdoc//lib/rdoc/context.rb#102 + # source://rdoc//lib/rdoc/code_object/context.rb#102 def current_line_visibility=(_arg0); end # The current documentation section that new items will be added to. If # temporary_section is available it will be used. # - # source://rdoc//lib/rdoc/context.rb#681 + # source://rdoc//lib/rdoc/code_object/context.rb#681 def current_section; end # Sets the current documentation section of documentation # - # source://rdoc//lib/rdoc/context.rb#45 + # source://rdoc//lib/rdoc/code_object/context.rb#45 def current_section=(_arg0); end - # Is part of this thing was defined in +file+? - # - # @return [Boolean] - # - # source://rdoc//lib/rdoc/context.rb#694 - def defined_in?(file); end - - # source://rdoc//lib/rdoc/context.rb#698 + # source://rdoc//lib/rdoc/code_object/context.rb#691 def display(method_attr); end # Iterator for ancestors for duck-typing. Does nothing. See @@ -1553,37 +1545,17 @@ class RDoc::Context < ::RDoc::CodeObject # This method exists to make it easy to work with Context subclasses that # aren't part of RDoc. # - # source://rdoc//lib/rdoc/context.rb#713 - def each_ancestor; end - - # Iterator for attributes - # - # source://rdoc//lib/rdoc/context.rb#719 - def each_attribute; end + # source://rdoc//lib/rdoc/code_object/context.rb#706 + def each_ancestor(&_); end # Iterator for classes and modules # - # source://rdoc//lib/rdoc/context.rb#726 + # source://rdoc//lib/rdoc/code_object/context.rb#712 def each_classmodule(&block); end - # Iterator for constants - # - # source://rdoc//lib/rdoc/context.rb#733 - def each_constant; end - - # Iterator for extension modules - # - # source://rdoc//lib/rdoc/context.rb#747 - def each_extend; end - - # Iterator for included modules - # - # source://rdoc//lib/rdoc/context.rb#740 - def each_include; end - # Iterator for methods # - # source://rdoc//lib/rdoc/context.rb#754 + # source://rdoc//lib/rdoc/code_object/context.rb#719 def each_method; end # Iterator for each section's contents sorted by title. The +section+, the @@ -1595,98 +1567,93 @@ class RDoc::Context < ::RDoc::CodeObject # # NOTE: Do not edit collections yielded by this method # - # source://rdoc//lib/rdoc/context.rb#770 + # source://rdoc//lib/rdoc/code_object/context.rb#735 def each_section; end # Modules this context is extended with # - # source://rdoc//lib/rdoc/context.rb#60 + # source://rdoc//lib/rdoc/code_object/context.rb#60 def extends; end # Aliases that could not be resolved. # - # source://rdoc//lib/rdoc/context.rb#92 + # source://rdoc//lib/rdoc/code_object/context.rb#92 def external_aliases; end # Finds an attribute +name+ with singleton value +singleton+. # - # source://rdoc//lib/rdoc/context.rb#787 + # source://rdoc//lib/rdoc/code_object/context.rb#752 def find_attribute(name, singleton); end # Finds an attribute with +name+ in this context # - # source://rdoc//lib/rdoc/context.rb#795 + # source://rdoc//lib/rdoc/code_object/context.rb#760 def find_attribute_named(name); end # Finds a class method with +name+ in this context # - # source://rdoc//lib/rdoc/context.rb#809 + # source://rdoc//lib/rdoc/code_object/context.rb#774 def find_class_method_named(name); end # Finds a constant with +name+ in this context # - # source://rdoc//lib/rdoc/context.rb#816 + # source://rdoc//lib/rdoc/code_object/context.rb#781 def find_constant_named(name); end # Find a module at a higher scope # - # source://rdoc//lib/rdoc/context.rb#825 + # source://rdoc//lib/rdoc/code_object/context.rb#790 def find_enclosing_module_named(name); end # Finds an external alias +name+ with singleton value +singleton+. # - # source://rdoc//lib/rdoc/context.rb#832 + # source://rdoc//lib/rdoc/code_object/context.rb#797 def find_external_alias(name, singleton); end # Finds an external alias with +name+ in this context # - # source://rdoc//lib/rdoc/context.rb#839 + # source://rdoc//lib/rdoc/code_object/context.rb#804 def find_external_alias_named(name); end - # Finds a file with +name+ in this context - # - # source://rdoc//lib/rdoc/context.rb#853 - def find_file_named(name); end - # Finds an instance method with +name+ in this context # - # source://rdoc//lib/rdoc/context.rb#860 + # source://rdoc//lib/rdoc/code_object/context.rb#818 def find_instance_method_named(name); end # Finds a method, constant, attribute, external alias, module or file # named +symbol+ in this context. # - # source://rdoc//lib/rdoc/context.rb#868 + # source://rdoc//lib/rdoc/code_object/context.rb#826 def find_local_symbol(symbol); end # Finds a method named +name+ with singleton value +singleton+. # - # source://rdoc//lib/rdoc/context.rb#880 + # source://rdoc//lib/rdoc/code_object/context.rb#838 def find_method(name, singleton); end # Finds a instance or module method with +name+ in this context # - # source://rdoc//lib/rdoc/context.rb#893 + # source://rdoc//lib/rdoc/code_object/context.rb#851 def find_method_named(name); end # Find a module with +name+ using ruby's scoping rules # - # source://rdoc//lib/rdoc/context.rb#907 + # source://rdoc//lib/rdoc/code_object/context.rb#865 def find_module_named(name); end # Look up +symbol+, first as a module, then as a local symbol. # - # source://rdoc//lib/rdoc/context.rb#917 + # source://rdoc//lib/rdoc/code_object/context.rb#875 def find_symbol(symbol); end # Look up a module named +symbol+. # - # source://rdoc//lib/rdoc/context.rb#924 + # source://rdoc//lib/rdoc/code_object/context.rb#882 def find_symbol_module(symbol); end # The full name for this context. This method is overridden by subclasses. # - # source://rdoc//lib/rdoc/context.rb#957 + # source://rdoc//lib/rdoc/code_object/context.rb#915 def full_name; end # Does this context and its methods and constants all have documentation? @@ -1695,49 +1662,49 @@ class RDoc::Context < ::RDoc::CodeObject # # @return [Boolean] # - # source://rdoc//lib/rdoc/context.rb#966 + # source://rdoc//lib/rdoc/code_object/context.rb#924 def fully_documented?; end # URL for this with a +prefix+ # - # source://rdoc//lib/rdoc/context.rb#976 - def http_url(prefix); end + # source://rdoc//lib/rdoc/code_object/context.rb#934 + def http_url; end # Files this context is found in # - # source://rdoc//lib/rdoc/context.rb#50 + # source://rdoc//lib/rdoc/code_object/context.rb#50 def in_files; end # Modules this context includes # - # source://rdoc//lib/rdoc/context.rb#55 + # source://rdoc//lib/rdoc/code_object/context.rb#55 def includes; end # Sets the defaults for methods and so-forth # - # source://rdoc//lib/rdoc/context.rb#145 + # source://rdoc//lib/rdoc/code_object/context.rb#145 def initialize_methods_etc; end # Instance attributes # - # source://rdoc//lib/rdoc/context.rb#987 + # source://rdoc//lib/rdoc/code_object/context.rb#945 def instance_attributes; end # Instance methods # -- # TODO remove this later # - # source://rdoc//lib/rdoc/context.rb#1003 + # source://rdoc//lib/rdoc/code_object/context.rb#961 def instance_method_list; end # Instance methods # - # source://rdoc//lib/rdoc/context.rb#994 + # source://rdoc//lib/rdoc/code_object/context.rb#952 def instance_methods; end # Methods defined in this context # - # source://rdoc//lib/rdoc/context.rb#65 + # source://rdoc//lib/rdoc/code_object/context.rb#65 def method_list; end # Breaks method_list into a nested hash by type ('class' or @@ -1746,59 +1713,59 @@ class RDoc::Context < ::RDoc::CodeObject # If +section+ is provided only methods in that RDoc::Context::Section will # be returned. # - # source://rdoc//lib/rdoc/context.rb#1015 + # source://rdoc//lib/rdoc/code_object/context.rb#973 def methods_by_type(section = T.unsafe(nil)); end # Hash of registered methods. Attributes are also registered here, # twice if they are RW. # - # source://rdoc//lib/rdoc/context.rb#108 + # source://rdoc//lib/rdoc/code_object/context.rb#108 def methods_hash; end # Yields AnyMethod and Attr entries matching the list of names in +methods+. # - # source://rdoc//lib/rdoc/context.rb#1038 + # source://rdoc//lib/rdoc/code_object/context.rb#996 def methods_matching(methods, singleton = T.unsafe(nil), &block); end # Array of modules in this context # - # source://rdoc//lib/rdoc/context.rb#1051 + # source://rdoc//lib/rdoc/code_object/context.rb#1009 def modules; end # Hash of modules keyed by module name # - # source://rdoc//lib/rdoc/context.rb#1058 + # source://rdoc//lib/rdoc/code_object/context.rb#1016 def modules_hash; end # Name of this class excluding namespace. See also full_name # - # source://rdoc//lib/rdoc/context.rb#70 + # source://rdoc//lib/rdoc/code_object/context.rb#70 def name; end # Name to use to generate the url. # #full_name by default. # - # source://rdoc//lib/rdoc/context.rb#1066 + # source://rdoc//lib/rdoc/code_object/context.rb#1024 def name_for_path; end # Changes the visibility for new methods to +visibility+ # - # source://rdoc//lib/rdoc/context.rb#1073 + # source://rdoc//lib/rdoc/code_object/context.rb#1031 def ongoing_visibility=(visibility); end # Params to be used in the next MethodAttr parsed under this context # - # source://rdoc//lib/rdoc/context.rb#113 + # source://rdoc//lib/rdoc/code_object/context.rb#113 def params; end # Params to be used in the next MethodAttr parsed under this context # - # source://rdoc//lib/rdoc/context.rb#113 + # source://rdoc//lib/rdoc/code_object/context.rb#113 def params=(_arg0); end # Record +top_level+ as a file +self+ is in. # - # source://rdoc//lib/rdoc/context.rb#1080 + # source://rdoc//lib/rdoc/code_object/context.rb#1038 def record_location(top_level); end # Should we remove this context from the documentation? @@ -1812,80 +1779,80 @@ class RDoc::Context < ::RDoc::CodeObject # # @return [Boolean] # - # source://rdoc//lib/rdoc/context.rb#1094 + # source://rdoc//lib/rdoc/code_object/context.rb#1052 def remove_from_documentation?; end # Removes methods and attributes with a visibility less than +min_visibility+. # -- # TODO mark the visibility of attributes in the template (if not public?) # - # source://rdoc//lib/rdoc/context.rb#1107 + # source://rdoc//lib/rdoc/code_object/context.rb#1065 def remove_invisible(min_visibility); end # Only called when min_visibility == :public or :private # - # source://rdoc//lib/rdoc/context.rb#1117 + # source://rdoc//lib/rdoc/code_object/context.rb#1075 def remove_invisible_in(array, min_visibility); end # Files this context requires # - # source://rdoc//lib/rdoc/context.rb#75 + # source://rdoc//lib/rdoc/code_object/context.rb#75 def requires; end # Tries to resolve unmatched aliases when a method or attribute has just # been added. # - # source://rdoc//lib/rdoc/context.rb#1133 + # source://rdoc//lib/rdoc/code_object/context.rb#1091 def resolve_aliases(added); end # Returns RDoc::Context::Section objects referenced in this context for use # in a table of contents. # - # source://rdoc//lib/rdoc/context.rb#1149 + # source://rdoc//lib/rdoc/code_object/context.rb#1107 def section_contents; end # Sections in this context # - # source://rdoc//lib/rdoc/context.rb#1173 + # source://rdoc//lib/rdoc/code_object/context.rb#1131 def sections; end - # source://rdoc//lib/rdoc/context.rb#1177 + # source://rdoc//lib/rdoc/code_object/context.rb#1135 def sections_hash; end # Given an array +names+ of constants, set the visibility of each constant to # +visibility+ # - # source://rdoc//lib/rdoc/context.rb#1202 + # source://rdoc//lib/rdoc/code_object/context.rb#1160 def set_constant_visibility_for(names, visibility); end # Sets the current section to a section with +title+. See also #add_section # - # source://rdoc//lib/rdoc/context.rb#1184 + # source://rdoc//lib/rdoc/code_object/context.rb#1142 def set_current_section(title, comment); end # Given an array +methods+ of method names, set the visibility of each to # +visibility+ # - # source://rdoc//lib/rdoc/context.rb#1192 + # source://rdoc//lib/rdoc/code_object/context.rb#1150 def set_visibility_for(methods, visibility, singleton = T.unsafe(nil)); end # Sorts sections alphabetically (default) or in TomDoc fashion (none, # Public, Internal, Deprecated) # - # source://rdoc//lib/rdoc/context.rb#1213 + # source://rdoc//lib/rdoc/code_object/context.rb#1171 def sort_sections; end # Use this section for the next method, attribute or constant added. # - # source://rdoc//lib/rdoc/context.rb#80 + # source://rdoc//lib/rdoc/code_object/context.rb#80 def temporary_section; end # Use this section for the next method, attribute or constant added. # - # source://rdoc//lib/rdoc/context.rb#80 + # source://rdoc//lib/rdoc/code_object/context.rb#80 def temporary_section=(_arg0); end - # source://rdoc//lib/rdoc/context.rb#1229 + # source://rdoc//lib/rdoc/code_object/context.rb#1187 def to_s; end # Return the TopLevel that owns us @@ -1893,36 +1860,36 @@ class RDoc::Context < ::RDoc::CodeObject # FIXME we can be 'owned' by several TopLevel (see #record_location & # #in_files) # - # source://rdoc//lib/rdoc/context.rb#1239 + # source://rdoc//lib/rdoc/code_object/context.rb#1197 def top_level; end # Hash old_name => [aliases], for aliases # that haven't (yet) been resolved to a method/attribute. # (Not to be confused with the aliases of the context.) # - # source://rdoc//lib/rdoc/context.rb#87 + # source://rdoc//lib/rdoc/code_object/context.rb#87 def unmatched_alias_lists; end # Hash old_name => [aliases], for aliases # that haven't (yet) been resolved to a method/attribute. # (Not to be confused with the aliases of the context.) # - # source://rdoc//lib/rdoc/context.rb#87 + # source://rdoc//lib/rdoc/code_object/context.rb#87 def unmatched_alias_lists=(_arg0); end # Upgrades NormalModule +mod+ in +enclosing+ to a +class_type+ # - # source://rdoc//lib/rdoc/context.rb#1249 + # source://rdoc//lib/rdoc/code_object/context.rb#1207 def upgrade_to_class(mod, class_type, enclosing); end # Current visibility of this context # - # source://rdoc//lib/rdoc/context.rb#97 + # source://rdoc//lib/rdoc/code_object/context.rb#97 def visibility; end # Current visibility of this context # - # source://rdoc//lib/rdoc/context.rb#97 + # source://rdoc//lib/rdoc/code_object/context.rb#97 def visibility=(_arg0); end end @@ -1934,7 +1901,7 @@ end # Sections can be referenced multiple times and will be collapsed into a # single section. # -# source://rdoc//lib/rdoc/context/section.rb#13 +# source://rdoc//lib/rdoc/code_object/context/section.rb#13 class RDoc::Context::Section include ::RDoc::Text include ::RDoc::Generator::Markup @@ -1943,37 +1910,37 @@ class RDoc::Context::Section # # @return [Section] a new instance of Section # - # source://rdoc//lib/rdoc/context/section.rb#42 + # source://rdoc//lib/rdoc/code_object/context/section.rb#42 def initialize(parent, title, comment); end # Sections are equal when they have the same #title # - # source://rdoc//lib/rdoc/context/section.rb#54 + # source://rdoc//lib/rdoc/code_object/context/section.rb#54 def ==(other); end # Adds +comment+ to this section # - # source://rdoc//lib/rdoc/context/section.rb#63 + # source://rdoc//lib/rdoc/code_object/context/section.rb#63 def add_comment(comment); end # Anchor reference for linking to this section # - # source://rdoc//lib/rdoc/context/section.rb#83 + # source://rdoc//lib/rdoc/code_object/context/section.rb#74 def aref; end # Section comment # - # source://rdoc//lib/rdoc/context/section.rb#22 + # source://rdoc//lib/rdoc/code_object/context/section.rb#22 def comment; end # Section comments # - # source://rdoc//lib/rdoc/context/section.rb#27 + # source://rdoc//lib/rdoc/code_object/context/section.rb#27 def comments; end # Sections are equal when they have the same #title # - # source://rdoc//lib/rdoc/context/section.rb#54 + # source://rdoc//lib/rdoc/code_object/context/section.rb#54 def eql?(other); end # Extracts the comment for this section from the original comment block. @@ -1984,58 +1951,58 @@ class RDoc::Context::Section # # :section: The title # # The body # - # source://rdoc//lib/rdoc/context/section.rb#98 + # source://rdoc//lib/rdoc/code_object/context/section.rb#89 def extract_comment(comment); end - # source://rdoc//lib/rdoc/context/section.rb#130 + # source://rdoc//lib/rdoc/code_object/context/section.rb#115 def hash; end # The files comments in this section come from # - # source://rdoc//lib/rdoc/context/section.rb#137 + # source://rdoc//lib/rdoc/code_object/context/section.rb#122 def in_files; end - # source://rdoc//lib/rdoc/context/section.rb#126 + # source://rdoc//lib/rdoc/code_object/context/section.rb#111 def inspect; end # Serializes this Section. The title and parsed comment are saved, but not # the section parent which must be restored manually. # - # source://rdoc//lib/rdoc/context/section.rb#158 + # source://rdoc//lib/rdoc/code_object/context/section.rb#130 def marshal_dump; end # De-serializes this Section. The section parent must be restored manually. # - # source://rdoc//lib/rdoc/context/section.rb#169 + # source://rdoc//lib/rdoc/code_object/context/section.rb#141 def marshal_load(array); end # Context this Section lives in # - # source://rdoc//lib/rdoc/context/section.rb#32 + # source://rdoc//lib/rdoc/code_object/context/section.rb#32 def parent; end # Parses +comment_location+ into an RDoc::Markup::Document composed of # multiple RDoc::Markup::Documents with their file set. # - # source://rdoc//lib/rdoc/context/section.rb#180 + # source://rdoc//lib/rdoc/code_object/context/section.rb#152 def parse; end # The section's title, or 'Top Section' if the title is nil. # # This is used by the table of contents template so the name is silly. # - # source://rdoc//lib/rdoc/context/section.rb#208 + # source://rdoc//lib/rdoc/code_object/context/section.rb#161 def plain_html; end # Removes a comment from this section if it is from the same file as # +comment+ # - # source://rdoc//lib/rdoc/context/section.rb#216 - def remove_comment(comment); end + # source://rdoc//lib/rdoc/code_object/context/section.rb#169 + def remove_comment(target_comment); end # Section title # - # source://rdoc//lib/rdoc/context/section.rb#37 + # source://rdoc//lib/rdoc/code_object/context/section.rb#37 def title; end end @@ -2174,7 +2141,7 @@ class RDoc::Generator::Darkfish # # @return [Darkfish] a new instance of Darkfish # - # source://rdoc//lib/rdoc/generator/darkfish.rb#159 + # source://rdoc//lib/rdoc/generator/darkfish.rb#153 def initialize(store, options); end # Creates a template from its components and the +body_file+. @@ -2182,174 +2149,172 @@ class RDoc::Generator::Darkfish # For backwards compatibility, if +body_file+ contains "--op from the # options for a full path. # - # source://rdoc//lib/rdoc/generator/darkfish.rb#102 + # source://rdoc//lib/rdoc/generator/darkfish.rb#96 def base_dir; end - # Directory where generated class HTML files live relative to the output - # dir. - # - # source://rdoc//lib/rdoc/generator/darkfish.rb#191 - def class_dir; end - # Classes and modules to be used by this generator, not necessarily # displayed. See also #modsort # - # source://rdoc//lib/rdoc/generator/darkfish.rb#108 + # source://rdoc//lib/rdoc/generator/darkfish.rb#102 def classes; end # Copies static files from the static_path into the output directory # - # source://rdoc//lib/rdoc/generator/darkfish.rb#265 + # source://rdoc//lib/rdoc/generator/darkfish.rb#243 def copy_static; end # Output progress information if debugging is enabled # - # source://rdoc//lib/rdoc/generator/darkfish.rb#182 + # source://rdoc//lib/rdoc/generator/darkfish.rb#176 def debug_msg(*msg); end # No files will be written when dry_run is true. # - # source://rdoc//lib/rdoc/generator/darkfish.rb#113 + # source://rdoc//lib/rdoc/generator/darkfish.rb#107 def dry_run; end # No files will be written when dry_run is true. # - # source://rdoc//lib/rdoc/generator/darkfish.rb#113 + # source://rdoc//lib/rdoc/generator/darkfish.rb#107 def dry_run=(_arg0); end - # Directory where generated class HTML files live relative to the output - # dir. + # Returns an excerpt of the comment for usage in meta description tags # - # source://rdoc//lib/rdoc/generator/darkfish.rb#199 - def file_dir; end + # source://rdoc//lib/rdoc/generator/darkfish.rb#704 + def excerpt(comment); end # When false the generate methods return a String instead of writing to a # file. The default is true. # - # source://rdoc//lib/rdoc/generator/darkfish.rb#119 + # source://rdoc//lib/rdoc/generator/darkfish.rb#113 def file_output; end # When false the generate methods return a String instead of writing to a # file. The default is true. # - # source://rdoc//lib/rdoc/generator/darkfish.rb#119 + # source://rdoc//lib/rdoc/generator/darkfish.rb#113 def file_output=(_arg0); end # Files to be displayed by this generator # - # source://rdoc//lib/rdoc/generator/darkfish.rb#124 + # source://rdoc//lib/rdoc/generator/darkfish.rb#118 def files; end # Create the directories the generated docs will live in if they don't # already exist. # - # source://rdoc//lib/rdoc/generator/darkfish.rb#207 + # source://rdoc//lib/rdoc/generator/darkfish.rb#185 def gen_sub_directories; end # Build the initial indices and output objects based on an array of TopLevel # objects containing the extracted information. # - # source://rdoc//lib/rdoc/generator/darkfish.rb#241 + # source://rdoc//lib/rdoc/generator/darkfish.rb#219 def generate; end + # source://rdoc//lib/rdoc/generator/darkfish.rb#732 + def generate_ancestor_list(ancestors, klass); end + # Generates a class file for +klass+ # - # source://rdoc//lib/rdoc/generator/darkfish.rb#337 + # source://rdoc//lib/rdoc/generator/darkfish.rb#316 def generate_class(klass, template_file = T.unsafe(nil)); end # Generate a documentation file for each class and module # - # source://rdoc//lib/rdoc/generator/darkfish.rb#368 + # source://rdoc//lib/rdoc/generator/darkfish.rb#346 def generate_class_files; end + # source://rdoc//lib/rdoc/generator/darkfish.rb#758 + def generate_class_index_content(classes, rel_prefix); end + + # source://rdoc//lib/rdoc/generator/darkfish.rb#750 + def generate_class_link(klass, rel_prefix); end + # Generate a documentation file for each file # - # source://rdoc//lib/rdoc/generator/darkfish.rb#395 + # source://rdoc//lib/rdoc/generator/darkfish.rb#371 def generate_file_files; end # Generate an index page which lists all the classes which are documented. # - # source://rdoc//lib/rdoc/generator/darkfish.rb#303 + # source://rdoc//lib/rdoc/generator/darkfish.rb#281 def generate_index; end # Generate a page file for +file+ # - # source://rdoc//lib/rdoc/generator/darkfish.rb#464 + # source://rdoc//lib/rdoc/generator/darkfish.rb#438 def generate_page(file); end # Generates the 404 page for the RDoc servlet # - # source://rdoc//lib/rdoc/generator/darkfish.rb#493 + # source://rdoc//lib/rdoc/generator/darkfish.rb#465 def generate_servlet_not_found(message); end # Generates the servlet root page for the RDoc servlet # - # source://rdoc//lib/rdoc/generator/darkfish.rb#526 + # source://rdoc//lib/rdoc/generator/darkfish.rb#496 def generate_servlet_root(installed); end # Generate an index page which lists all the classes which are documented. # - # source://rdoc//lib/rdoc/generator/darkfish.rb#553 + # source://rdoc//lib/rdoc/generator/darkfish.rb#521 def generate_table_of_contents; end # Return a list of the documented modules sorted by salience first, then # by name. # - # source://rdoc//lib/rdoc/generator/darkfish.rb#294 + # source://rdoc//lib/rdoc/generator/darkfish.rb#272 def get_sorted_module_list(classes); end - # Try to extract Subversion information out of the first constant whose - # value looks like a subversion Id tag. If no matching constant is found, - # and empty hash is returned. - # - # source://rdoc//lib/rdoc/generator/darkfish.rb#652 - def get_svninfo(klass); end + # source://rdoc//lib/rdoc/generator/darkfish.rb#783 + def group_classes_by_namespace_for_sidebar(classes); end - # source://rdoc//lib/rdoc/generator/darkfish.rb#584 + # source://rdoc//lib/rdoc/generator/darkfish.rb#550 def install_rdoc_static_file(source, destination, options); end # The JSON index generator for this Darkfish generator # - # source://rdoc//lib/rdoc/generator/darkfish.rb#129 + # source://rdoc//lib/rdoc/generator/darkfish.rb#123 def json_index; end # Methods to be displayed by this generator # - # source://rdoc//lib/rdoc/generator/darkfish.rb#134 + # source://rdoc//lib/rdoc/generator/darkfish.rb#128 def methods; end # Sorted list of classes and modules to be displayed by this generator # - # source://rdoc//lib/rdoc/generator/darkfish.rb#139 + # source://rdoc//lib/rdoc/generator/darkfish.rb#133 def modsort; end # The output directory # - # source://rdoc//lib/rdoc/generator/darkfish.rb#154 + # source://rdoc//lib/rdoc/generator/darkfish.rb#148 def outputdir; end # Renders the ERb contained in +file_name+ relative to the template # directory and returns the result based on the current context. # - # source://rdoc//lib/rdoc/generator/darkfish.rb#699 + # source://rdoc//lib/rdoc/generator/darkfish.rb#610 def render(file_name); end # Load and render the erb template in the given +template_file+ and write @@ -2359,90 +2324,93 @@ class RDoc::Generator::Darkfish # # An io will be yielded which must be captured by binding in the caller. # - # source://rdoc//lib/rdoc/generator/darkfish.rb#717 + # source://rdoc//lib/rdoc/generator/darkfish.rb#628 def render_template(template_file, out_file = T.unsafe(nil)); end # Prepares for generation of output from the current directory # - # source://rdoc//lib/rdoc/generator/darkfish.rb#604 + # source://rdoc//lib/rdoc/generator/darkfish.rb#570 def setup; end # The RDoc::Store that is the source of the generated content # - # source://rdoc//lib/rdoc/generator/darkfish.rb#144 + # source://rdoc//lib/rdoc/generator/darkfish.rb#138 def store; end # The directory where the template files live # - # source://rdoc//lib/rdoc/generator/darkfish.rb#149 + # source://rdoc//lib/rdoc/generator/darkfish.rb#143 def template_dir; end # Retrieves a cache template for +file+, if present, or fills the cache. # - # source://rdoc//lib/rdoc/generator/darkfish.rb#764 + # source://rdoc//lib/rdoc/generator/darkfish.rb#675 def template_for(file, page = T.unsafe(nil), klass = T.unsafe(nil)); end # Creates the result for +template+ with +context+. If an error is raised a # Pathname +template_file+ will indicate the file where the error occurred. # - # source://rdoc//lib/rdoc/generator/darkfish.rb#751 + # source://rdoc//lib/rdoc/generator/darkfish.rb#662 def template_result(template, context, template_file); end - # Return a string describing the amount of time in the given number of - # seconds in terms a human can understand easily. - # - # source://rdoc//lib/rdoc/generator/darkfish.rb#621 - def time_delta_string(seconds); end + # source://rdoc//lib/rdoc/generator/darkfish.rb#766 + def traverse_classes(klasses, grouped_classes, rel_prefix, solo = T.unsafe(nil)); end # Copy over the stylesheet into the appropriate place in the output # directory. # - # source://rdoc//lib/rdoc/generator/darkfish.rb#215 + # source://rdoc//lib/rdoc/generator/darkfish.rb#193 def write_style_sheet; end + + private + + # source://rdoc//lib/rdoc/generator/darkfish.rb#806 + def generate_nesting_namespaces_breadcrumb(klass, rel_prefix); end + + # source://rdoc//lib/rdoc/generator/darkfish.rb#796 + def nesting_namespaces_to_class_modules(klass); end end +# :stopdoc: +# +# source://rdoc//lib/rdoc/generator/darkfish.rb#698 +RDoc::Generator::Darkfish::ParagraphExcerptRegexpOther = T.let(T.unsafe(nil), Regexp) + +# use \p/\P{letter} instead of \w/\W in Unicode +# +# source://rdoc//lib/rdoc/generator/darkfish.rb#700 +RDoc::Generator::Darkfish::ParagraphExcerptRegexpUnicode = T.let(T.unsafe(nil), Regexp) + # source://rdoc//lib/rdoc/generator/json_index.rb#77 class RDoc::Generator::JsonIndex include ::RDoc::Text - # Creates a new generator. +parent_generator+ is used to determine the - # class_dir and file_dir of links in the output index. - # + # Creates a new generator. # +options+ are the same options passed to the parent generator. # # @return [JsonIndex] a new instance of JsonIndex # - # source://rdoc//lib/rdoc/generator/json_index.rb#94 + # source://rdoc//lib/rdoc/generator/json_index.rb#92 def initialize(parent_generator, options); end # Builds the JSON index as a Hash. # - # source://rdoc//lib/rdoc/generator/json_index.rb#110 + # source://rdoc//lib/rdoc/generator/json_index.rb#108 def build_index; end - # The directory classes are written to - # - # source://rdoc//lib/rdoc/generator/json_index.rb#271 - def class_dir; end - # Output progress information if debugging is enabled # - # source://rdoc//lib/rdoc/generator/json_index.rb#123 + # source://rdoc//lib/rdoc/generator/json_index.rb#121 def debug_msg(*msg); end - # The directory files are written to - # - # source://rdoc//lib/rdoc/generator/json_index.rb#278 - def file_dir; end - # Writes the JSON index to disk # - # source://rdoc//lib/rdoc/generator/json_index.rb#131 + # source://rdoc//lib/rdoc/generator/json_index.rb#129 def generate; end # Compress the search_index.js file using gzip # - # source://rdoc//lib/rdoc/generator/json_index.rb#166 + # source://rdoc//lib/rdoc/generator/json_index.rb#164 def generate_gzipped; end # source://rdoc//lib/rdoc/generator/json_index.rb#86 @@ -2450,25 +2418,25 @@ class RDoc::Generator::JsonIndex # Adds classes and modules to the index # - # source://rdoc//lib/rdoc/generator/json_index.rb#211 + # source://rdoc//lib/rdoc/generator/json_index.rb#209 def index_classes; end # Adds methods to the index # - # source://rdoc//lib/rdoc/generator/json_index.rb#230 + # source://rdoc//lib/rdoc/generator/json_index.rb#228 def index_methods; end # Adds pages to the index # - # source://rdoc//lib/rdoc/generator/json_index.rb#251 + # source://rdoc//lib/rdoc/generator/json_index.rb#249 def index_pages; end - # source://rdoc//lib/rdoc/generator/json_index.rb#282 + # source://rdoc//lib/rdoc/generator/json_index.rb#266 def reset(files, classes); end # Removes whitespace and downcases +string+ # - # source://rdoc//lib/rdoc/generator/json_index.rb#296 + # source://rdoc//lib/rdoc/generator/json_index.rb#280 def search_string(string); end end @@ -2569,9 +2537,6 @@ class RDoc::Generator::POT # source://rdoc//lib/rdoc/generator/pot.rb#68 def initialize(store, options); end - # source://rdoc//lib/rdoc/generator/pot.rb#85 - def class_dir; end - # Writes .pot to disk. # # source://rdoc//lib/rdoc/generator/pot.rb#76 @@ -2579,7 +2544,7 @@ class RDoc::Generator::POT private - # source://rdoc//lib/rdoc/generator/pot.rb#90 + # source://rdoc//lib/rdoc/generator/pot.rb#85 def extract_messages; end end @@ -2649,7 +2614,7 @@ end # # source://rdoc//lib/rdoc/generator/pot/po_entry.rb#5 class RDoc::Generator::POT::POEntry - # Creates a PO entry for +msgid+. Other valus can be specified by + # Creates a PO entry for +msgid+. Other values can be specified by # +options+. # # @return [POEntry] a new instance of POEntry @@ -2868,15 +2833,15 @@ class RDoc::Markdown # Alphanumeric = %literals.Alphanumeric # - # source://rdoc//lib/rdoc/markdown.rb#14705 + # source://rdoc//lib/rdoc/markdown.rb#14727 def _Alphanumeric; end # AlphanumericAscii = %literals.AlphanumericAscii # - # source://rdoc//lib/rdoc/markdown.rb#14712 + # source://rdoc//lib/rdoc/markdown.rb#14734 def _AlphanumericAscii; end - # AtxHeading = AtxStart:s @Sp AtxInline+:a (@Sp /#*/ @Sp)? @Newline { RDoc::Markup::Heading.new(s, a.join) } + # AtxHeading = AtxStart:s @Spacechar+ AtxInline+:a (@Sp /#*/ @Sp)? @Newline { RDoc::Markup::Heading.new(s, a.join) } # # source://rdoc//lib/rdoc/markdown.rb#1162 def _AtxHeading; end @@ -2893,27 +2858,27 @@ class RDoc::Markdown # AutoLink = (AutoLinkUrl | AutoLinkEmail) # - # source://rdoc//lib/rdoc/markdown.rb#11574 + # source://rdoc//lib/rdoc/markdown.rb#11596 def _AutoLink; end # AutoLinkEmail = "<" "mailto:"? < /[\w+.\/!%~$-]+/i "@" (!@Newline !">" .)+ > ">" { "mailto:#{text}" } # - # source://rdoc//lib/rdoc/markdown.rb#11707 + # source://rdoc//lib/rdoc/markdown.rb#11729 def _AutoLinkEmail; end # AutoLinkUrl = "<" < /[A-Za-z]+/ "://" (!@Newline !">" .)+ > ">" { text } # - # source://rdoc//lib/rdoc/markdown.rb#11592 + # source://rdoc//lib/rdoc/markdown.rb#11614 def _AutoLinkUrl; end # BOM = %literals.BOM # - # source://rdoc//lib/rdoc/markdown.rb#14719 + # source://rdoc//lib/rdoc/markdown.rb#14741 def _BOM; end # BlankLine = @Sp @Newline { "\n" } # - # source://rdoc//lib/rdoc/markdown.rb#14148 + # source://rdoc//lib/rdoc/markdown.rb#14170 def _BlankLine; end # Block = @BlankLine* (BlockQuote | Verbatim | CodeFence | Table | Note | Reference | HorizontalRule | Heading | OrderedList | BulletList | DefinitionList | HtmlBlock | StyleBlock | Para | Plain) @@ -2923,67 +2888,67 @@ class RDoc::Markdown # BlockQuote = BlockQuoteRaw:a { RDoc::Markup::BlockQuote.new(*a) } # - # source://rdoc//lib/rdoc/markdown.rb#1566 + # source://rdoc//lib/rdoc/markdown.rb#1576 def _BlockQuote; end # BlockQuoteRaw = @StartList:a (">" " "? Line:l { a << l } (!">" !@BlankLine Line:c { a << c })* (@BlankLine:n { a << n })*)+ { inner_parse a.join } # - # source://rdoc//lib/rdoc/markdown.rb#1589 + # source://rdoc//lib/rdoc/markdown.rb#1599 def _BlockQuoteRaw; end # Bullet = !HorizontalRule @NonindentSpace /[+*-]/ @Spacechar+ # - # source://rdoc//lib/rdoc/markdown.rb#2154 + # source://rdoc//lib/rdoc/markdown.rb#2164 def _Bullet; end # BulletList = &Bullet (ListTight | ListLoose):a { RDoc::Markup::List.new(:BULLET, *a) } # - # source://rdoc//lib/rdoc/markdown.rb#2198 + # source://rdoc//lib/rdoc/markdown.rb#2208 def _BulletList; end # CharEntity = "&" < /[A-Za-z0-9]+/ > ";" { if entity = HTML_ENTITIES[text] then entity.pack 'U*' else "&#{text};" end } # - # source://rdoc//lib/rdoc/markdown.rb#14812 + # source://rdoc//lib/rdoc/markdown.rb#14834 def _CharEntity; end # Code = (Ticks1 @Sp < ((!"`" Nonspacechar)+ | !Ticks1 /`+/ | !(@Sp Ticks1) (@Spacechar | @Newline !@BlankLine))+ > @Sp Ticks1 | Ticks2 @Sp < ((!"`" Nonspacechar)+ | !Ticks2 /`+/ | !(@Sp Ticks2) (@Spacechar | @Newline !@BlankLine))+ > @Sp Ticks2 | Ticks3 @Sp < ((!"`" Nonspacechar)+ | !Ticks3 /`+/ | !(@Sp Ticks3) (@Spacechar | @Newline !@BlankLine))+ > @Sp Ticks3 | Ticks4 @Sp < ((!"`" Nonspacechar)+ | !Ticks4 /`+/ | !(@Sp Ticks4) (@Spacechar | @Newline !@BlankLine))+ > @Sp Ticks4 | Ticks5 @Sp < ((!"`" Nonspacechar)+ | !Ticks5 /`+/ | !(@Sp Ticks5) (@Spacechar | @Newline !@BlankLine))+ > @Sp Ticks5) { "#{text}" } # - # source://rdoc//lib/rdoc/markdown.rb#12511 + # source://rdoc//lib/rdoc/markdown.rb#12533 def _Code; end # CodeFence = &{ github? } Ticks3 (@Sp StrChunk:format)? Spnl < ((!"`" Nonspacechar)+ | !Ticks3 /`+/ | Spacechar | @Newline)+ > Ticks3 @Sp @Newline* { verbatim = RDoc::Markup::Verbatim.new text verbatim.format = format.intern if format.instance_of?(String) verbatim } # - # source://rdoc//lib/rdoc/markdown.rb#15681 + # source://rdoc//lib/rdoc/markdown.rb#15703 def _CodeFence; end # DecEntity = "&#" < /[0-9]+/ > ";" { [text.to_i].pack 'U' } # - # source://rdoc//lib/rdoc/markdown.rb#14776 + # source://rdoc//lib/rdoc/markdown.rb#14798 def _DecEntity; end # DefinitionList = &{ definition_lists? } DefinitionListItem+:list { RDoc::Markup::List.new :NOTE, *list.flatten } # - # source://rdoc//lib/rdoc/markdown.rb#16339 + # source://rdoc//lib/rdoc/markdown.rb#16361 def _DefinitionList; end # DefinitionListDefinition = @NonindentSpace ":" @Space Inlines:a @BlankLine+ { paragraph a } # - # source://rdoc//lib/rdoc/markdown.rb#16482 + # source://rdoc//lib/rdoc/markdown.rb#16504 def _DefinitionListDefinition; end # DefinitionListItem = DefinitionListLabel+:label DefinitionListDefinition+:defns { list_items = [] list_items << RDoc::Markup::ListItem.new(label, defns.shift) list_items.concat defns.map { |defn| RDoc::Markup::ListItem.new nil, defn } unless list_items.empty? list_items } # - # source://rdoc//lib/rdoc/markdown.rb#16383 + # source://rdoc//lib/rdoc/markdown.rb#16405 def _DefinitionListItem; end - # DefinitionListLabel = StrChunk:label @Sp @Newline { label } + # DefinitionListLabel = Inline:label @Sp @Newline { label } # - # source://rdoc//lib/rdoc/markdown.rb#16449 + # source://rdoc//lib/rdoc/markdown.rb#16471 def _DefinitionListLabel; end # Digit = [0-9] # - # source://rdoc//lib/rdoc/markdown.rb#14691 + # source://rdoc//lib/rdoc/markdown.rb#14713 def _Digit; end # Doc = BOM? Block*:a { RDoc::Markup::Document.new(*a.compact) } @@ -2993,787 +2958,792 @@ class RDoc::Markdown # Emph = (EmphStar | EmphUl) # - # source://rdoc//lib/rdoc/markdown.rb#10283 + # source://rdoc//lib/rdoc/markdown.rb#10293 def _Emph; end # EmphStar = "*" !@Whitespace @StartList:a (!"*" Inline:b { a << b } | StrongStar:b { a << b })+ "*" { emphasis a.join } # - # source://rdoc//lib/rdoc/markdown.rb#10319 + # source://rdoc//lib/rdoc/markdown.rb#10329 def _EmphStar; end # EmphUl = "_" !@Whitespace @StartList:a (!"_" Inline:b { a << b } | StrongUl:b { a << b })+ "_" { emphasis a.join } # - # source://rdoc//lib/rdoc/markdown.rb#10477 + # source://rdoc//lib/rdoc/markdown.rb#10487 def _EmphUl; end # EmptyTitle = "" # - # source://rdoc//lib/rdoc/markdown.rb#12086 + # source://rdoc//lib/rdoc/markdown.rb#12108 def _EmptyTitle; end # Endline = (@LineBreak | @TerminalEndline | @NormalEndline) # - # source://rdoc//lib/rdoc/markdown.rb#9917 + # source://rdoc//lib/rdoc/markdown.rb#9927 def _Endline; end # Entity = (HexEntity | DecEntity | CharEntity):a { a } # - # source://rdoc//lib/rdoc/markdown.rb#9880 + # source://rdoc//lib/rdoc/markdown.rb#9890 def _Entity; end # Enumerator = @NonindentSpace [0-9]+ "." @Spacechar+ # - # source://rdoc//lib/rdoc/markdown.rb#2687 + # source://rdoc//lib/rdoc/markdown.rb#2697 def _Enumerator; end # Eof = !. # - # source://rdoc//lib/rdoc/markdown.rb#14542 + # source://rdoc//lib/rdoc/markdown.rb#14564 def _Eof; end # EscapedChar = "\\" !@Newline < /[:\\`|*_{}\[\]()#+.!><-]/ > { text } # - # source://rdoc//lib/rdoc/markdown.rb#9841 + # source://rdoc//lib/rdoc/markdown.rb#9851 def _EscapedChar; end - # ExplicitLink = Label:l "(" @Sp Source:s Spnl Title @Sp ")" { "{#{l}}[#{s}]" } + # ExplicitLink = ExplicitLinkWithLabel:a { "{#{a[:label]}}[#{a[:link]}]" } # - # source://rdoc//lib/rdoc/markdown.rb#11147 + # source://rdoc//lib/rdoc/markdown.rb#11146 def _ExplicitLink; end + # ExplicitLinkWithLabel = Label:label "(" @Sp Source:link Spnl Title @Sp ")" { { label: label, link: link } } + # + # source://rdoc//lib/rdoc/markdown.rb#11169 + def _ExplicitLinkWithLabel; end + # ExtendedSpecialChar = &{ notes? } "^" # - # source://rdoc//lib/rdoc/markdown.rb#15184 + # source://rdoc//lib/rdoc/markdown.rb#15206 def _ExtendedSpecialChar; end # Heading = (SetextHeading | AtxHeading) # - # source://rdoc//lib/rdoc/markdown.rb#1548 + # source://rdoc//lib/rdoc/markdown.rb#1558 def _Heading; end # HexEntity = /&#x/i < /[0-9a-fA-F]+/ > ";" { [text.to_i(16)].pack 'U' } # - # source://rdoc//lib/rdoc/markdown.rb#14740 + # source://rdoc//lib/rdoc/markdown.rb#14762 def _HexEntity; end # HorizontalRule = @NonindentSpace ("*" @Sp "*" @Sp "*" (@Sp "*")* | "-" @Sp "-" @Sp "-" (@Sp "-")* | "_" @Sp "_" @Sp "_" (@Sp "_")*) @Sp @Newline @BlankLine+ { RDoc::Markup::Rule.new 1 } # - # source://rdoc//lib/rdoc/markdown.rb#1932 + # source://rdoc//lib/rdoc/markdown.rb#1942 def _HorizontalRule; end # HtmlAnchor = HtmlOpenAnchor (HtmlAnchor | !HtmlCloseAnchor .)* HtmlCloseAnchor # - # source://rdoc//lib/rdoc/markdown.rb#2971 + # source://rdoc//lib/rdoc/markdown.rb#2981 def _HtmlAnchor; end # HtmlAttribute = (AlphanumericAscii | "-")+ Spnl ("=" Spnl (Quoted | (!">" Nonspacechar)+))? Spnl # - # source://rdoc//lib/rdoc/markdown.rb#14273 + # source://rdoc//lib/rdoc/markdown.rb#14295 def _HtmlAttribute; end # HtmlBlock = < (HtmlBlockInTags | HtmlComment | HtmlBlockSelfClosing | HtmlUnclosed) > @BlankLine+ { if html? then RDoc::Markup::Raw.new text end } # - # source://rdoc//lib/rdoc/markdown.rb#8768 + # source://rdoc//lib/rdoc/markdown.rb#8778 def _HtmlBlock; end # HtmlBlockAddress = HtmlBlockOpenAddress (HtmlBlockAddress | !HtmlBlockCloseAddress .)* HtmlBlockCloseAddress # - # source://rdoc//lib/rdoc/markdown.rb#3137 + # source://rdoc//lib/rdoc/markdown.rb#3147 def _HtmlBlockAddress; end # HtmlBlockBlockquote = HtmlBlockOpenBlockquote (HtmlBlockBlockquote | !HtmlBlockCloseBlockquote .)* HtmlBlockCloseBlockquote # - # source://rdoc//lib/rdoc/markdown.rb#3303 + # source://rdoc//lib/rdoc/markdown.rb#3313 def _HtmlBlockBlockquote; end # HtmlBlockCenter = HtmlBlockOpenCenter (HtmlBlockCenter | !HtmlBlockCloseCenter .)* HtmlBlockCloseCenter # - # source://rdoc//lib/rdoc/markdown.rb#3469 + # source://rdoc//lib/rdoc/markdown.rb#3479 def _HtmlBlockCenter; end # HtmlBlockCloseAddress = "<" Spnl "/" ("address" | "ADDRESS") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#3085 + # source://rdoc//lib/rdoc/markdown.rb#3095 def _HtmlBlockCloseAddress; end # HtmlBlockCloseBlockquote = "<" Spnl "/" ("blockquote" | "BLOCKQUOTE") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#3251 + # source://rdoc//lib/rdoc/markdown.rb#3261 def _HtmlBlockCloseBlockquote; end # HtmlBlockCloseCenter = "<" Spnl "/" ("center" | "CENTER") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#3417 + # source://rdoc//lib/rdoc/markdown.rb#3427 def _HtmlBlockCloseCenter; end # HtmlBlockCloseDd = "<" Spnl "/" ("dd" | "DD") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#6737 + # source://rdoc//lib/rdoc/markdown.rb#6747 def _HtmlBlockCloseDd; end # HtmlBlockCloseDir = "<" Spnl "/" ("dir" | "DIR") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#3583 + # source://rdoc//lib/rdoc/markdown.rb#3593 def _HtmlBlockCloseDir; end # HtmlBlockCloseDiv = "<" Spnl "/" ("div" | "DIV") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#3749 + # source://rdoc//lib/rdoc/markdown.rb#3759 def _HtmlBlockCloseDiv; end # HtmlBlockCloseDl = "<" Spnl "/" ("dl" | "DL") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#3915 + # source://rdoc//lib/rdoc/markdown.rb#3925 def _HtmlBlockCloseDl; end # HtmlBlockCloseDt = "<" Spnl "/" ("dt" | "DT") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#6903 + # source://rdoc//lib/rdoc/markdown.rb#6913 def _HtmlBlockCloseDt; end # HtmlBlockCloseFieldset = "<" Spnl "/" ("fieldset" | "FIELDSET") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#4081 + # source://rdoc//lib/rdoc/markdown.rb#4091 def _HtmlBlockCloseFieldset; end # HtmlBlockCloseForm = "<" Spnl "/" ("form" | "FORM") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#4247 + # source://rdoc//lib/rdoc/markdown.rb#4257 def _HtmlBlockCloseForm; end # HtmlBlockCloseFrameset = "<" Spnl "/" ("frameset" | "FRAMESET") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#7069 + # source://rdoc//lib/rdoc/markdown.rb#7079 def _HtmlBlockCloseFrameset; end # HtmlBlockCloseH1 = "<" Spnl "/" ("h1" | "H1") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#4413 + # source://rdoc//lib/rdoc/markdown.rb#4423 def _HtmlBlockCloseH1; end # HtmlBlockCloseH2 = "<" Spnl "/" ("h2" | "H2") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#4579 + # source://rdoc//lib/rdoc/markdown.rb#4589 def _HtmlBlockCloseH2; end # HtmlBlockCloseH3 = "<" Spnl "/" ("h3" | "H3") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#4745 + # source://rdoc//lib/rdoc/markdown.rb#4755 def _HtmlBlockCloseH3; end # HtmlBlockCloseH4 = "<" Spnl "/" ("h4" | "H4") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#4911 + # source://rdoc//lib/rdoc/markdown.rb#4921 def _HtmlBlockCloseH4; end # HtmlBlockCloseH5 = "<" Spnl "/" ("h5" | "H5") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#5077 + # source://rdoc//lib/rdoc/markdown.rb#5087 def _HtmlBlockCloseH5; end # HtmlBlockCloseH6 = "<" Spnl "/" ("h6" | "H6") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#5243 + # source://rdoc//lib/rdoc/markdown.rb#5253 def _HtmlBlockCloseH6; end # HtmlBlockCloseHead = "<" Spnl "/" ("head" | "HEAD") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#8552 + # source://rdoc//lib/rdoc/markdown.rb#8562 def _HtmlBlockCloseHead; end # HtmlBlockCloseLi = "<" Spnl "/" ("li" | "LI") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#7235 + # source://rdoc//lib/rdoc/markdown.rb#7245 def _HtmlBlockCloseLi; end # HtmlBlockCloseMenu = "<" Spnl "/" ("menu" | "MENU") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#5409 + # source://rdoc//lib/rdoc/markdown.rb#5419 def _HtmlBlockCloseMenu; end # HtmlBlockCloseNoframes = "<" Spnl "/" ("noframes" | "NOFRAMES") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#5575 + # source://rdoc//lib/rdoc/markdown.rb#5585 def _HtmlBlockCloseNoframes; end # HtmlBlockCloseNoscript = "<" Spnl "/" ("noscript" | "NOSCRIPT") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#5741 + # source://rdoc//lib/rdoc/markdown.rb#5751 def _HtmlBlockCloseNoscript; end # HtmlBlockCloseOl = "<" Spnl "/" ("ol" | "OL") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#5907 + # source://rdoc//lib/rdoc/markdown.rb#5917 def _HtmlBlockCloseOl; end # HtmlBlockCloseP = "<" Spnl "/" ("p" | "P") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#6073 + # source://rdoc//lib/rdoc/markdown.rb#6083 def _HtmlBlockCloseP; end # HtmlBlockClosePre = "<" Spnl "/" ("pre" | "PRE") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#6239 + # source://rdoc//lib/rdoc/markdown.rb#6249 def _HtmlBlockClosePre; end # HtmlBlockCloseScript = "<" Spnl "/" ("script" | "SCRIPT") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#8397 + # source://rdoc//lib/rdoc/markdown.rb#8407 def _HtmlBlockCloseScript; end # HtmlBlockCloseTable = "<" Spnl "/" ("table" | "TABLE") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#6405 + # source://rdoc//lib/rdoc/markdown.rb#6415 def _HtmlBlockCloseTable; end # HtmlBlockCloseTbody = "<" Spnl "/" ("tbody" | "TBODY") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#7401 + # source://rdoc//lib/rdoc/markdown.rb#7411 def _HtmlBlockCloseTbody; end # HtmlBlockCloseTd = "<" Spnl "/" ("td" | "TD") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#7567 + # source://rdoc//lib/rdoc/markdown.rb#7577 def _HtmlBlockCloseTd; end # HtmlBlockCloseTfoot = "<" Spnl "/" ("tfoot" | "TFOOT") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#7733 + # source://rdoc//lib/rdoc/markdown.rb#7743 def _HtmlBlockCloseTfoot; end # HtmlBlockCloseTh = "<" Spnl "/" ("th" | "TH") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#7899 + # source://rdoc//lib/rdoc/markdown.rb#7909 def _HtmlBlockCloseTh; end # HtmlBlockCloseThead = "<" Spnl "/" ("thead" | "THEAD") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#8065 + # source://rdoc//lib/rdoc/markdown.rb#8075 def _HtmlBlockCloseThead; end # HtmlBlockCloseTr = "<" Spnl "/" ("tr" | "TR") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#8231 + # source://rdoc//lib/rdoc/markdown.rb#8241 def _HtmlBlockCloseTr; end # HtmlBlockCloseUl = "<" Spnl "/" ("ul" | "UL") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#6571 + # source://rdoc//lib/rdoc/markdown.rb#6581 def _HtmlBlockCloseUl; end # HtmlBlockDd = HtmlBlockOpenDd (HtmlBlockDd | !HtmlBlockCloseDd .)* HtmlBlockCloseDd # - # source://rdoc//lib/rdoc/markdown.rb#6789 + # source://rdoc//lib/rdoc/markdown.rb#6799 def _HtmlBlockDd; end # HtmlBlockDir = HtmlBlockOpenDir (HtmlBlockDir | !HtmlBlockCloseDir .)* HtmlBlockCloseDir # - # source://rdoc//lib/rdoc/markdown.rb#3635 + # source://rdoc//lib/rdoc/markdown.rb#3645 def _HtmlBlockDir; end # HtmlBlockDiv = HtmlBlockOpenDiv (HtmlBlockDiv | !HtmlBlockCloseDiv .)* HtmlBlockCloseDiv # - # source://rdoc//lib/rdoc/markdown.rb#3801 + # source://rdoc//lib/rdoc/markdown.rb#3811 def _HtmlBlockDiv; end # HtmlBlockDl = HtmlBlockOpenDl (HtmlBlockDl | !HtmlBlockCloseDl .)* HtmlBlockCloseDl # - # source://rdoc//lib/rdoc/markdown.rb#3967 + # source://rdoc//lib/rdoc/markdown.rb#3977 def _HtmlBlockDl; end # HtmlBlockDt = HtmlBlockOpenDt (HtmlBlockDt | !HtmlBlockCloseDt .)* HtmlBlockCloseDt # - # source://rdoc//lib/rdoc/markdown.rb#6955 + # source://rdoc//lib/rdoc/markdown.rb#6965 def _HtmlBlockDt; end # HtmlBlockFieldset = HtmlBlockOpenFieldset (HtmlBlockFieldset | !HtmlBlockCloseFieldset .)* HtmlBlockCloseFieldset # - # source://rdoc//lib/rdoc/markdown.rb#4133 + # source://rdoc//lib/rdoc/markdown.rb#4143 def _HtmlBlockFieldset; end # HtmlBlockForm = HtmlBlockOpenForm (HtmlBlockForm | !HtmlBlockCloseForm .)* HtmlBlockCloseForm # - # source://rdoc//lib/rdoc/markdown.rb#4299 + # source://rdoc//lib/rdoc/markdown.rb#4309 def _HtmlBlockForm; end # HtmlBlockFrameset = HtmlBlockOpenFrameset (HtmlBlockFrameset | !HtmlBlockCloseFrameset .)* HtmlBlockCloseFrameset # - # source://rdoc//lib/rdoc/markdown.rb#7121 + # source://rdoc//lib/rdoc/markdown.rb#7131 def _HtmlBlockFrameset; end # HtmlBlockH1 = HtmlBlockOpenH1 (HtmlBlockH1 | !HtmlBlockCloseH1 .)* HtmlBlockCloseH1 # - # source://rdoc//lib/rdoc/markdown.rb#4465 + # source://rdoc//lib/rdoc/markdown.rb#4475 def _HtmlBlockH1; end # HtmlBlockH2 = HtmlBlockOpenH2 (HtmlBlockH2 | !HtmlBlockCloseH2 .)* HtmlBlockCloseH2 # - # source://rdoc//lib/rdoc/markdown.rb#4631 + # source://rdoc//lib/rdoc/markdown.rb#4641 def _HtmlBlockH2; end # HtmlBlockH3 = HtmlBlockOpenH3 (HtmlBlockH3 | !HtmlBlockCloseH3 .)* HtmlBlockCloseH3 # - # source://rdoc//lib/rdoc/markdown.rb#4797 + # source://rdoc//lib/rdoc/markdown.rb#4807 def _HtmlBlockH3; end # HtmlBlockH4 = HtmlBlockOpenH4 (HtmlBlockH4 | !HtmlBlockCloseH4 .)* HtmlBlockCloseH4 # - # source://rdoc//lib/rdoc/markdown.rb#4963 + # source://rdoc//lib/rdoc/markdown.rb#4973 def _HtmlBlockH4; end # HtmlBlockH5 = HtmlBlockOpenH5 (HtmlBlockH5 | !HtmlBlockCloseH5 .)* HtmlBlockCloseH5 # - # source://rdoc//lib/rdoc/markdown.rb#5129 + # source://rdoc//lib/rdoc/markdown.rb#5139 def _HtmlBlockH5; end # HtmlBlockH6 = HtmlBlockOpenH6 (HtmlBlockH6 | !HtmlBlockCloseH6 .)* HtmlBlockCloseH6 # - # source://rdoc//lib/rdoc/markdown.rb#5295 + # source://rdoc//lib/rdoc/markdown.rb#5305 def _HtmlBlockH6; end # HtmlBlockHead = HtmlBlockOpenHead (!HtmlBlockCloseHead .)* HtmlBlockCloseHead # - # source://rdoc//lib/rdoc/markdown.rb#8604 + # source://rdoc//lib/rdoc/markdown.rb#8614 def _HtmlBlockHead; end # HtmlBlockInTags = (HtmlAnchor | HtmlBlockAddress | HtmlBlockBlockquote | HtmlBlockCenter | HtmlBlockDir | HtmlBlockDiv | HtmlBlockDl | HtmlBlockFieldset | HtmlBlockForm | HtmlBlockH1 | HtmlBlockH2 | HtmlBlockH3 | HtmlBlockH4 | HtmlBlockH5 | HtmlBlockH6 | HtmlBlockMenu | HtmlBlockNoframes | HtmlBlockNoscript | HtmlBlockOl | HtmlBlockP | HtmlBlockPre | HtmlBlockTable | HtmlBlockUl | HtmlBlockDd | HtmlBlockDt | HtmlBlockFrameset | HtmlBlockLi | HtmlBlockTbody | HtmlBlockTd | HtmlBlockTfoot | HtmlBlockTh | HtmlBlockThead | HtmlBlockTr | HtmlBlockScript | HtmlBlockHead) # - # source://rdoc//lib/rdoc/markdown.rb#8651 + # source://rdoc//lib/rdoc/markdown.rb#8661 def _HtmlBlockInTags; end # HtmlBlockLi = HtmlBlockOpenLi (HtmlBlockLi | !HtmlBlockCloseLi .)* HtmlBlockCloseLi # - # source://rdoc//lib/rdoc/markdown.rb#7287 + # source://rdoc//lib/rdoc/markdown.rb#7297 def _HtmlBlockLi; end # HtmlBlockMenu = HtmlBlockOpenMenu (HtmlBlockMenu | !HtmlBlockCloseMenu .)* HtmlBlockCloseMenu # - # source://rdoc//lib/rdoc/markdown.rb#5461 + # source://rdoc//lib/rdoc/markdown.rb#5471 def _HtmlBlockMenu; end # HtmlBlockNoframes = HtmlBlockOpenNoframes (HtmlBlockNoframes | !HtmlBlockCloseNoframes .)* HtmlBlockCloseNoframes # - # source://rdoc//lib/rdoc/markdown.rb#5627 + # source://rdoc//lib/rdoc/markdown.rb#5637 def _HtmlBlockNoframes; end # HtmlBlockNoscript = HtmlBlockOpenNoscript (HtmlBlockNoscript | !HtmlBlockCloseNoscript .)* HtmlBlockCloseNoscript # - # source://rdoc//lib/rdoc/markdown.rb#5793 + # source://rdoc//lib/rdoc/markdown.rb#5803 def _HtmlBlockNoscript; end # HtmlBlockOl = HtmlBlockOpenOl (HtmlBlockOl | !HtmlBlockCloseOl .)* HtmlBlockCloseOl # - # source://rdoc//lib/rdoc/markdown.rb#5959 + # source://rdoc//lib/rdoc/markdown.rb#5969 def _HtmlBlockOl; end # HtmlBlockOpenAddress = "<" Spnl ("address" | "ADDRESS") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#3029 + # source://rdoc//lib/rdoc/markdown.rb#3039 def _HtmlBlockOpenAddress; end # HtmlBlockOpenBlockquote = "<" Spnl ("blockquote" | "BLOCKQUOTE") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#3195 + # source://rdoc//lib/rdoc/markdown.rb#3205 def _HtmlBlockOpenBlockquote; end # HtmlBlockOpenCenter = "<" Spnl ("center" | "CENTER") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#3361 + # source://rdoc//lib/rdoc/markdown.rb#3371 def _HtmlBlockOpenCenter; end # HtmlBlockOpenDd = "<" Spnl ("dd" | "DD") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#6681 + # source://rdoc//lib/rdoc/markdown.rb#6691 def _HtmlBlockOpenDd; end # HtmlBlockOpenDir = "<" Spnl ("dir" | "DIR") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#3527 + # source://rdoc//lib/rdoc/markdown.rb#3537 def _HtmlBlockOpenDir; end # HtmlBlockOpenDiv = "<" Spnl ("div" | "DIV") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#3693 + # source://rdoc//lib/rdoc/markdown.rb#3703 def _HtmlBlockOpenDiv; end # HtmlBlockOpenDl = "<" Spnl ("dl" | "DL") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#3859 + # source://rdoc//lib/rdoc/markdown.rb#3869 def _HtmlBlockOpenDl; end # HtmlBlockOpenDt = "<" Spnl ("dt" | "DT") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#6847 + # source://rdoc//lib/rdoc/markdown.rb#6857 def _HtmlBlockOpenDt; end # HtmlBlockOpenFieldset = "<" Spnl ("fieldset" | "FIELDSET") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#4025 + # source://rdoc//lib/rdoc/markdown.rb#4035 def _HtmlBlockOpenFieldset; end # HtmlBlockOpenForm = "<" Spnl ("form" | "FORM") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#4191 + # source://rdoc//lib/rdoc/markdown.rb#4201 def _HtmlBlockOpenForm; end # HtmlBlockOpenFrameset = "<" Spnl ("frameset" | "FRAMESET") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#7013 + # source://rdoc//lib/rdoc/markdown.rb#7023 def _HtmlBlockOpenFrameset; end # HtmlBlockOpenH1 = "<" Spnl ("h1" | "H1") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#4357 + # source://rdoc//lib/rdoc/markdown.rb#4367 def _HtmlBlockOpenH1; end # HtmlBlockOpenH2 = "<" Spnl ("h2" | "H2") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#4523 + # source://rdoc//lib/rdoc/markdown.rb#4533 def _HtmlBlockOpenH2; end # HtmlBlockOpenH3 = "<" Spnl ("h3" | "H3") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#4689 + # source://rdoc//lib/rdoc/markdown.rb#4699 def _HtmlBlockOpenH3; end # HtmlBlockOpenH4 = "<" Spnl ("h4" | "H4") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#4855 + # source://rdoc//lib/rdoc/markdown.rb#4865 def _HtmlBlockOpenH4; end # HtmlBlockOpenH5 = "<" Spnl ("h5" | "H5") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#5021 + # source://rdoc//lib/rdoc/markdown.rb#5031 def _HtmlBlockOpenH5; end # HtmlBlockOpenH6 = "<" Spnl ("h6" | "H6") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#5187 + # source://rdoc//lib/rdoc/markdown.rb#5197 def _HtmlBlockOpenH6; end # HtmlBlockOpenHead = "<" Spnl ("head" | "HEAD") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#8496 + # source://rdoc//lib/rdoc/markdown.rb#8506 def _HtmlBlockOpenHead; end # HtmlBlockOpenLi = "<" Spnl ("li" | "LI") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#7179 + # source://rdoc//lib/rdoc/markdown.rb#7189 def _HtmlBlockOpenLi; end # HtmlBlockOpenMenu = "<" Spnl ("menu" | "MENU") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#5353 + # source://rdoc//lib/rdoc/markdown.rb#5363 def _HtmlBlockOpenMenu; end # HtmlBlockOpenNoframes = "<" Spnl ("noframes" | "NOFRAMES") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#5519 + # source://rdoc//lib/rdoc/markdown.rb#5529 def _HtmlBlockOpenNoframes; end # HtmlBlockOpenNoscript = "<" Spnl ("noscript" | "NOSCRIPT") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#5685 + # source://rdoc//lib/rdoc/markdown.rb#5695 def _HtmlBlockOpenNoscript; end # HtmlBlockOpenOl = "<" Spnl ("ol" | "OL") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#5851 + # source://rdoc//lib/rdoc/markdown.rb#5861 def _HtmlBlockOpenOl; end # HtmlBlockOpenP = "<" Spnl ("p" | "P") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#6017 + # source://rdoc//lib/rdoc/markdown.rb#6027 def _HtmlBlockOpenP; end # HtmlBlockOpenPre = "<" Spnl ("pre" | "PRE") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#6183 + # source://rdoc//lib/rdoc/markdown.rb#6193 def _HtmlBlockOpenPre; end # HtmlBlockOpenScript = "<" Spnl ("script" | "SCRIPT") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#8341 + # source://rdoc//lib/rdoc/markdown.rb#8351 def _HtmlBlockOpenScript; end # HtmlBlockOpenTable = "<" Spnl ("table" | "TABLE") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#6349 + # source://rdoc//lib/rdoc/markdown.rb#6359 def _HtmlBlockOpenTable; end # HtmlBlockOpenTbody = "<" Spnl ("tbody" | "TBODY") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#7345 + # source://rdoc//lib/rdoc/markdown.rb#7355 def _HtmlBlockOpenTbody; end # HtmlBlockOpenTd = "<" Spnl ("td" | "TD") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#7511 + # source://rdoc//lib/rdoc/markdown.rb#7521 def _HtmlBlockOpenTd; end # HtmlBlockOpenTfoot = "<" Spnl ("tfoot" | "TFOOT") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#7677 + # source://rdoc//lib/rdoc/markdown.rb#7687 def _HtmlBlockOpenTfoot; end # HtmlBlockOpenTh = "<" Spnl ("th" | "TH") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#7843 + # source://rdoc//lib/rdoc/markdown.rb#7853 def _HtmlBlockOpenTh; end # HtmlBlockOpenThead = "<" Spnl ("thead" | "THEAD") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#8009 + # source://rdoc//lib/rdoc/markdown.rb#8019 def _HtmlBlockOpenThead; end # HtmlBlockOpenTr = "<" Spnl ("tr" | "TR") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#8175 + # source://rdoc//lib/rdoc/markdown.rb#8185 def _HtmlBlockOpenTr; end # HtmlBlockOpenUl = "<" Spnl ("ul" | "UL") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#6515 + # source://rdoc//lib/rdoc/markdown.rb#6525 def _HtmlBlockOpenUl; end # HtmlBlockP = HtmlBlockOpenP (HtmlBlockP | !HtmlBlockCloseP .)* HtmlBlockCloseP # - # source://rdoc//lib/rdoc/markdown.rb#6125 + # source://rdoc//lib/rdoc/markdown.rb#6135 def _HtmlBlockP; end # HtmlBlockPre = HtmlBlockOpenPre (HtmlBlockPre | !HtmlBlockClosePre .)* HtmlBlockClosePre # - # source://rdoc//lib/rdoc/markdown.rb#6291 + # source://rdoc//lib/rdoc/markdown.rb#6301 def _HtmlBlockPre; end # HtmlBlockScript = HtmlBlockOpenScript (!HtmlBlockCloseScript .)* HtmlBlockCloseScript # - # source://rdoc//lib/rdoc/markdown.rb#8449 + # source://rdoc//lib/rdoc/markdown.rb#8459 def _HtmlBlockScript; end # HtmlBlockSelfClosing = "<" Spnl HtmlBlockType Spnl HtmlAttribute* "/" Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#8896 + # source://rdoc//lib/rdoc/markdown.rb#8906 def _HtmlBlockSelfClosing; end # HtmlBlockTable = HtmlBlockOpenTable (HtmlBlockTable | !HtmlBlockCloseTable .)* HtmlBlockCloseTable # - # source://rdoc//lib/rdoc/markdown.rb#6457 + # source://rdoc//lib/rdoc/markdown.rb#6467 def _HtmlBlockTable; end # HtmlBlockTbody = HtmlBlockOpenTbody (HtmlBlockTbody | !HtmlBlockCloseTbody .)* HtmlBlockCloseTbody # - # source://rdoc//lib/rdoc/markdown.rb#7453 + # source://rdoc//lib/rdoc/markdown.rb#7463 def _HtmlBlockTbody; end # HtmlBlockTd = HtmlBlockOpenTd (HtmlBlockTd | !HtmlBlockCloseTd .)* HtmlBlockCloseTd # - # source://rdoc//lib/rdoc/markdown.rb#7619 + # source://rdoc//lib/rdoc/markdown.rb#7629 def _HtmlBlockTd; end # HtmlBlockTfoot = HtmlBlockOpenTfoot (HtmlBlockTfoot | !HtmlBlockCloseTfoot .)* HtmlBlockCloseTfoot # - # source://rdoc//lib/rdoc/markdown.rb#7785 + # source://rdoc//lib/rdoc/markdown.rb#7795 def _HtmlBlockTfoot; end # HtmlBlockTh = HtmlBlockOpenTh (HtmlBlockTh | !HtmlBlockCloseTh .)* HtmlBlockCloseTh # - # source://rdoc//lib/rdoc/markdown.rb#7951 + # source://rdoc//lib/rdoc/markdown.rb#7961 def _HtmlBlockTh; end # HtmlBlockThead = HtmlBlockOpenThead (HtmlBlockThead | !HtmlBlockCloseThead .)* HtmlBlockCloseThead # - # source://rdoc//lib/rdoc/markdown.rb#8117 + # source://rdoc//lib/rdoc/markdown.rb#8127 def _HtmlBlockThead; end # HtmlBlockTr = HtmlBlockOpenTr (HtmlBlockTr | !HtmlBlockCloseTr .)* HtmlBlockCloseTr # - # source://rdoc//lib/rdoc/markdown.rb#8283 + # source://rdoc//lib/rdoc/markdown.rb#8293 def _HtmlBlockTr; end # HtmlBlockType = ("ADDRESS" | "BLOCKQUOTE" | "CENTER" | "DD" | "DIR" | "DIV" | "DL" | "DT" | "FIELDSET" | "FORM" | "FRAMESET" | "H1" | "H2" | "H3" | "H4" | "H5" | "H6" | "HR" | "ISINDEX" | "LI" | "MENU" | "NOFRAMES" | "NOSCRIPT" | "OL" | "P" | "PRE" | "SCRIPT" | "TABLE" | "TBODY" | "TD" | "TFOOT" | "TH" | "THEAD" | "TR" | "UL" | "address" | "blockquote" | "center" | "dd" | "dir" | "div" | "dl" | "dt" | "fieldset" | "form" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "hr" | "isindex" | "li" | "menu" | "noframes" | "noscript" | "ol" | "p" | "pre" | "script" | "table" | "tbody" | "td" | "tfoot" | "th" | "thead" | "tr" | "ul") # - # source://rdoc//lib/rdoc/markdown.rb#8951 + # source://rdoc//lib/rdoc/markdown.rb#8961 def _HtmlBlockType; end # HtmlBlockUl = HtmlBlockOpenUl (HtmlBlockUl | !HtmlBlockCloseUl .)* HtmlBlockCloseUl # - # source://rdoc//lib/rdoc/markdown.rb#6623 + # source://rdoc//lib/rdoc/markdown.rb#6633 def _HtmlBlockUl; end # HtmlCloseAnchor = "<" Spnl "/" ("a" | "A") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#2919 + # source://rdoc//lib/rdoc/markdown.rb#2929 def _HtmlCloseAnchor; end # HtmlComment = "" .)* "-->" # - # source://rdoc//lib/rdoc/markdown.rb#14415 + # source://rdoc//lib/rdoc/markdown.rb#14437 def _HtmlComment; end # HtmlOpenAnchor = "<" Spnl ("a" | "A") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#2863 + # source://rdoc//lib/rdoc/markdown.rb#2873 def _HtmlOpenAnchor; end # HtmlTag = "<" Spnl "/"? AlphanumericAscii+ Spnl HtmlAttribute* "/"? Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#14462 + # source://rdoc//lib/rdoc/markdown.rb#14484 def _HtmlTag; end # HtmlUnclosed = "<" Spnl HtmlUnclosedType Spnl HtmlAttribute* Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#8828 + # source://rdoc//lib/rdoc/markdown.rb#8838 def _HtmlUnclosed; end # HtmlUnclosedType = ("HR" | "hr") # - # source://rdoc//lib/rdoc/markdown.rb#8878 + # source://rdoc//lib/rdoc/markdown.rb#8888 def _HtmlUnclosedType; end - # Image = "!" (ExplicitLink | ReferenceLink):a { "rdoc-image:#{a[/\[(.*)\]/, 1]}" } + # Image = "!" ExplicitLinkWithLabel:a { "rdoc-image:#{a[:link]}:#{a[:label]}" } # - # source://rdoc//lib/rdoc/markdown.rb#10972 + # source://rdoc//lib/rdoc/markdown.rb#10982 def _Image; end # InStyleTags = StyleOpen (!StyleClose .)* StyleClose # - # source://rdoc//lib/rdoc/markdown.rb#9281 + # source://rdoc//lib/rdoc/markdown.rb#9291 def _InStyleTags; end # Indent = /\t| / # - # source://rdoc//lib/rdoc/markdown.rb#14860 + # source://rdoc//lib/rdoc/markdown.rb#14882 def _Indent; end # IndentedLine = Indent Line # - # source://rdoc//lib/rdoc/markdown.rb#14867 + # source://rdoc//lib/rdoc/markdown.rb#14889 def _IndentedLine; end # Inline = (Str | @Endline | UlOrStarLine | @Space | Strong | Emph | Strike | Image | Link | NoteReference | InlineNote | Code | RawHtml | Entity | EscapedChar | Symbol) # - # source://rdoc//lib/rdoc/markdown.rb#9586 + # source://rdoc//lib/rdoc/markdown.rb#9596 def _Inline; end # InlineNote = &{ notes? } "^[" @StartList:a (!"]" Inline:l { a << l })+ "]" { ref = [:inline, @note_order.length] @footnotes[ref] = paragraph a note_for ref } # - # source://rdoc//lib/rdoc/markdown.rb#15431 + # source://rdoc//lib/rdoc/markdown.rb#15453 def _InlineNote; end # Inlines = (!@Endline Inline:i { i } | @Endline:c !(&{ github? } Ticks3 /[^`\n]*$/) &Inline { c })+:chunks @Endline? { chunks } # - # source://rdoc//lib/rdoc/markdown.rb#9365 + # source://rdoc//lib/rdoc/markdown.rb#9375 def _Inlines; end # Label = "[" (!"^" &{ notes? } | &. &{ !notes? }) @StartList:a (!"]" Inline:l { a << l })* "]" { a.join.gsub(/\s+/, ' ') } # - # source://rdoc//lib/rdoc/markdown.rb#11907 + # source://rdoc//lib/rdoc/markdown.rb#11929 def _Label; end # Line = @RawLine:a { a } # - # source://rdoc//lib/rdoc/markdown.rb#14938 + # source://rdoc//lib/rdoc/markdown.rb#14960 def _Line; end # LineBreak = " " @NormalEndline { RDoc::Markup::HardBreak.new } # - # source://rdoc//lib/rdoc/markdown.rb#10042 + # source://rdoc//lib/rdoc/markdown.rb#10052 def _LineBreak; end # Link = (ExplicitLink | ReferenceLink | AutoLink) # - # source://rdoc//lib/rdoc/markdown.rb#11011 + # source://rdoc//lib/rdoc/markdown.rb#11010 def _Link; end # ListBlock = !@BlankLine Line:a ListBlockLine*:c { [a, *c] } # - # source://rdoc//lib/rdoc/markdown.rb#2548 + # source://rdoc//lib/rdoc/markdown.rb#2558 def _ListBlock; end # ListBlockLine = !@BlankLine !(Indent? (Bullet | Enumerator)) !HorizontalRule OptionallyIndentedLine # - # source://rdoc//lib/rdoc/markdown.rb#2793 + # source://rdoc//lib/rdoc/markdown.rb#2803 def _ListBlockLine; end # ListContinuationBlock = @StartList:a @BlankLine* { a << "\n" } (Indent ListBlock:b { a.concat b })+ { a } # - # source://rdoc//lib/rdoc/markdown.rb#2592 + # source://rdoc//lib/rdoc/markdown.rb#2602 def _ListContinuationBlock; end # ListItem = (Bullet | Enumerator) @StartList:a ListBlock:b { a << b } (ListContinuationBlock:c { a.push(*c) })* { list_item_from a } # - # source://rdoc//lib/rdoc/markdown.rb#2392 + # source://rdoc//lib/rdoc/markdown.rb#2402 def _ListItem; end # ListItemTight = (Bullet | Enumerator) ListBlock:a (!@BlankLine ListContinuationBlock:b { a.push(*b) })* !ListContinuationBlock { list_item_from a } # - # source://rdoc//lib/rdoc/markdown.rb#2468 + # source://rdoc//lib/rdoc/markdown.rb#2478 def _ListItemTight; end # ListLoose = @StartList:a (ListItem:b @BlankLine* { a << b })+ { a } # - # source://rdoc//lib/rdoc/markdown.rb#2304 + # source://rdoc//lib/rdoc/markdown.rb#2314 def _ListLoose; end # ListTight = ListItemTight+:a @BlankLine* !(Bullet | Enumerator) { a } # - # source://rdoc//lib/rdoc/markdown.rb#2239 + # source://rdoc//lib/rdoc/markdown.rb#2249 def _ListTight; end # Newline = %literals.Newline # - # source://rdoc//lib/rdoc/markdown.rb#14726 + # source://rdoc//lib/rdoc/markdown.rb#14748 def _Newline; end # NonblankIndentedLine = !@BlankLine IndentedLine # - # source://rdoc//lib/rdoc/markdown.rb#1821 + # source://rdoc//lib/rdoc/markdown.rb#1831 def _NonblankIndentedLine; end # NonindentSpace = / {0,3}/ # - # source://rdoc//lib/rdoc/markdown.rb#14853 + # source://rdoc//lib/rdoc/markdown.rb#14875 def _NonindentSpace; end # Nonspacechar = !@Spacechar !@Newline . # - # source://rdoc//lib/rdoc/markdown.rb#14552 + # source://rdoc//lib/rdoc/markdown.rb#14574 def _Nonspacechar; end # NormalChar = !(@SpecialChar | @Spacechar | @Newline) . # - # source://rdoc//lib/rdoc/markdown.rb#14653 + # source://rdoc//lib/rdoc/markdown.rb#14675 def _NormalChar; end # NormalEndline = @Sp @Newline !@BlankLine !">" !AtxStart !(Line /={1,}|-{1,}/ @Newline) { "\n" } # - # source://rdoc//lib/rdoc/markdown.rb#9938 + # source://rdoc//lib/rdoc/markdown.rb#9948 def _NormalEndline; end # Note = &{ notes? } @NonindentSpace RawNoteReference:ref ":" @Sp @StartList:a RawNoteBlock:i { a.concat i } (&Indent RawNoteBlock:i { a.concat i })* { @footnotes[ref] = paragraph a nil } # - # source://rdoc//lib/rdoc/markdown.rb#15333 + # source://rdoc//lib/rdoc/markdown.rb#15355 def _Note; end # NoteReference = &{ notes? } RawNoteReference:ref { note_for ref } # - # source://rdoc//lib/rdoc/markdown.rb#15207 + # source://rdoc//lib/rdoc/markdown.rb#15229 def _NoteReference; end # Notes = (Note | SkipBlock)* # - # source://rdoc//lib/rdoc/markdown.rb#15538 + # source://rdoc//lib/rdoc/markdown.rb#15560 def _Notes; end # OptionallyIndentedLine = Indent? Line # - # source://rdoc//lib/rdoc/markdown.rb#14888 + # source://rdoc//lib/rdoc/markdown.rb#14910 def _OptionallyIndentedLine; end # OrderedList = &Enumerator (ListTight | ListLoose):a { RDoc::Markup::List.new(:NUMBER, *a) } # - # source://rdoc//lib/rdoc/markdown.rb#2752 + # source://rdoc//lib/rdoc/markdown.rb#2762 def _OrderedList; end # Para = @NonindentSpace Inlines:a @BlankLine+ { paragraph a } @@ -3788,312 +3758,312 @@ class RDoc::Markdown # Quoted = ("\"" (!"\"" .)* "\"" | "'" (!"'" .)* "'") # - # source://rdoc//lib/rdoc/markdown.rb#14175 + # source://rdoc//lib/rdoc/markdown.rb#14197 def _Quoted; end # RawHtml = < (HtmlComment | HtmlBlockScript | HtmlTag) > { if html? then text else '' end } # - # source://rdoc//lib/rdoc/markdown.rb#14108 + # source://rdoc//lib/rdoc/markdown.rb#14130 def _RawHtml; end # RawLine = (< /[^\r\n]*/ @Newline > | < .+ > @Eof) { text } # - # source://rdoc//lib/rdoc/markdown.rb#14961 + # source://rdoc//lib/rdoc/markdown.rb#14983 def _RawLine; end # RawNoteBlock = @StartList:a (!@BlankLine !RawNoteReference OptionallyIndentedLine:l { a << l })+ < @BlankLine* > { a << text } { a } # - # source://rdoc//lib/rdoc/markdown.rb#15560 + # source://rdoc//lib/rdoc/markdown.rb#15582 def _RawNoteBlock; end # RawNoteReference = "[^" < (!@Newline !"]" .)+ > "]" { text } # - # source://rdoc//lib/rdoc/markdown.rb#15237 + # source://rdoc//lib/rdoc/markdown.rb#15259 def _RawNoteReference; end # RefSrc = < Nonspacechar+ > { text } # - # source://rdoc//lib/rdoc/markdown.rb#12026 + # source://rdoc//lib/rdoc/markdown.rb#12048 def _RefSrc; end # RefTitle = (RefTitleSingle | RefTitleDouble | RefTitleParens | EmptyTitle) # - # source://rdoc//lib/rdoc/markdown.rb#12062 + # source://rdoc//lib/rdoc/markdown.rb#12084 def _RefTitle; end # RefTitleDouble = Spnl "\"" < (!("\"" @Sp @Newline | @Newline) .)* > "\"" { text } # - # source://rdoc//lib/rdoc/markdown.rb#12185 + # source://rdoc//lib/rdoc/markdown.rb#12207 def _RefTitleDouble; end # RefTitleParens = Spnl "(" < (!(")" @Sp @Newline | @Newline) .)* > ")" { text } # - # source://rdoc//lib/rdoc/markdown.rb#12277 + # source://rdoc//lib/rdoc/markdown.rb#12299 def _RefTitleParens; end # RefTitleSingle = Spnl "'" < (!("'" @Sp @Newline | @Newline) .)* > "'" { text } # - # source://rdoc//lib/rdoc/markdown.rb#12093 + # source://rdoc//lib/rdoc/markdown.rb#12115 def _RefTitleSingle; end # Reference = @NonindentSpace !"[]" Label:label ":" Spnl RefSrc:link RefTitle @BlankLine+ { # TODO use title reference label, link nil } # - # source://rdoc//lib/rdoc/markdown.rb#11832 + # source://rdoc//lib/rdoc/markdown.rb#11854 def _Reference; end # ReferenceLink = (ReferenceLinkDouble | ReferenceLinkSingle) # - # source://rdoc//lib/rdoc/markdown.rb#11032 + # source://rdoc//lib/rdoc/markdown.rb#11031 def _ReferenceLink; end # ReferenceLinkDouble = Label:content < Spnl > !"[]" Label:label { link_to content, label, text } # - # source://rdoc//lib/rdoc/markdown.rb#11050 + # source://rdoc//lib/rdoc/markdown.rb#11049 def _ReferenceLinkDouble; end # ReferenceLinkSingle = Label:content < (Spnl "[]")? > { link_to content, content, text } # - # source://rdoc//lib/rdoc/markdown.rb#11096 + # source://rdoc//lib/rdoc/markdown.rb#11095 def _ReferenceLinkSingle; end # References = (Reference | SkipBlock)* # - # source://rdoc//lib/rdoc/markdown.rb#12369 + # source://rdoc//lib/rdoc/markdown.rb#12391 def _References; end # SetextBottom1 = /={1,}/ @Newline # - # source://rdoc//lib/rdoc/markdown.rb#1262 + # source://rdoc//lib/rdoc/markdown.rb#1272 def _SetextBottom1; end # SetextBottom2 = /-{1,}/ @Newline # - # source://rdoc//lib/rdoc/markdown.rb#1283 + # source://rdoc//lib/rdoc/markdown.rb#1293 def _SetextBottom2; end # SetextHeading = (SetextHeading1 | SetextHeading2) # - # source://rdoc//lib/rdoc/markdown.rb#1244 + # source://rdoc//lib/rdoc/markdown.rb#1254 def _SetextHeading; end # SetextHeading1 = &(@RawLine SetextBottom1) @StartList:a (!@Endline Inline:b { a << b })+ @Sp @Newline SetextBottom1 { RDoc::Markup::Heading.new(1, a.join) } # - # source://rdoc//lib/rdoc/markdown.rb#1304 + # source://rdoc//lib/rdoc/markdown.rb#1314 def _SetextHeading1; end # SetextHeading2 = &(@RawLine SetextBottom2) @StartList:a (!@Endline Inline:b { a << b })+ @Sp @Newline SetextBottom2 { RDoc::Markup::Heading.new(2, a.join) } # - # source://rdoc//lib/rdoc/markdown.rb#1426 + # source://rdoc//lib/rdoc/markdown.rb#1436 def _SetextHeading2; end # SkipBlock = (HtmlBlock | (!"#" !SetextBottom1 !SetextBottom2 !@BlankLine @RawLine)+ @BlankLine* | @BlankLine+ | @RawLine) # - # source://rdoc//lib/rdoc/markdown.rb#15040 + # source://rdoc//lib/rdoc/markdown.rb#15062 def _SkipBlock; end # Source = ("<" < SourceContents > ">" | < SourceContents >) { text } # - # source://rdoc//lib/rdoc/markdown.rb#11206 + # source://rdoc//lib/rdoc/markdown.rb#11228 def _Source; end # SourceContents = ((!"(" !")" !">" Nonspacechar)+ | "(" SourceContents ")")* # - # source://rdoc//lib/rdoc/markdown.rb#11266 + # source://rdoc//lib/rdoc/markdown.rb#11288 def _SourceContents; end # Sp = @Spacechar* # - # source://rdoc//lib/rdoc/markdown.rb#14584 + # source://rdoc//lib/rdoc/markdown.rb#14606 def _Sp; end # Space = @Spacechar+ { " " } # - # source://rdoc//lib/rdoc/markdown.rb#9646 + # source://rdoc//lib/rdoc/markdown.rb#9656 def _Space; end # Spacechar = %literals.Spacechar # - # source://rdoc//lib/rdoc/markdown.rb#14733 + # source://rdoc//lib/rdoc/markdown.rb#14755 def _Spacechar; end # SpecialChar = (/[~*_`&\[\]() { text } | < @Spacechar /\*+/ &@Spacechar > { text }) # - # source://rdoc//lib/rdoc/markdown.rb#10129 + # source://rdoc//lib/rdoc/markdown.rb#10139 def _StarLine; end # StartList = &. { [] } # - # source://rdoc//lib/rdoc/markdown.rb#14914 + # source://rdoc//lib/rdoc/markdown.rb#14936 def _StartList; end # Str = @StartList:a < @NormalChar+ > { a = text } (StrChunk:c { a << c })* { a } # - # source://rdoc//lib/rdoc/markdown.rb#9678 + # source://rdoc//lib/rdoc/markdown.rb#9688 def _Str; end # StrChunk = < (@NormalChar | /_+/ &Alphanumeric)+ > { text } # - # source://rdoc//lib/rdoc/markdown.rb#9751 + # source://rdoc//lib/rdoc/markdown.rb#9761 def _StrChunk; end # Strike = &{ strike? } "~~" !@Whitespace @StartList:a (!"~~" Inline:b { a << b })+ "~~" { strike a.join } # - # source://rdoc//lib/rdoc/markdown.rb#10861 + # source://rdoc//lib/rdoc/markdown.rb#10871 def _Strike; end # Strong = (StrongStar | StrongUl) # - # source://rdoc//lib/rdoc/markdown.rb#10635 + # source://rdoc//lib/rdoc/markdown.rb#10645 def _Strong; end # StrongStar = "**" !@Whitespace @StartList:a (!"**" Inline:b { a << b })+ "**" { strong a.join } # - # source://rdoc//lib/rdoc/markdown.rb#10653 + # source://rdoc//lib/rdoc/markdown.rb#10663 def _StrongStar; end # StrongUl = "__" !@Whitespace @StartList:a (!"__" Inline:b { a << b })+ "__" { strong a.join } # - # source://rdoc//lib/rdoc/markdown.rb#10757 + # source://rdoc//lib/rdoc/markdown.rb#10767 def _StrongUl; end # StyleBlock = < InStyleTags > @BlankLine* { if css? then RDoc::Markup::Raw.new text end } # - # source://rdoc//lib/rdoc/markdown.rb#9328 + # source://rdoc//lib/rdoc/markdown.rb#9338 def _StyleBlock; end # StyleClose = "<" Spnl "/" ("style" | "STYLE") Spnl ">" # - # source://rdoc//lib/rdoc/markdown.rb#9229 + # source://rdoc//lib/rdoc/markdown.rb#9239 def _StyleClose; end # StyleOpen = "<" Spnl ("style" | "STYLE") Spnl HtmlAttribute* ">" # - # source://rdoc//lib/rdoc/markdown.rb#9173 + # source://rdoc//lib/rdoc/markdown.rb#9183 def _StyleOpen; end # Symbol = < @SpecialChar > { text } # - # source://rdoc//lib/rdoc/markdown.rb#10069 + # source://rdoc//lib/rdoc/markdown.rb#10079 def _Symbol; end # Table = &{ github? } TableHead:header TableLine:line TableRow+:body { table = RDoc::Markup::Table.new(header, line, body) } # - # source://rdoc//lib/rdoc/markdown.rb#15937 + # source://rdoc//lib/rdoc/markdown.rb#15959 def _Table; end # TableAlign = < /:?-+:?/ > @Sp { text.start_with?(":") ? (text.end_with?(":") ? :center : :left) : (text.end_with?(":") ? :right : nil) } # - # source://rdoc//lib/rdoc/markdown.rb#16304 + # source://rdoc//lib/rdoc/markdown.rb#16326 def _TableAlign; end # TableAlign2 = "|" @Sp TableAlign # - # source://rdoc//lib/rdoc/markdown.rb#16278 + # source://rdoc//lib/rdoc/markdown.rb#16300 def _TableAlign2; end # TableHead = TableItem2+:items "|"? @Newline { items } # - # source://rdoc//lib/rdoc/markdown.rb#15993 + # source://rdoc//lib/rdoc/markdown.rb#16015 def _TableHead; end # TableItem = < /(?:\\.|[^|\n])+/ > { text.strip.gsub(/\\(.)/, '\1') } # - # source://rdoc//lib/rdoc/markdown.rb#16159 + # source://rdoc//lib/rdoc/markdown.rb#16181 def _TableItem; end # TableItem2 = "|" TableItem # - # source://rdoc//lib/rdoc/markdown.rb#16138 + # source://rdoc//lib/rdoc/markdown.rb#16160 def _TableItem2; end # TableLine = ((TableAlign:align1 TableAlign2*:aligns {[align1, *aligns] }):line | TableAlign2+:line) "|"? @Newline { line } # - # source://rdoc//lib/rdoc/markdown.rb#16185 + # source://rdoc//lib/rdoc/markdown.rb#16207 def _TableLine; end # TableRow = ((TableItem:item1 TableItem2*:items { [item1, *items] }):row | TableItem2+:row) "|"? @Newline { row } # - # source://rdoc//lib/rdoc/markdown.rb#16045 + # source://rdoc//lib/rdoc/markdown.rb#16067 def _TableRow; end # TerminalEndline = @Sp @Newline @Eof # - # source://rdoc//lib/rdoc/markdown.rb#10016 + # source://rdoc//lib/rdoc/markdown.rb#10026 def _TerminalEndline; end # Ticks1 = "`" !"`" # - # source://rdoc//lib/rdoc/markdown.rb#12391 + # source://rdoc//lib/rdoc/markdown.rb#12413 def _Ticks1; end # Ticks2 = "``" !"`" # - # source://rdoc//lib/rdoc/markdown.rb#12415 + # source://rdoc//lib/rdoc/markdown.rb#12437 def _Ticks2; end # Ticks3 = "```" !"`" # - # source://rdoc//lib/rdoc/markdown.rb#12439 + # source://rdoc//lib/rdoc/markdown.rb#12461 def _Ticks3; end # Ticks4 = "````" !"`" # - # source://rdoc//lib/rdoc/markdown.rb#12463 + # source://rdoc//lib/rdoc/markdown.rb#12485 def _Ticks4; end # Ticks5 = "`````" !"`" # - # source://rdoc//lib/rdoc/markdown.rb#12487 + # source://rdoc//lib/rdoc/markdown.rb#12509 def _Ticks5; end # Title = (TitleSingle | TitleDouble | ""):a { a } # - # source://rdoc//lib/rdoc/markdown.rb#11383 + # source://rdoc//lib/rdoc/markdown.rb#11405 def _Title; end # TitleDouble = "\"" (!("\"" @Sp (")" | @Newline)) .)* "\"" # - # source://rdoc//lib/rdoc/markdown.rb#11497 + # source://rdoc//lib/rdoc/markdown.rb#11519 def _TitleDouble; end # TitleSingle = "'" (!("'" @Sp (")" | @Newline)) .)* "'" # - # source://rdoc//lib/rdoc/markdown.rb#11420 + # source://rdoc//lib/rdoc/markdown.rb#11442 def _TitleSingle; end # UlLine = (< /_{4,}/ > { text } | < @Spacechar /_+/ &@Spacechar > { text }) # - # source://rdoc//lib/rdoc/markdown.rb#10206 + # source://rdoc//lib/rdoc/markdown.rb#10216 def _UlLine; end # UlOrStarLine = (UlLine | StarLine):a { a } # - # source://rdoc//lib/rdoc/markdown.rb#10095 + # source://rdoc//lib/rdoc/markdown.rb#10105 def _UlOrStarLine; end # Verbatim = VerbatimChunk+:a { RDoc::Markup::Verbatim.new(*a.flatten) } # - # source://rdoc//lib/rdoc/markdown.rb#1895 + # source://rdoc//lib/rdoc/markdown.rb#1905 def _Verbatim; end # VerbatimChunk = @BlankLine*:a NonblankIndentedLine+:b { a.concat b } # - # source://rdoc//lib/rdoc/markdown.rb#1845 + # source://rdoc//lib/rdoc/markdown.rb#1855 def _VerbatimChunk; end # Whitespace = (@Spacechar | @Newline) # - # source://rdoc//lib/rdoc/markdown.rb#10301 + # source://rdoc//lib/rdoc/markdown.rb#10311 def _Whitespace; end # root = Doc @@ -4822,7 +4792,7 @@ class RDoc::Markdown::RuleInfo def rendered; end end -# source://rdoc//lib/rdoc/markup.rb#106 +# source://rdoc//lib/rdoc/markup.rb#111 class RDoc::Markup # Take a block of text and use various heuristics to determine its # structure (paragraphs, lists, and so on). Invoke an event handler as we @@ -4830,12 +4800,12 @@ class RDoc::Markup # # @return [Markup] a new instance of Markup # - # source://rdoc//lib/rdoc/markup.rb#146 + # source://rdoc//lib/rdoc/markup.rb#151 def initialize(attribute_manager = T.unsafe(nil)); end # Add to the sequences recognized as general markup. # - # source://rdoc//lib/rdoc/markup.rb#163 + # source://rdoc//lib/rdoc/markup.rb#168 def add_html(tag, name); end # Add to other inline sequences. For example, we could add WikiWords using @@ -4845,31 +4815,31 @@ class RDoc::Markup # # Each wiki word will be presented to the output formatter. # - # source://rdoc//lib/rdoc/markup.rb#175 + # source://rdoc//lib/rdoc/markup.rb#180 def add_regexp_handling(pattern, name); end # Add to the sequences used to add formatting to an individual word (such # as *bold*). Matching entries will generate attributes that the output # formatters can recognize by their +name+. # - # source://rdoc//lib/rdoc/markup.rb#156 + # source://rdoc//lib/rdoc/markup.rb#161 def add_word_pair(start, stop, name); end # An AttributeManager which handles inline markup. # - # source://rdoc//lib/rdoc/markup.rb#111 + # source://rdoc//lib/rdoc/markup.rb#116 def attribute_manager; end # We take +input+, parse it if necessary, then invoke the output +formatter+ # using a Visitor to render the result. # - # source://rdoc//lib/rdoc/markup.rb#183 + # source://rdoc//lib/rdoc/markup.rb#188 def convert(input, formatter); end class << self # Parses +str+ into an RDoc::Markup::Document. # - # source://rdoc//lib/rdoc/markup.rb#116 + # source://rdoc//lib/rdoc/markup.rb#121 def parse(str); end end end @@ -5300,6 +5270,9 @@ class RDoc::Markup::Formatter # source://rdoc//lib/rdoc/markup/formatter.rb#176 def convert_string(string); end + # source://rdoc//lib/rdoc/markup/formatter.rb#225 + def each_attr_tag(attr_mask, reverse = T.unsafe(nil)); end + # Use ignore in your subclass to ignore the content of a node. # # ## @@ -5319,26 +5292,31 @@ class RDoc::Markup::Formatter # Turns off tags for +item+ on +res+ # - # source://rdoc//lib/rdoc/markup/formatter.rb#216 + # source://rdoc//lib/rdoc/markup/formatter.rb#218 def off_tags(res, item); end # Turns on tags for +item+ on +res+ # - # source://rdoc//lib/rdoc/markup/formatter.rb#201 + # source://rdoc//lib/rdoc/markup/formatter.rb#208 def on_tags(res, item); end # Extracts and a scheme, url and an anchor id from +url+ and returns them. # - # source://rdoc//lib/rdoc/markup/formatter.rb#231 + # source://rdoc//lib/rdoc/markup/formatter.rb#238 def parse_url(url); end # Is +tag+ a tt tag? # # @return [Boolean] # - # source://rdoc//lib/rdoc/markup/formatter.rb#261 + # source://rdoc//lib/rdoc/markup/formatter.rb#268 def tt?(tag); end + # @return [Boolean] + # + # source://rdoc//lib/rdoc/markup/formatter.rb#198 + def tt_tag?(attr_mask, reverse = T.unsafe(nil)); end + class << self # Converts a target url to one that is relative to a given path # @@ -5384,7 +5362,7 @@ class RDoc::Markup::Heading < ::Struct # source://rdoc//lib/rdoc/markup/heading.rb#68 def plain_html; end - # source://rdoc//lib/rdoc/markup/heading.rb#72 + # source://rdoc//lib/rdoc/markup/heading.rb#78 def pretty_print(q); end class << self @@ -5816,7 +5794,7 @@ class RDoc::Markup::PreProcess # Look for the given file in the directory containing the current file, # and then in each of the directories specified in the RDOC_INCLUDE path # - # source://rdoc//lib/rdoc/markup/pre_process.rb#288 + # source://rdoc//lib/rdoc/markup/pre_process.rb#308 def find_include_file(name); end # Look for directives in the given +text+. @@ -5846,8 +5824,8 @@ class RDoc::Markup::PreProcess # -- # When 1.8.7 support is ditched prefix can be defaulted to '' # - # source://rdoc//lib/rdoc/markup/pre_process.rb#150 - def handle_directive(prefix, directive, param, code_object = T.unsafe(nil), encoding = T.unsafe(nil)); end + # source://rdoc//lib/rdoc/markup/pre_process.rb#153 + def handle_directive(prefix, directive, param, code_object = T.unsafe(nil), encoding = T.unsafe(nil), line = T.unsafe(nil)); end # Handles the :include: _filename_ directive. # @@ -5863,7 +5841,7 @@ class RDoc::Markup::PreProcess # TODO shift left the whole file content in that case # TODO comment stop/start #-- and #++ in included file must be processed here # - # source://rdoc//lib/rdoc/markup/pre_process.rb#262 + # source://rdoc//lib/rdoc/markup/pre_process.rb#282 def include_file(name, indent, encoding); end # An RDoc::Options instance that will be filled in with overrides from @@ -6120,19 +6098,24 @@ class RDoc::Markup::ToBs < ::RDoc::Markup::ToRdoc # source://rdoc//lib/rdoc/markup/to_bs.rb#33 def accept_heading(heading); end - # Turns on or off regexp handling for +convert_string+ + # Prepares the visitor for consuming +list_item+ # # source://rdoc//lib/rdoc/markup/to_bs.rb#46 + def accept_list_item_start(list_item); end + + # Turns on or off regexp handling for +convert_string+ + # + # source://rdoc//lib/rdoc/markup/to_bs.rb#71 def annotate(tag); end # Calls convert_string on the result of convert_regexp_handling # - # source://rdoc//lib/rdoc/markup/to_bs.rb#59 + # source://rdoc//lib/rdoc/markup/to_bs.rb#84 def convert_regexp_handling(target); end # Adds bold or underline mixed with backspaces # - # source://rdoc//lib/rdoc/markup/to_bs.rb#66 + # source://rdoc//lib/rdoc/markup/to_bs.rb#91 def convert_string(string); end # Sets a flag that is picked up by #annotate to do the right thing in @@ -6157,63 +6140,63 @@ class RDoc::Markup::ToHtml < ::RDoc::Markup::Formatter # Adds +blank_line+ to the output # - # source://rdoc//lib/rdoc/markup/to_html.rb#291 + # source://rdoc//lib/rdoc/markup/to_html.rb#296 def accept_blank_line(blank_line); end # Adds +block_quote+ to the output # - # source://rdoc//lib/rdoc/markup/to_html.rb#190 + # source://rdoc//lib/rdoc/markup/to_html.rb#195 def accept_block_quote(block_quote); end # Adds +heading+ to the output. The headings greater than 6 are trimmed to # level 6. # - # source://rdoc//lib/rdoc/markup/to_html.rb#299 + # source://rdoc//lib/rdoc/markup/to_html.rb#304 def accept_heading(heading); end # Finishes consumption of +list+ # - # source://rdoc//lib/rdoc/markup/to_html.rb#262 + # source://rdoc//lib/rdoc/markup/to_html.rb#267 def accept_list_end(list); end # Finishes consumption of +list_item+ # - # source://rdoc//lib/rdoc/markup/to_html.rb#284 + # source://rdoc//lib/rdoc/markup/to_html.rb#289 def accept_list_item_end(list_item); end # Prepares the visitor for consuming +list_item+ # - # source://rdoc//lib/rdoc/markup/to_html.rb#273 + # source://rdoc//lib/rdoc/markup/to_html.rb#278 def accept_list_item_start(list_item); end # Prepares the visitor for consuming +list+ # - # source://rdoc//lib/rdoc/markup/to_html.rb#253 + # source://rdoc//lib/rdoc/markup/to_html.rb#258 def accept_list_start(list); end # Adds +paragraph+ to the output # - # source://rdoc//lib/rdoc/markup/to_html.rb#203 + # source://rdoc//lib/rdoc/markup/to_html.rb#208 def accept_paragraph(paragraph); end # Adds +raw+ to the output # - # source://rdoc//lib/rdoc/markup/to_html.rb#320 + # source://rdoc//lib/rdoc/markup/to_html.rb#325 def accept_raw(raw); end # Adds +rule+ to the output # - # source://rdoc//lib/rdoc/markup/to_html.rb#246 + # source://rdoc//lib/rdoc/markup/to_html.rb#251 def accept_rule(rule); end # Adds +table+ to the output # - # source://rdoc//lib/rdoc/markup/to_html.rb#327 + # source://rdoc//lib/rdoc/markup/to_html.rb#332 def accept_table(header, body, aligns); end # Adds +verbatim+ to the output # - # source://rdoc//lib/rdoc/markup/to_html.rb#216 + # source://rdoc//lib/rdoc/markup/to_html.rb#221 def accept_verbatim(verbatim); end # The RDoc::CodeObject HTML is being generated for. This is used to @@ -6230,12 +6213,12 @@ class RDoc::Markup::ToHtml < ::RDoc::Markup::Formatter # CGI-escapes +text+ # - # source://rdoc//lib/rdoc/markup/to_html.rb#352 + # source://rdoc//lib/rdoc/markup/to_html.rb#357 def convert_string(text); end # Returns the generated output # - # source://rdoc//lib/rdoc/markup/to_html.rb#183 + # source://rdoc//lib/rdoc/markup/to_html.rb#188 def end_accepting; end # Path to this document for relative links @@ -6251,7 +6234,7 @@ class RDoc::Markup::ToHtml < ::RDoc::Markup::Formatter # Generate a link to +url+ with content +text+. Handles the special cases # for img: and link: described under handle_regexp_HYPERLINK # - # source://rdoc//lib/rdoc/markup/to_html.rb#360 + # source://rdoc//lib/rdoc/markup/to_html.rb#365 def gen_url(url, text); end # source://rdoc//lib/rdoc/markup/to_html.rb#85 @@ -6259,7 +6242,7 @@ class RDoc::Markup::ToHtml < ::RDoc::Markup::Formatter # +target+ is a
# - # source://rdoc//lib/rdoc/markup/to_html.rb#110 + # source://rdoc//lib/rdoc/markup/to_html.rb#115 def handle_regexp_HARD_BREAK(target); end # +target+ is a potential link. The following schemes are handled: @@ -6273,7 +6256,7 @@ class RDoc::Markup::ToHtml < ::RDoc::Markup::Formatter # link::: # Reference to a local file relative to the output directory. # - # source://rdoc//lib/rdoc/markup/to_html.rb#126 + # source://rdoc//lib/rdoc/markup/to_html.rb#131 def handle_regexp_HYPERLINK(target); end # +target+ is an rdoc-schemed link that will be converted into a hyperlink. @@ -6284,20 +6267,20 @@ class RDoc::Markup::ToHtml < ::RDoc::Markup::Formatter # For the +rdoc-label+ scheme the footnote and label prefixes are stripped # when creating a link. All other contents will be linked verbatim. # - # source://rdoc//lib/rdoc/markup/to_html.rb#141 + # source://rdoc//lib/rdoc/markup/to_html.rb#146 def handle_regexp_RDOCLINK(target); end # This +target+ is a link where the label is different from the URL # label[url] or {long label}[url] # - # source://rdoc//lib/rdoc/markup/to_html.rb#149 + # source://rdoc//lib/rdoc/markup/to_html.rb#154 def handle_regexp_TIDYLINK(target); end # Determines the HTML list element for +list_type+ and +open_tag+ # # @raise [RDoc::Error] # - # source://rdoc//lib/rdoc/markup/to_html.rb#385 + # source://rdoc//lib/rdoc/markup/to_html.rb#390 def html_list_name(list_type, open_tag); end # source://rdoc//lib/rdoc/markup/to_html.rb#26 @@ -6315,7 +6298,7 @@ class RDoc::Markup::ToHtml < ::RDoc::Markup::Formatter # Maps attributes to HTML tags # - # source://rdoc//lib/rdoc/markup/to_html.rb#394 + # source://rdoc//lib/rdoc/markup/to_html.rb#399 def init_tags; end # source://rdoc//lib/rdoc/markup/to_html.rb#27 @@ -6323,20 +6306,20 @@ class RDoc::Markup::ToHtml < ::RDoc::Markup::Formatter # Returns the HTML end-tag for +list_type+ # - # source://rdoc//lib/rdoc/markup/to_html.rb#420 + # source://rdoc//lib/rdoc/markup/to_html.rb#425 def list_end_for(list_type); end # Returns the HTML tag for +list_type+, possible using a label from # +list_item+ # - # source://rdoc//lib/rdoc/markup/to_html.rb#404 + # source://rdoc//lib/rdoc/markup/to_html.rb#409 def list_item_start(list_item, list_type); end # Returns true if text is valid ruby syntax # # @return [Boolean] # - # source://rdoc//lib/rdoc/markup/to_html.rb#434 + # source://rdoc//lib/rdoc/markup/to_html.rb#439 def parseable?(text); end # source://rdoc//lib/rdoc/markup/to_html.rb#25 @@ -6344,12 +6327,12 @@ class RDoc::Markup::ToHtml < ::RDoc::Markup::Formatter # Prepares the visitor for HTML generation # - # source://rdoc//lib/rdoc/markup/to_html.rb#174 + # source://rdoc//lib/rdoc/markup/to_html.rb#179 def start_accepting; end # Converts +item+ to HTML using RDoc::Text#to_html # - # source://rdoc//lib/rdoc/markup/to_html.rb#448 + # source://rdoc//lib/rdoc/markup/to_html.rb#453 def to_html(item); end end @@ -6383,16 +6366,19 @@ class RDoc::Markup::ToHtmlCrossref < ::RDoc::Markup::ToHtml # source://rdoc//lib/rdoc/markup/to_html_crossref.rb#19 def context=(_arg0); end + # source://rdoc//lib/rdoc/markup/to_html_crossref.rb#187 + def convert_flow(flow); end + # Creates a link to the reference +name+ if the name exists. If +text+ is # given it is used as the link text, otherwise +name+ is used. # # source://rdoc//lib/rdoc/markup/to_html_crossref.rb#61 - def cross_reference(name, text = T.unsafe(nil), code = T.unsafe(nil)); end + def cross_reference(name, text = T.unsafe(nil), code = T.unsafe(nil), rdoc_ref: T.unsafe(nil)); end # Generates links for rdoc-ref: scheme URLs and allows # RDoc::Markup::ToHtml to handle other schemes. # - # source://rdoc//lib/rdoc/markup/to_html_crossref.rb#131 + # source://rdoc//lib/rdoc/markup/to_html_crossref.rb#138 def gen_url(url, text); end # We're invoked when any text matches the CROSSREF pattern. If we find the @@ -6407,7 +6393,7 @@ class RDoc::Markup::ToHtmlCrossref < ::RDoc::Markup::ToHtml # Handles rdoc-ref: scheme links and allows RDoc::Markup::ToHtml to # handle other schemes. # - # source://rdoc//lib/rdoc/markup/to_html_crossref.rb#102 + # source://rdoc//lib/rdoc/markup/to_html_crossref.rb#104 def handle_regexp_HYPERLINK(target); end # +target+ is an rdoc-schemed link that will be converted into a hyperlink. @@ -6417,7 +6403,7 @@ class RDoc::Markup::ToHtmlCrossref < ::RDoc::Markup::ToHtml # All other contents are handled by # {the superclass}[rdoc-ref:RDoc::Markup::ToHtml#handle_regexp_RDOCLINK] # - # source://rdoc//lib/rdoc/markup/to_html_crossref.rb#116 + # source://rdoc//lib/rdoc/markup/to_html_crossref.rb#123 def handle_regexp_RDOCLINK(target); end # source://rdoc//lib/rdoc/markup/to_html_crossref.rb#46 @@ -6425,8 +6411,8 @@ class RDoc::Markup::ToHtmlCrossref < ::RDoc::Markup::ToHtml # Creates an HTML link to +name+ with the given +text+. # - # source://rdoc//lib/rdoc/markup/to_html_crossref.rb#141 - def link(name, text, code = T.unsafe(nil)); end + # source://rdoc//lib/rdoc/markup/to_html_crossref.rb#150 + def link(name, text, code = T.unsafe(nil), rdoc_ref: T.unsafe(nil)); end # Should we show '#' characters on method references? # @@ -6730,7 +6716,7 @@ class RDoc::Markup::ToMarkdown < ::RDoc::Markup::ToRdoc # Finishes consumption of `list_item` # - # source://rdoc//lib/rdoc/markup/to_markdown.rb#56 + # source://rdoc//lib/rdoc/markup/to_markdown.rb#54 def accept_list_item_end(list_item); end # Prepares the visitor for consuming `list_item` @@ -6812,7 +6798,7 @@ class RDoc::Markup::ToRdoc < ::RDoc::Markup::Formatter # Adds +paragraph+ to the output # - # source://rdoc//lib/rdoc/markup/to_rdoc.rb#203 + # source://rdoc//lib/rdoc/markup/to_rdoc.rb#211 def accept_indented_paragraph(paragraph); end # Finishes consumption of +list+ @@ -6832,52 +6818,52 @@ class RDoc::Markup::ToRdoc < ::RDoc::Markup::Formatter # Prepares the visitor for consuming +list+ # - # source://rdoc//lib/rdoc/markup/to_rdoc.rb#168 + # source://rdoc//lib/rdoc/markup/to_rdoc.rb#176 def accept_list_start(list); end # Adds +paragraph+ to the output # - # source://rdoc//lib/rdoc/markup/to_rdoc.rb#195 + # source://rdoc//lib/rdoc/markup/to_rdoc.rb#203 def accept_paragraph(paragraph); end # Adds +raw+ to the output # - # source://rdoc//lib/rdoc/markup/to_rdoc.rb#213 + # source://rdoc//lib/rdoc/markup/to_rdoc.rb#221 def accept_raw(raw); end # Adds +rule+ to the output # - # source://rdoc//lib/rdoc/markup/to_rdoc.rb#220 + # source://rdoc//lib/rdoc/markup/to_rdoc.rb#228 def accept_rule(rule); end # Adds +table+ to the output # - # source://rdoc//lib/rdoc/markup/to_rdoc.rb#243 + # source://rdoc//lib/rdoc/markup/to_rdoc.rb#251 def accept_table(header, body, aligns); end # Outputs +verbatim+ indented 2 columns # - # source://rdoc//lib/rdoc/markup/to_rdoc.rb#229 + # source://rdoc//lib/rdoc/markup/to_rdoc.rb#237 def accept_verbatim(verbatim); end # Applies attribute-specific markup to +text+ using RDoc::AttributeManager # - # source://rdoc//lib/rdoc/markup/to_rdoc.rb#271 + # source://rdoc//lib/rdoc/markup/to_rdoc.rb#279 def attributes(text); end # Returns the generated output # - # source://rdoc//lib/rdoc/markup/to_rdoc.rb#279 + # source://rdoc//lib/rdoc/markup/to_rdoc.rb#287 def end_accepting; end # Adds a newline to the output # - # source://rdoc//lib/rdoc/markup/to_rdoc.rb#295 + # source://rdoc//lib/rdoc/markup/to_rdoc.rb#303 def handle_regexp_HARD_BREAK(target); end # Removes preceding \\ from the suppressed crossref +target+ # - # source://rdoc//lib/rdoc/markup/to_rdoc.rb#286 + # source://rdoc//lib/rdoc/markup/to_rdoc.rb#294 def handle_regexp_SUPPRESSED_CROSSREF(target); end # Current indent amount for output in characters @@ -6922,13 +6908,13 @@ class RDoc::Markup::ToRdoc < ::RDoc::Markup::Formatter # Prepares the visitor for text generation # - # source://rdoc//lib/rdoc/markup/to_rdoc.rb#302 + # source://rdoc//lib/rdoc/markup/to_rdoc.rb#310 def start_accepting; end # Adds the stored #prefix to the output and clears it. Lists generate a # prefix for later consumption. # - # source://rdoc//lib/rdoc/markup/to_rdoc.rb#316 + # source://rdoc//lib/rdoc/markup/to_rdoc.rb#324 def use_prefix; end # Output width in characters @@ -6943,7 +6929,7 @@ class RDoc::Markup::ToRdoc < ::RDoc::Markup::Formatter # Wraps +text+ to #width # - # source://rdoc//lib/rdoc/markup/to_rdoc.rb#326 + # source://rdoc//lib/rdoc/markup/to_rdoc.rb#334 def wrap(text); end end @@ -7243,7 +7229,7 @@ end # Abstract class representing either a method or an attribute. # -# source://rdoc//lib/rdoc/method_attr.rb#5 +# source://rdoc//lib/rdoc/code_object/method_attr.rb#5 class RDoc::MethodAttr < ::RDoc::CodeObject include ::Comparable @@ -7254,15 +7240,15 @@ class RDoc::MethodAttr < ::RDoc::CodeObject # # @return [MethodAttr] a new instance of MethodAttr # - # source://rdoc//lib/rdoc/method_attr.rb#78 - def initialize(text, name); end + # source://rdoc//lib/rdoc/code_object/method_attr.rb#72 + def initialize(text, name, singleton: T.unsafe(nil)); end # Order by #singleton then #name # - # source://rdoc//lib/rdoc/method_attr.rb#113 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#106 def <=>(other); end - # source://rdoc//lib/rdoc/method_attr.rb#121 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#114 def ==(other); end # Abstract method. Contexts in their building phase call this @@ -7275,7 +7261,7 @@ class RDoc::MethodAttr < ::RDoc::CodeObject # # @raise [NotImplementedError] # - # source://rdoc//lib/rdoc/method_attr.rb#209 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#202 def add_alias(an_alias, context); end # Prepend +src+ with line numbers. Relies on the first line of a source @@ -7291,45 +7277,45 @@ class RDoc::MethodAttr < ::RDoc::CodeObject # Array of other names for this method/attribute # - # source://rdoc//lib/rdoc/method_attr.rb#32 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#32 def aliases; end # HTML fragment reference for this method # - # source://rdoc//lib/rdoc/method_attr.rb#216 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#209 def aref; end # Prefix for +aref+, defined by subclasses. # # @raise [NotImplementedError] # - # source://rdoc//lib/rdoc/method_attr.rb#225 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#218 def aref_prefix; end # The call_seq or the param_seq with method name, if there is no call_seq. # - # source://rdoc//lib/rdoc/method_attr.rb#64 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#64 def arglists; end # Parameters yielded by the called block # - # source://rdoc//lib/rdoc/method_attr.rb#49 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#49 def block_params; end # Attempts to sanitize the content passed by the Ruby parser: # remove outer parentheses, etc. # - # source://rdoc//lib/rdoc/method_attr.rb#233 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#226 def block_params=(value); end # Different ways to call this method # - # source://rdoc//lib/rdoc/method_attr.rb#59 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#59 def call_seq; end # Different ways to call this method # - # source://rdoc//lib/rdoc/method_attr.rb#59 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#59 def call_seq=(_arg0); end # A method/attribute is documented if any of the following is true: @@ -7339,39 +7325,39 @@ class RDoc::MethodAttr < ::RDoc::CodeObject # # @return [Boolean] # - # source://rdoc//lib/rdoc/method_attr.rb#132 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#125 def documented?; end - # source://rdoc//lib/rdoc/method_attr.rb#178 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#171 def find_method_or_attribute(name); end - # source://rdoc//lib/rdoc/method_attr.rb#166 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#159 def find_see; end # Full method/attribute name including namespace # - # source://rdoc//lib/rdoc/method_attr.rb#300 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#293 def full_name; end # HTML id-friendly method/attribute name # - # source://rdoc//lib/rdoc/method_attr.rb#291 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#284 def html_name; end - # source://rdoc//lib/rdoc/method_attr.rb#105 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#98 def initialize_visibility; end - # source://rdoc//lib/rdoc/method_attr.rb#304 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#297 def inspect; end # The method/attribute we're aliasing # - # source://rdoc//lib/rdoc/method_attr.rb#37 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#37 def is_alias_for; end # The method/attribute we're aliasing # - # source://rdoc//lib/rdoc/method_attr.rb#37 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#37 def is_alias_for=(_arg0); end # Turns the method's token stream into HTML. @@ -7383,65 +7369,54 @@ class RDoc::MethodAttr < ::RDoc::CodeObject # Name of this method/attribute. # - # source://rdoc//lib/rdoc/method_attr.rb#12 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#12 def name; end # Name of this method/attribute. # - # source://rdoc//lib/rdoc/method_attr.rb#12 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#12 def name=(_arg0); end + # source://rdoc//lib/rdoc/code_object/method_attr.rb#398 + def name_ord_range; end + # '::' for a class method/attribute, '#' for an instance method. # - # source://rdoc//lib/rdoc/method_attr.rb#319 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#312 def name_prefix; end - # Name for output to HTML. For class methods the full name with a "." is - # used like +SomeClass.method_name+. For instance methods the class name is - # used if +context+ does not match the parent. - # - # This is to help prevent people from using :: to call class methods. - # - # source://rdoc//lib/rdoc/method_attr.rb#330 - def output_name(context); end - - # Pretty parameter list for this method - # - # source://rdoc//lib/rdoc/method_attr.rb#69 - def param_seq; end - # Parameters for this method # - # source://rdoc//lib/rdoc/method_attr.rb#54 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#54 def params; end # Parameters for this method # - # source://rdoc//lib/rdoc/method_attr.rb#54 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#54 def params=(_arg0); end # Name of our parent with special handling for un-marshaled methods # - # source://rdoc//lib/rdoc/method_attr.rb#360 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#340 def parent_name; end # Path to this method for use with HTML generator output. # - # source://rdoc//lib/rdoc/method_attr.rb#353 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#333 def path; end # Method/attribute name with class/instance indicator # - # source://rdoc//lib/rdoc/method_attr.rb#339 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#319 def pretty_name; end - # source://rdoc//lib/rdoc/method_attr.rb#364 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#344 def pretty_print(q); end # Used by RDoc::Generator::JsonIndex to create a record for the search # engine. # - # source://rdoc//lib/rdoc/method_attr.rb#398 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#378 def search_record; end # A method/attribute to look at, @@ -7457,87 +7432,87 @@ class RDoc::MethodAttr < ::RDoc::CodeObject # Templates may generate a "see also ..." if this method/attribute # has documentation, and "see ..." if it does not. # - # source://rdoc//lib/rdoc/method_attr.rb#152 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#145 def see; end # Is this a singleton method/attribute? # - # source://rdoc//lib/rdoc/method_attr.rb#22 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#22 def singleton; end # Is this a singleton method/attribute? # - # source://rdoc//lib/rdoc/method_attr.rb#22 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#22 def singleton=(_arg0); end # Sets the store for this class or module and its contained code objects. # - # source://rdoc//lib/rdoc/method_attr.rb#160 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#153 def store=(store); end # Source file token stream # - # source://rdoc//lib/rdoc/method_attr.rb#27 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#27 def text; end - # source://rdoc//lib/rdoc/method_attr.rb#410 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#390 def to_s; end # Type of method/attribute (class or instance) # - # source://rdoc//lib/rdoc/method_attr.rb#346 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#326 def type; end # public, protected, private # - # source://rdoc//lib/rdoc/method_attr.rb#17 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#17 def visibility; end # public, protected, private # - # source://rdoc//lib/rdoc/method_attr.rb#17 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#17 def visibility=(_arg0); end private # Resets cached data for the object so it can be rebuilt by accessor methods # - # source://rdoc//lib/rdoc/method_attr.rb#101 + # source://rdoc//lib/rdoc/code_object/method_attr.rb#94 def initialize_copy(other); end end # A Mixin adds features from a module into another context. RDoc::Include and # RDoc::Extend are both mixins. # -# source://rdoc//lib/rdoc/mixin.rb#6 +# source://rdoc//lib/rdoc/code_object/mixin.rb#6 class RDoc::Mixin < ::RDoc::CodeObject # Creates a new Mixin for +name+ with +comment+ # # @return [Mixin] a new instance of Mixin # - # source://rdoc//lib/rdoc/mixin.rb#16 + # source://rdoc//lib/rdoc/code_object/mixin.rb#16 def initialize(name, comment); end # Mixins are sorted by name # - # source://rdoc//lib/rdoc/mixin.rb#26 + # source://rdoc//lib/rdoc/code_object/mixin.rb#26 def <=>(other); end - # source://rdoc//lib/rdoc/mixin.rb#32 + # source://rdoc//lib/rdoc/code_object/mixin.rb#32 def ==(other); end - # source://rdoc//lib/rdoc/mixin.rb#32 + # source://rdoc//lib/rdoc/code_object/mixin.rb#32 def eql?(other); end # Full name based on #module # - # source://rdoc//lib/rdoc/mixin.rb#41 + # source://rdoc//lib/rdoc/code_object/mixin.rb#41 def full_name; end - # source://rdoc//lib/rdoc/mixin.rb#46 + # source://rdoc//lib/rdoc/code_object/mixin.rb#46 def hash; end - # source://rdoc//lib/rdoc/mixin.rb#50 + # source://rdoc//lib/rdoc/code_object/mixin.rb#50 def inspect; end # Attempts to locate the included module object. Returns the name if not @@ -7556,90 +7531,90 @@ class RDoc::Mixin < ::RDoc::CodeObject # # As of the beginning of October, 2011, no gem includes nonexistent modules. # - # source://rdoc//lib/rdoc/mixin.rb#75 + # source://rdoc//lib/rdoc/code_object/mixin.rb#75 def module; end # Name of included module # - # source://rdoc//lib/rdoc/mixin.rb#11 + # source://rdoc//lib/rdoc/code_object/mixin.rb#11 def name; end # Name of included module # - # source://rdoc//lib/rdoc/mixin.rb#11 + # source://rdoc//lib/rdoc/code_object/mixin.rb#11 def name=(_arg0); end # Sets the store for this class or module and its contained code objects. # - # source://rdoc//lib/rdoc/mixin.rb#110 + # source://rdoc//lib/rdoc/code_object/mixin.rb#110 def store=(store); end - # source://rdoc//lib/rdoc/mixin.rb#116 + # source://rdoc//lib/rdoc/code_object/mixin.rb#116 def to_s; end end # A normal class, neither singleton nor anonymous # -# source://rdoc//lib/rdoc/normal_class.rb#5 +# source://rdoc//lib/rdoc/code_object/normal_class.rb#5 class RDoc::NormalClass < ::RDoc::ClassModule # The ancestors of this class including modules. Unlike Module#ancestors, # this class is not included in the result. The result will contain both # RDoc::ClassModules and Strings. # - # source://rdoc//lib/rdoc/normal_class.rb#12 + # source://rdoc//lib/rdoc/code_object/normal_class.rb#12 def ancestors; end - # source://rdoc//lib/rdoc/normal_class.rb#24 + # source://rdoc//lib/rdoc/code_object/normal_class.rb#24 def aref_prefix; end # The definition of this class, class MyClassName # - # source://rdoc//lib/rdoc/normal_class.rb#31 + # source://rdoc//lib/rdoc/code_object/normal_class.rb#31 def definition; end - # source://rdoc//lib/rdoc/normal_class.rb#35 + # source://rdoc//lib/rdoc/code_object/normal_class.rb#35 def direct_ancestors; end - # source://rdoc//lib/rdoc/normal_class.rb#39 + # source://rdoc//lib/rdoc/code_object/normal_class.rb#39 def inspect; end - # source://rdoc//lib/rdoc/normal_class.rb#56 + # source://rdoc//lib/rdoc/code_object/normal_class.rb#56 def pretty_print(q); end - # source://rdoc//lib/rdoc/normal_class.rb#47 + # source://rdoc//lib/rdoc/code_object/normal_class.rb#47 def to_s; end end # A normal module, like NormalClass # -# source://rdoc//lib/rdoc/normal_module.rb#5 +# source://rdoc//lib/rdoc/code_object/normal_module.rb#5 class RDoc::NormalModule < ::RDoc::ClassModule - # source://rdoc//lib/rdoc/normal_module.rb#7 + # source://rdoc//lib/rdoc/code_object/normal_module.rb#7 def aref_prefix; end # The definition of this module, module MyModuleName # - # source://rdoc//lib/rdoc/normal_module.rb#21 + # source://rdoc//lib/rdoc/code_object/normal_module.rb#21 def definition; end - # source://rdoc//lib/rdoc/normal_module.rb#11 + # source://rdoc//lib/rdoc/code_object/normal_module.rb#11 def inspect; end # This is a module, returns true # # @return [Boolean] # - # source://rdoc//lib/rdoc/normal_module.rb#28 + # source://rdoc//lib/rdoc/code_object/normal_module.rb#28 def module?; end - # source://rdoc//lib/rdoc/normal_module.rb#32 + # source://rdoc//lib/rdoc/code_object/normal_module.rb#32 def pretty_print(q); end # Modules don't have one, raises NoMethodError # # @raise [NoMethodError] # - # source://rdoc//lib/rdoc/normal_module.rb#69 + # source://rdoc//lib/rdoc/code_object/normal_module.rb#69 def superclass; end end @@ -7716,339 +7691,388 @@ end class RDoc::Options # @return [Options] a new instance of Options # - # source://rdoc//lib/rdoc/options.rb#346 + # source://rdoc//lib/rdoc/options.rb#376 def initialize(loaded_options = T.unsafe(nil)); end - # source://rdoc//lib/rdoc/options.rb#459 + # source://rdoc//lib/rdoc/options.rb#506 def ==(other); end + # Exclude the default patterns as well if true. + # + # source://rdoc//lib/rdoc/options.rb#360 + def apply_default_exclude; end + + # Words to be ignored in autolink cross-references + # + # source://rdoc//lib/rdoc/options.rb#364 + def autolink_excluded_words; end + + # Words to be ignored in autolink cross-references + # + # source://rdoc//lib/rdoc/options.rb#364 + def autolink_excluded_words=(_arg0); end + # Character-set for HTML output. #encoding is preferred over #charset # - # source://rdoc//lib/rdoc/options.rb#151 + # source://rdoc//lib/rdoc/options.rb#152 def charset; end # Character-set for HTML output. #encoding is preferred over #charset # - # source://rdoc//lib/rdoc/options.rb#151 + # source://rdoc//lib/rdoc/options.rb#152 def charset=(_arg0); end # Check that the files on the command line exist # - # source://rdoc//lib/rdoc/options.rb#483 + # source://rdoc//lib/rdoc/options.rb#533 def check_files; end # Ensure only one generator is loaded # - # source://rdoc//lib/rdoc/options.rb#504 + # source://rdoc//lib/rdoc/options.rb#554 def check_generator; end + # The prefix to use for class and module page paths + # + # source://rdoc//lib/rdoc/options.rb#369 + def class_module_path_prefix; end + + # The prefix to use for class and module page paths + # + # source://rdoc//lib/rdoc/options.rb#369 + def class_module_path_prefix=(_arg0); end + # If true, only report on undocumented files # - # source://rdoc//lib/rdoc/options.rb#243 + # source://rdoc//lib/rdoc/options.rb#244 def coverage_report; end # If true, only report on undocumented files # - # source://rdoc//lib/rdoc/options.rb#243 + # source://rdoc//lib/rdoc/options.rb#244 def coverage_report=(_arg0); end # Set the title, but only if not already set. Used to set the title # from a source file, so that a title set from the command line # will have the priority. # - # source://rdoc//lib/rdoc/options.rb#516 + # source://rdoc//lib/rdoc/options.rb#566 def default_title=(string); end # If true, RDoc will not write any files. # - # source://rdoc//lib/rdoc/options.rb#156 + # source://rdoc//lib/rdoc/options.rb#157 def dry_run; end # If true, RDoc will not write any files. # - # source://rdoc//lib/rdoc/options.rb#156 + # source://rdoc//lib/rdoc/options.rb#157 def dry_run=(_arg0); end + # Embed mixin methods, attributes, and constants into class documentation. Set via + # +--[no-]embed-mixins+ (Default is +false+.) + # + # source://rdoc//lib/rdoc/options.rb#356 + def embed_mixins; end + + # Embed mixin methods, attributes, and constants into class documentation. Set via + # +--[no-]embed-mixins+ (Default is +false+.) + # + # source://rdoc//lib/rdoc/options.rb#356 + def embed_mixins=(_arg0); end + # The output encoding. All input files will be transcoded to this encoding. # # The default encoding is UTF-8. This is set via --encoding. # - # source://rdoc//lib/rdoc/options.rb#163 + # source://rdoc//lib/rdoc/options.rb#164 def encoding; end # The output encoding. All input files will be transcoded to this encoding. # # The default encoding is UTF-8. This is set via --encoding. # - # source://rdoc//lib/rdoc/options.rb#163 + # source://rdoc//lib/rdoc/options.rb#164 def encoding=(_arg0); end # Create a regexp for #exclude # - # source://rdoc//lib/rdoc/options.rb#544 + # source://rdoc//lib/rdoc/options.rb#594 def exclude; end # Files matching this pattern will be excluded # - # source://rdoc//lib/rdoc/options.rb#168 + # source://rdoc//lib/rdoc/options.rb#169 def exclude=(_arg0); end + # The prefix to use for file page paths + # + # source://rdoc//lib/rdoc/options.rb#374 + def file_path_prefix; end + + # The prefix to use for file page paths + # + # source://rdoc//lib/rdoc/options.rb#374 + def file_path_prefix=(_arg0); end + # The list of files to be processed # - # source://rdoc//lib/rdoc/options.rb#173 + # source://rdoc//lib/rdoc/options.rb#174 def files; end # The list of files to be processed # - # source://rdoc//lib/rdoc/options.rb#173 + # source://rdoc//lib/rdoc/options.rb#174 def files=(_arg0); end # Completes any unfinished option setup business such as filtering for # existent files, creating a regexp for #exclude and setting a default # #template. # - # source://rdoc//lib/rdoc/options.rb#560 + # source://rdoc//lib/rdoc/options.rb#612 def finish; end # Fixes the page_dir to be relative to the root_dir and adds the page_dir to # the files list. # - # source://rdoc//lib/rdoc/options.rb#601 + # source://rdoc//lib/rdoc/options.rb#653 def finish_page_dir; end # Create the output even if the output directory does not look # like an rdoc output directory # - # source://rdoc//lib/rdoc/options.rb#179 + # source://rdoc//lib/rdoc/options.rb#180 def force_output; end # Create the output even if the output directory does not look # like an rdoc output directory # - # source://rdoc//lib/rdoc/options.rb#179 + # source://rdoc//lib/rdoc/options.rb#180 def force_output=(_arg0); end # Scan newer sources than the flag file if true. # - # source://rdoc//lib/rdoc/options.rb#184 + # source://rdoc//lib/rdoc/options.rb#185 def force_update; end # Scan newer sources than the flag file if true. # - # source://rdoc//lib/rdoc/options.rb#184 + # source://rdoc//lib/rdoc/options.rb#185 def force_update=(_arg0); end # Formatter to mark up text with # - # source://rdoc//lib/rdoc/options.rb#189 + # source://rdoc//lib/rdoc/options.rb#190 def formatter; end # Formatter to mark up text with # - # source://rdoc//lib/rdoc/options.rb#189 + # source://rdoc//lib/rdoc/options.rb#190 def formatter=(_arg0); end # Description of the output generator (set with the --format option) # - # source://rdoc//lib/rdoc/options.rb#194 + # source://rdoc//lib/rdoc/options.rb#195 def generator; end # Description of the output generator (set with the --format option) # - # source://rdoc//lib/rdoc/options.rb#194 + # source://rdoc//lib/rdoc/options.rb#195 def generator=(_arg0); end # Returns a properly-space list of generators and their descriptions. # - # source://rdoc//lib/rdoc/options.rb#620 + # source://rdoc//lib/rdoc/options.rb#672 def generator_descriptions; end # For #== # - # source://rdoc//lib/rdoc/options.rb#199 + # source://rdoc//lib/rdoc/options.rb#200 def generator_name; end # Loaded generator options. Used to prevent --help from loading the same # options multiple times. # - # source://rdoc//lib/rdoc/options.rb#205 + # source://rdoc//lib/rdoc/options.rb#206 def generator_options; end # Loaded generator options. Used to prevent --help from loading the same # options multiple times. # - # source://rdoc//lib/rdoc/options.rb#205 + # source://rdoc//lib/rdoc/options.rb#206 def generator_options=(_arg0); end # Old rdoc behavior: hyperlink all words that match a method name, # even if not preceded by '#' or '::' # - # source://rdoc//lib/rdoc/options.rb#211 + # source://rdoc//lib/rdoc/options.rb#212 def hyperlink_all; end # Old rdoc behavior: hyperlink all words that match a method name, # even if not preceded by '#' or '::' # - # source://rdoc//lib/rdoc/options.rb#211 + # source://rdoc//lib/rdoc/options.rb#212 def hyperlink_all=(_arg0); end - # source://rdoc//lib/rdoc/options.rb#351 + # source://rdoc//lib/rdoc/options.rb#386 def init_ivars; end - # source://rdoc//lib/rdoc/options.rb#396 + # source://rdoc//lib/rdoc/options.rb#434 def init_with(map); end # Include line numbers in the source code # - # source://rdoc//lib/rdoc/options.rb#216 + # source://rdoc//lib/rdoc/options.rb#217 def line_numbers; end # Include line numbers in the source code # - # source://rdoc//lib/rdoc/options.rb#216 + # source://rdoc//lib/rdoc/options.rb#217 def line_numbers=(_arg0); end # The output locale. # - # source://rdoc//lib/rdoc/options.rb#221 + # source://rdoc//lib/rdoc/options.rb#222 def locale; end # The output locale. # - # source://rdoc//lib/rdoc/options.rb#221 + # source://rdoc//lib/rdoc/options.rb#222 def locale=(_arg0); end # The directory where locale data live. # - # source://rdoc//lib/rdoc/options.rb#226 + # source://rdoc//lib/rdoc/options.rb#227 def locale_dir; end # The directory where locale data live. # - # source://rdoc//lib/rdoc/options.rb#226 + # source://rdoc//lib/rdoc/options.rb#227 def locale_dir=(_arg0); end # Name of the file, class or module to display in the initial index page (if # not specified the first file we encounter is used) # - # source://rdoc//lib/rdoc/options.rb#232 + # source://rdoc//lib/rdoc/options.rb#233 def main_page; end # Name of the file, class or module to display in the initial index page (if # not specified the first file we encounter is used) # - # source://rdoc//lib/rdoc/options.rb#232 + # source://rdoc//lib/rdoc/options.rb#233 def main_page=(_arg0); end - # The default markup format. The default is 'rdoc'. 'markdown', 'tomdoc' - # and 'rd' are also built-in. + # The markup format. + # One of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+. + # See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats]. # - # source://rdoc//lib/rdoc/options.rb#238 + # source://rdoc//lib/rdoc/options.rb#239 def markup; end - # The default markup format. The default is 'rdoc'. 'markdown', 'tomdoc' - # and 'rd' are also built-in. + # The markup format. + # One of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+. + # See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats]. # - # source://rdoc//lib/rdoc/options.rb#238 + # source://rdoc//lib/rdoc/options.rb#239 def markup=(_arg0); end # The name of the output directory # - # source://rdoc//lib/rdoc/options.rb#248 + # source://rdoc//lib/rdoc/options.rb#249 def op_dir; end # The name of the output directory # - # source://rdoc//lib/rdoc/options.rb#248 + # source://rdoc//lib/rdoc/options.rb#249 def op_dir=(_arg0); end # The OptionParser for this instance # - # source://rdoc//lib/rdoc/options.rb#253 + # source://rdoc//lib/rdoc/options.rb#254 def option_parser; end # The OptionParser for this instance # - # source://rdoc//lib/rdoc/options.rb#253 + # source://rdoc//lib/rdoc/options.rb#254 def option_parser=(_arg0); end # Output heading decorations? # - # source://rdoc//lib/rdoc/options.rb#257 + # source://rdoc//lib/rdoc/options.rb#258 def output_decoration; end # Output heading decorations? # - # source://rdoc//lib/rdoc/options.rb#257 + # source://rdoc//lib/rdoc/options.rb#258 def output_decoration=(_arg0); end - # source://rdoc//lib/rdoc/options.rb#427 + # source://rdoc//lib/rdoc/options.rb#469 def override(map); end # Directory where guides, FAQ, and other pages not associated with a class # live. You may leave this unset if these are at the root of your project. # - # source://rdoc//lib/rdoc/options.rb#263 + # source://rdoc//lib/rdoc/options.rb#264 def page_dir; end # Directory where guides, FAQ, and other pages not associated with a class # live. You may leave this unset if these are at the root of your project. # - # source://rdoc//lib/rdoc/options.rb#263 + # source://rdoc//lib/rdoc/options.rb#264 def page_dir=(_arg0); end # Parses command line options. # - # source://rdoc//lib/rdoc/options.rb#646 + # source://rdoc//lib/rdoc/options.rb#698 def parse(argv); end # Is RDoc in pipe mode? # - # source://rdoc//lib/rdoc/options.rb#268 + # source://rdoc//lib/rdoc/options.rb#269 def pipe; end # Is RDoc in pipe mode? # - # source://rdoc//lib/rdoc/options.rb#268 + # source://rdoc//lib/rdoc/options.rb#269 def pipe=(_arg0); end # Don't display progress as we process the files # - # source://rdoc//lib/rdoc/options.rb#1191 + # source://rdoc//lib/rdoc/options.rb#1270 def quiet; end # Set quietness to +bool+ # - # source://rdoc//lib/rdoc/options.rb#1198 + # source://rdoc//lib/rdoc/options.rb#1277 def quiet=(bool); end # Array of directories to search for files to satisfy an :include: # - # source://rdoc//lib/rdoc/options.rb#273 + # source://rdoc//lib/rdoc/options.rb#274 def rdoc_include; end # Array of directories to search for files to satisfy an :include: # - # source://rdoc//lib/rdoc/options.rb#273 + # source://rdoc//lib/rdoc/options.rb#274 def rdoc_include=(_arg0); end # Root of the source documentation will be generated for. Set this when # building documentation outside the source directory. Defaults to the # current directory. # - # source://rdoc//lib/rdoc/options.rb#280 + # source://rdoc//lib/rdoc/options.rb#281 def root; end # Root of the source documentation will be generated for. Set this when # building documentation outside the source directory. Defaults to the # current directory. # - # source://rdoc//lib/rdoc/options.rb#280 + # source://rdoc//lib/rdoc/options.rb#281 def root=(_arg0); end # Removes directories from +path+ that are outside the current directory # - # source://rdoc//lib/rdoc/options.rb#1205 + # source://rdoc//lib/rdoc/options.rb#1284 def sanitize_path(path); end # Set up an output generator for the named +generator_name+. @@ -8057,117 +8081,117 @@ class RDoc::Options # the options instance. This allows generators to add custom options or set # default options. # - # source://rdoc//lib/rdoc/options.rb#1232 + # source://rdoc//lib/rdoc/options.rb#1311 def setup_generator(generator_name = T.unsafe(nil)); end # Include the '#' at the front of hyperlinked instance method names # - # source://rdoc//lib/rdoc/options.rb#285 + # source://rdoc//lib/rdoc/options.rb#286 def show_hash; end # Include the '#' at the front of hyperlinked instance method names # - # source://rdoc//lib/rdoc/options.rb#285 + # source://rdoc//lib/rdoc/options.rb#286 def show_hash=(_arg0); end # Indicates if files of test suites should be skipped # - # source://rdoc//lib/rdoc/options.rb#344 + # source://rdoc//lib/rdoc/options.rb#351 def skip_tests; end # Indicates if files of test suites should be skipped # - # source://rdoc//lib/rdoc/options.rb#344 + # source://rdoc//lib/rdoc/options.rb#351 def skip_tests=(_arg0); end # Directory to copy static files from # - # source://rdoc//lib/rdoc/options.rb#290 + # source://rdoc//lib/rdoc/options.rb#291 def static_path; end # Directory to copy static files from # - # source://rdoc//lib/rdoc/options.rb#290 + # source://rdoc//lib/rdoc/options.rb#291 def static_path=(_arg0); end # The number of columns in a tab # - # source://rdoc//lib/rdoc/options.rb#295 + # source://rdoc//lib/rdoc/options.rb#296 def tab_width; end # The number of columns in a tab # - # source://rdoc//lib/rdoc/options.rb#295 + # source://rdoc//lib/rdoc/options.rb#296 def tab_width=(_arg0); end # Template to be used when generating output # - # source://rdoc//lib/rdoc/options.rb#300 + # source://rdoc//lib/rdoc/options.rb#301 def template; end # Template to be used when generating output # - # source://rdoc//lib/rdoc/options.rb#300 + # source://rdoc//lib/rdoc/options.rb#301 def template=(_arg0); end # Directory the template lives in # - # source://rdoc//lib/rdoc/options.rb#305 + # source://rdoc//lib/rdoc/options.rb#306 def template_dir; end # Directory the template lives in # - # source://rdoc//lib/rdoc/options.rb#305 + # source://rdoc//lib/rdoc/options.rb#306 def template_dir=(_arg0); end # Finds the template dir for +template+ # - # source://rdoc//lib/rdoc/options.rb#1254 + # source://rdoc//lib/rdoc/options.rb#1333 def template_dir_for(template); end # Additional template stylesheets # - # source://rdoc//lib/rdoc/options.rb#310 + # source://rdoc//lib/rdoc/options.rb#311 def template_stylesheets; end # Additional template stylesheets # - # source://rdoc//lib/rdoc/options.rb#310 + # source://rdoc//lib/rdoc/options.rb#311 def template_stylesheets=(_arg0); end # Documentation title # - # source://rdoc//lib/rdoc/options.rb#315 + # source://rdoc//lib/rdoc/options.rb#316 def title; end # Documentation title # - # source://rdoc//lib/rdoc/options.rb#315 + # source://rdoc//lib/rdoc/options.rb#316 def title=(_arg0); end # For dumping YAML # - # source://rdoc//lib/rdoc/options.rb#523 + # source://rdoc//lib/rdoc/options.rb#573 def to_yaml(*options); end # Should RDoc update the timestamps in the output dir? # - # source://rdoc//lib/rdoc/options.rb#320 + # source://rdoc//lib/rdoc/options.rb#321 def update_output_dir; end # Should RDoc update the timestamps in the output dir? # - # source://rdoc//lib/rdoc/options.rb#320 + # source://rdoc//lib/rdoc/options.rb#321 def update_output_dir=(_arg0); end # Verbosity, zero means quiet # - # source://rdoc//lib/rdoc/options.rb#325 + # source://rdoc//lib/rdoc/options.rb#326 def verbosity; end # Verbosity, zero means quiet # - # source://rdoc//lib/rdoc/options.rb#325 + # source://rdoc//lib/rdoc/options.rb#326 def verbosity=(_arg0); end # Minimum visibility of a documented method. One of +:public+, +:protected+, @@ -8176,7 +8200,7 @@ class RDoc::Options # The +:nodoc+ visibility ignores all directives related to visibility. The # directive. # - # source://rdoc//lib/rdoc/options.rb#340 + # source://rdoc//lib/rdoc/options.rb#347 def visibility; end # Sets the minimum visibility of a documented method. @@ -8186,31 +8210,43 @@ class RDoc::Options # When +:all+ is passed, visibility is set to +:private+, similarly to # RDOCOPT="--all", see #visibility for more information. # - # source://rdoc//lib/rdoc/options.rb#1271 + # source://rdoc//lib/rdoc/options.rb#1350 def visibility=(visibility); end # Displays a warning using Kernel#warn if we're being verbose # - # source://rdoc//lib/rdoc/options.rb#1283 + # source://rdoc//lib/rdoc/options.rb#1362 def warn(message); end + # Warn if rdoc-ref links can't be resolved + # Default is +false+ + # + # source://rdoc//lib/rdoc/options.rb#332 + def warn_missing_rdoc_ref; end + + # Warn if rdoc-ref links can't be resolved + # Default is +false+ + # + # source://rdoc//lib/rdoc/options.rb#332 + def warn_missing_rdoc_ref=(_arg0); end + # URL of web cvs frontend # - # source://rdoc//lib/rdoc/options.rb#330 + # source://rdoc//lib/rdoc/options.rb#337 def webcvs; end # URL of web cvs frontend # - # source://rdoc//lib/rdoc/options.rb#330 + # source://rdoc//lib/rdoc/options.rb#337 def webcvs=(_arg0); end # Writes the YAML file .rdoc_options to the current directory containing the # parsed options. # - # source://rdoc//lib/rdoc/options.rb#1291 + # source://rdoc//lib/rdoc/options.rb#1370 def write_options; end - # source://rdoc//lib/rdoc/options.rb#423 + # source://rdoc//lib/rdoc/options.rb#465 def yaml_initialize(tag, map); end class << self @@ -8219,11 +8255,14 @@ class RDoc::Options # # @raise [RDoc::Error] # - # source://rdoc//lib/rdoc/options.rb#1305 + # source://rdoc//lib/rdoc/options.rb#1384 def load_options; end end end +# source://rdoc//lib/rdoc/options.rb#381 +RDoc::Options::DEFAULT_EXCLUDE = T.let(T.unsafe(nil), Array) + # A parser is simple a class that subclasses RDoc::Parser and implements #scan # to fill in an RDoc::TopLevel with parsed data. # @@ -8261,8 +8300,8 @@ class RDoc::Parser # # @return [Parser] a new instance of Parser # - # source://rdoc//lib/rdoc/parser.rb#252 - def initialize(top_level, file_name, content, options, stats); end + # source://rdoc//lib/rdoc/parser.rb#255 + def initialize(top_level, content, options, stats); end # The name of the file being parsed # @@ -8271,7 +8310,7 @@ class RDoc::Parser # Normalizes tabs in +body+ # - # source://rdoc//lib/rdoc/parser.rb#272 + # source://rdoc//lib/rdoc/parser.rb#275 def handle_tab_width(body); end class << self @@ -8302,20 +8341,20 @@ class RDoc::Parser # Returns the file type from the modeline in +file_name+ # - # source://rdoc//lib/rdoc/parser.rb#141 + # source://rdoc//lib/rdoc/parser.rb#143 def check_modeline(file_name); end # Finds and instantiates the correct parser for the given +file_name+ and # +content+. # - # source://rdoc//lib/rdoc/parser.rb#167 - def for(top_level, file_name, content, options, stats); end + # source://rdoc//lib/rdoc/parser.rb#169 + def for(top_level, content, options, stats); end # Record which file types this parser can understand. # # It is ok to call this multiple times. # - # source://rdoc//lib/rdoc/parser.rb#201 + # source://rdoc//lib/rdoc/parser.rb#204 def parse_files_matching(regexp); end # An Array of arrays that maps file extension (or name) regular @@ -8328,7 +8367,7 @@ class RDoc::Parser # Removes an emacs-style modeline from the first line of the document # - # source://rdoc//lib/rdoc/parser.rb#208 + # source://rdoc//lib/rdoc/parser.rb#211 def remove_modeline(content); end # If there is a markup: parser_name comment at the front of the @@ -8347,7 +8386,7 @@ class RDoc::Parser # # Any comment style may be used to hide the markup comment. # - # source://rdoc//lib/rdoc/parser.rb#229 + # source://rdoc//lib/rdoc/parser.rb#232 def use_markup(content); end # Checks if +file+ is a zip file in disguise. Signatures from @@ -8484,7 +8523,7 @@ class RDoc::Parser::C < ::RDoc::Parser # @return [C] a new instance of C # # source://rdoc//lib/rdoc/parser/c.rb#171 - def initialize(top_level, file_name, content, options, stats); end + def initialize(top_level, content, options, stats); end # Add alias, either from a direct alias definition, or from two # method that reference the same function. @@ -8514,42 +8553,42 @@ class RDoc::Parser::C < ::RDoc::Parser # Scans #content for rb_attr and rb_define_attr # - # source://rdoc//lib/rdoc/parser/c.rb#263 + # source://rdoc//lib/rdoc/parser/c.rb#261 def do_attrs; end # Scans #content for boot_defclass # - # source://rdoc//lib/rdoc/parser/c.rb#286 + # source://rdoc//lib/rdoc/parser/c.rb#284 def do_boot_defclass; end # Scans #content for rb_define_class, boot_defclass, rb_define_class_under # and rb_singleton_class # - # source://rdoc//lib/rdoc/parser/c.rb#298 + # source://rdoc//lib/rdoc/parser/c.rb#296 def do_classes_and_modules; end # Scans #content for rb_define_variable, rb_define_readonly_variable, # rb_define_const and rb_define_global_const # - # source://rdoc//lib/rdoc/parser/c.rb#396 + # source://rdoc//lib/rdoc/parser/c.rb#394 def do_constants; end # Scans #content for rb_include_module # - # source://rdoc//lib/rdoc/parser/c.rb#442 + # source://rdoc//lib/rdoc/parser/c.rb#441 def do_includes; end # Scans #content for rb_define_method, rb_define_singleton_method, # rb_define_module_function, rb_define_private_method, # rb_define_global_function and define_filetest_function # - # source://rdoc//lib/rdoc/parser/c.rb#458 + # source://rdoc//lib/rdoc/parser/c.rb#457 def do_methods; end # Creates classes and module that were missing were defined due to the file # order being different than the declaration order. # - # source://rdoc//lib/rdoc/parser/c.rb#507 + # source://rdoc//lib/rdoc/parser/c.rb#506 def do_missing; end # Dependencies from a missing enclosing class to the classes in @@ -8561,7 +8600,7 @@ class RDoc::Parser::C < ::RDoc::Parser # Finds the comment for an alias on +class_name+ from +new_name+ to # +old_name+ # - # source://rdoc//lib/rdoc/parser/c.rb#523 + # source://rdoc//lib/rdoc/parser/c.rb#522 def find_alias_comment(class_name, new_name, old_name); end # Finds a comment for rb_define_attr, rb_attr or Document-attr. @@ -8572,17 +8611,17 @@ class RDoc::Parser::C < ::RDoc::Parser # +read+ and +write+ are the read/write flags ('1' or '0'). Either both or # neither must be provided. # - # source://rdoc//lib/rdoc/parser/c.rb#541 + # source://rdoc//lib/rdoc/parser/c.rb#540 def find_attr_comment(var_name, attr_name, read = T.unsafe(nil), write = T.unsafe(nil)); end # Find the C code corresponding to a Ruby method # - # source://rdoc//lib/rdoc/parser/c.rb#598 + # source://rdoc//lib/rdoc/parser/c.rb#597 def find_body(class_name, meth_name, meth_obj, file_content, quiet = T.unsafe(nil)); end # Finds a RDoc::NormalClass or RDoc::NormalModule for +raw_name+ # - # source://rdoc//lib/rdoc/parser/c.rb#682 + # source://rdoc//lib/rdoc/parser/c.rb#681 def find_class(raw_name, name, base_name = T.unsafe(nil)); end # Look for class or module documentation above Init_+class_name+(void), @@ -8610,45 +8649,45 @@ class RDoc::Parser::C < ::RDoc::Parser # */ # VALUE cFoo = rb_define_class("Foo", rb_cObject); # - # source://rdoc//lib/rdoc/parser/c.rb#723 + # source://rdoc//lib/rdoc/parser/c.rb#722 def find_class_comment(class_name, class_mod); end # Finds a comment matching +type+ and +const_name+ either above the # comment or in the matching Document- section. # - # source://rdoc//lib/rdoc/parser/c.rb#779 + # source://rdoc//lib/rdoc/parser/c.rb#792 def find_const_comment(type, const_name, class_name = T.unsafe(nil)); end # Handles modifiers in +comment+ and updates +meth_obj+ as appropriate. # - # source://rdoc//lib/rdoc/parser/c.rb#796 + # source://rdoc//lib/rdoc/parser/c.rb#809 def find_modifiers(comment, meth_obj); end # Finds a Document-method override for +meth_obj+ on +class_name+ # - # source://rdoc//lib/rdoc/parser/c.rb#806 + # source://rdoc//lib/rdoc/parser/c.rb#819 def find_override_comment(class_name, meth_obj); end # Generate a Ruby-method table # - # source://rdoc//lib/rdoc/parser/c.rb#574 + # source://rdoc//lib/rdoc/parser/c.rb#573 def gen_body_table(file_content); end # Generate a const table # - # source://rdoc//lib/rdoc/parser/c.rb#756 + # source://rdoc//lib/rdoc/parser/c.rb#755 def gen_const_table(file_content); end # Creates a new RDoc::Attr +attr_name+ on class +var_name+ that is either # +read+, +write+ or both # - # source://rdoc//lib/rdoc/parser/c.rb#828 + # source://rdoc//lib/rdoc/parser/c.rb#841 def handle_attr(var_name, attr_name, read, write); end # Creates a new RDoc::NormalClass or RDoc::NormalModule based on +type+ # named +class_name+ in +parent+ which was assigned to the C +var_name+. # - # source://rdoc//lib/rdoc/parser/c.rb#857 + # source://rdoc//lib/rdoc/parser/c.rb#870 def handle_class_module(var_name, type, class_name, parent, in_module); end # Adds constants. By providing some_value: at the start of the comment you @@ -8660,24 +8699,24 @@ class RDoc::Parser::C < ::RDoc::Parser # Will override INT2FIX(300) with the value +300+ in the output # RDoc. Values may include quotes and escaped colons (\:). # - # source://rdoc//lib/rdoc/parser/c.rb#922 + # source://rdoc//lib/rdoc/parser/c.rb#935 def handle_constants(type, var_name, const_name, definition); end # Removes #ifdefs that would otherwise confuse us # - # source://rdoc//lib/rdoc/parser/c.rb#972 + # source://rdoc//lib/rdoc/parser/c.rb#985 def handle_ifdefs_in(body); end # Adds an RDoc::AnyMethod +meth_name+ defined on a class or module assigned # to +var_name+. +type+ is the type of method definition function used. # +singleton_method+ and +module_function+ create a singleton method. # - # source://rdoc//lib/rdoc/parser/c.rb#981 + # source://rdoc//lib/rdoc/parser/c.rb#994 def handle_method(type, var_name, meth_name, function, param_count, source_file = T.unsafe(nil)); end # Registers a singleton class +sclass_var+ as a singleton of +class_var+ # - # source://rdoc//lib/rdoc/parser/c.rb#1051 + # source://rdoc//lib/rdoc/parser/c.rb#1063 def handle_singleton(sclass_var, class_var); end # Maps C variable names to names of Ruby classes (and singleton classes) @@ -8688,7 +8727,7 @@ class RDoc::Parser::C < ::RDoc::Parser # Loads the variable map with the given +name+ from the RDoc::Store, if # present. # - # source://rdoc//lib/rdoc/parser/c.rb#1062 + # source://rdoc//lib/rdoc/parser/c.rb#1074 def load_variable_map(map_name); end # Look for directives in a normal comment block: @@ -8698,8 +8737,9 @@ class RDoc::Parser::C < ::RDoc::Parser # */ # # This method modifies the +comment+ + # Both :main: and :title: directives are deprecated and will be removed in RDoc 7. # - # source://rdoc//lib/rdoc/parser/c.rb#1091 + # source://rdoc//lib/rdoc/parser/c.rb#1104 def look_for_directives_in(context, comment); end # Classes found while parsing the C file that were not yet registered due to @@ -8710,25 +8750,25 @@ class RDoc::Parser::C < ::RDoc::Parser # Creates a RDoc::Comment instance. # - # source://rdoc//lib/rdoc/parser/c.rb#1221 + # source://rdoc//lib/rdoc/parser/c.rb#1252 def new_comment(text = T.unsafe(nil), location = T.unsafe(nil), language = T.unsafe(nil)); end # Extracts parameters from the +method_body+ and returns a method # parameter string. Follows 1.9.3dev's scan-arg-spec, see README.EXT # - # source://rdoc//lib/rdoc/parser/c.rb#1110 + # source://rdoc//lib/rdoc/parser/c.rb#1141 def rb_scan_args(method_body); end # Removes lines that are commented out that might otherwise get picked up # when scanning for classes and methods # - # source://rdoc//lib/rdoc/parser/c.rb#1193 + # source://rdoc//lib/rdoc/parser/c.rb#1224 def remove_commented_out_lines; end # Extracts the classes, modules, methods, attributes, constants and aliases # from a C file and returns an RDoc::TopLevel for this file # - # source://rdoc//lib/rdoc/parser/c.rb#1201 + # source://rdoc//lib/rdoc/parser/c.rb#1232 def scan; end # Maps C variable names to names of Ruby singleton classes @@ -8824,41 +8864,41 @@ end # The extension for Git commit log # -# source://rdoc//lib/rdoc/parser/changelog.rb#222 +# source://rdoc//lib/rdoc/parser/changelog.rb#223 module RDoc::Parser::ChangeLog::Git # Returns a list of ChangeLog entries as # RDoc::Parser::ChangeLog::Git::LogEntry list for the given # +entries+. # - # source://rdoc//lib/rdoc/parser/changelog.rb#262 + # source://rdoc//lib/rdoc/parser/changelog.rb#263 def create_entries(entries); end # Parses the entries in the Git commit logs # - # source://rdoc//lib/rdoc/parser/changelog.rb#235 + # source://rdoc//lib/rdoc/parser/changelog.rb#236 def parse_entries; end - # Parses auxiliary info. Currentry `base-url` to expand + # Parses auxiliary info. Currently `base-url` to expand # references is effective. # - # source://rdoc//lib/rdoc/parser/changelog.rb#227 + # source://rdoc//lib/rdoc/parser/changelog.rb#228 def parse_info(info); end end -# source://rdoc//lib/rdoc/parser/changelog.rb#271 +# source://rdoc//lib/rdoc/parser/changelog.rb#272 RDoc::Parser::ChangeLog::Git::HEADING_LEVEL = T.let(T.unsafe(nil), Integer) -# source://rdoc//lib/rdoc/parser/changelog.rb#270 +# source://rdoc//lib/rdoc/parser/changelog.rb#271 class RDoc::Parser::ChangeLog::Git::LogEntry < ::Struct # @return [LogEntry] a new instance of LogEntry # - # source://rdoc//lib/rdoc/parser/changelog.rb#273 + # source://rdoc//lib/rdoc/parser/changelog.rb#274 def initialize(base, commit, author, email, date, contents); end - # source://rdoc//lib/rdoc/parser/changelog.rb#313 + # source://rdoc//lib/rdoc/parser/changelog.rb#314 def accept(visitor); end - # source://rdoc//lib/rdoc/parser/changelog.rb#294 + # source://rdoc//lib/rdoc/parser/changelog.rb#295 def aref; end # Returns the value of attribute author @@ -8927,16 +8967,16 @@ class RDoc::Parser::ChangeLog::Git::LogEntry < ::Struct # @return [Object] the newly set value def email=(_); end - # source://rdoc//lib/rdoc/parser/changelog.rb#298 + # source://rdoc//lib/rdoc/parser/changelog.rb#299 def label(context = T.unsafe(nil)); end - # source://rdoc//lib/rdoc/parser/changelog.rb#290 + # source://rdoc//lib/rdoc/parser/changelog.rb#291 def level; end - # source://rdoc//lib/rdoc/parser/changelog.rb#330 + # source://rdoc//lib/rdoc/parser/changelog.rb#331 def pretty_print(q); end - # source://rdoc//lib/rdoc/parser/changelog.rb#302 + # source://rdoc//lib/rdoc/parser/changelog.rb#303 def text; end class << self @@ -8982,41 +9022,41 @@ class RDoc::Parser::RipperStateLex # # @return [RipperStateLex] a new instance of RipperStateLex # - # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#576 + # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#278 def initialize(code); end - # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#322 + # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#27 def get_squashed_tk; end private - # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#465 + # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#168 def get_embdoc_tk(tk); end - # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#474 + # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#177 def get_heredoc_tk(heredoc_name, indent); end - # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#549 + # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#252 def get_op_tk(tk); end - # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#447 + # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#150 def get_regexp_tk(tk); end - # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#420 + # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#123 def get_string_tk(tk); end - # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#373 + # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#76 def get_symbol_tk(tk); end - # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#511 + # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#214 def get_words_tk(tk); end # @return [Boolean] # - # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#499 + # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#202 def heredoc_end?(name, indent, tk); end - # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#493 + # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#196 def retrieve_heredoc_info(tk); end class << self @@ -9024,87 +9064,42 @@ class RDoc::Parser::RipperStateLex # # @return [Boolean] # - # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#597 + # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#299 def end?(token); end # Returns tokens parsed from +code+. # - # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#584 + # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#286 def parse(code); end end end -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#20 +# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#14 RDoc::Parser::RipperStateLex::EXPR_ARG = T.let(T.unsafe(nil), Integer) -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#31 -RDoc::Parser::RipperStateLex::EXPR_ARG_ANY = T.let(T.unsafe(nil), Integer) - -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#16 -RDoc::Parser::RipperStateLex::EXPR_BEG = T.let(T.unsafe(nil), Integer) - -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#30 -RDoc::Parser::RipperStateLex::EXPR_BEG_ANY = T.let(T.unsafe(nil), Integer) - -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#25 -RDoc::Parser::RipperStateLex::EXPR_CLASS = T.let(T.unsafe(nil), Integer) - -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#21 -RDoc::Parser::RipperStateLex::EXPR_CMDARG = T.let(T.unsafe(nil), Integer) - -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#24 -RDoc::Parser::RipperStateLex::EXPR_DOT = T.let(T.unsafe(nil), Integer) - -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#17 +# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#12 RDoc::Parser::RipperStateLex::EXPR_END = T.let(T.unsafe(nil), Integer) -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#18 -RDoc::Parser::RipperStateLex::EXPR_ENDARG = T.let(T.unsafe(nil), Integer) - -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#19 +# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#13 RDoc::Parser::RipperStateLex::EXPR_ENDFN = T.let(T.unsafe(nil), Integer) -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#32 -RDoc::Parser::RipperStateLex::EXPR_END_ANY = T.let(T.unsafe(nil), Integer) - -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#28 -RDoc::Parser::RipperStateLex::EXPR_FITEM = T.let(T.unsafe(nil), Integer) - -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#23 -RDoc::Parser::RipperStateLex::EXPR_FNAME = T.let(T.unsafe(nil), Integer) - -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#26 -RDoc::Parser::RipperStateLex::EXPR_LABEL = T.let(T.unsafe(nil), Integer) - -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#27 -RDoc::Parser::RipperStateLex::EXPR_LABELED = T.let(T.unsafe(nil), Integer) - -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#22 -RDoc::Parser::RipperStateLex::EXPR_MID = T.let(T.unsafe(nil), Integer) - # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#15 -RDoc::Parser::RipperStateLex::EXPR_NONE = T.let(T.unsafe(nil), Integer) - -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#29 -RDoc::Parser::RipperStateLex::EXPR_VALUE = T.let(T.unsafe(nil), Integer) +RDoc::Parser::RipperStateLex::EXPR_FNAME = T.let(T.unsafe(nil), Integer) -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#312 +# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#17 class RDoc::Parser::RipperStateLex::InnerStateLex < ::Ripper::Filter # @return [InnerStateLex] a new instance of InnerStateLex # - # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#313 + # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#18 def initialize(code); end - # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#317 + # source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#22 def on_default(event, tok, data); end end -# TODO: Remove this constants after Ruby 2.4 EOL +# :stopdoc: # -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#11 -RDoc::Parser::RipperStateLex::RIPPER_HAS_LEX_STATE = T.let(T.unsafe(nil), TrueClass) - -# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#13 +# source://rdoc//lib/rdoc/parser/ripper_state_lex.rb#10 class RDoc::Parser::RipperStateLex::Token < ::Struct # Returns the value of attribute char_no # @@ -9299,7 +9294,7 @@ end # Note that by default, the :method: directive will be ignored if there is a # standard rdocable item following it. # -# source://rdoc//lib/rdoc/parser/ruby.rb#144 +# source://rdoc//lib/rdoc/parser/ruby.rb#153 class RDoc::Parser::Ruby < ::RDoc::Parser include ::RDoc::TokenStream include ::RDoc::Parser::RubyTools @@ -9308,56 +9303,56 @@ class RDoc::Parser::Ruby < ::RDoc::Parser # # @return [Ruby] a new instance of Ruby # - # source://rdoc//lib/rdoc/parser/ruby.rb#164 - def initialize(top_level, file_name, content, options, stats); end + # source://rdoc//lib/rdoc/parser/ruby.rb#173 + def initialize(top_level, content, options, stats); end # Look for the first comment in a file that isn't a shebang line. # - # source://rdoc//lib/rdoc/parser/ruby.rb#236 + # source://rdoc//lib/rdoc/parser/ruby.rb#245 def collect_first_comment; end # Consumes trailing whitespace from the token stream # - # source://rdoc//lib/rdoc/parser/ruby.rb#279 + # source://rdoc//lib/rdoc/parser/ruby.rb#288 def consume_trailing_spaces; end # Creates a new attribute in +container+ with +name+. # - # source://rdoc//lib/rdoc/parser/ruby.rb#286 + # source://rdoc//lib/rdoc/parser/ruby.rb#295 def create_attr(container, single, name, rw, comment); end # Creates a module alias in +container+ at +rhs_name+ (or at the top-level # for "::") with the name from +constant+. # - # source://rdoc//lib/rdoc/parser/ruby.rb#300 + # source://rdoc//lib/rdoc/parser/ruby.rb#309 def create_module_alias(container, constant, rhs_name); end # Aborts with +msg+ # - # source://rdoc//lib/rdoc/parser/ruby.rb#313 + # source://rdoc//lib/rdoc/parser/ruby.rb#322 def error(msg); end # Looks for a true or false token. # - # source://rdoc//lib/rdoc/parser/ruby.rb#322 + # source://rdoc//lib/rdoc/parser/ruby.rb#331 def get_bool; end # Look for the name of a class of module (optionally with a leading :: or # with :: separated named) and return the ultimate name, the associated # container, and the given name (with the ::). # - # source://rdoc//lib/rdoc/parser/ruby.rb#340 + # source://rdoc//lib/rdoc/parser/ruby.rb#349 def get_class_or_module(container, ignore_constants = T.unsafe(nil)); end # Return a superclass, which can be either a constant of an expression # - # source://rdoc//lib/rdoc/parser/ruby.rb#423 + # source://rdoc//lib/rdoc/parser/ruby.rb#432 def get_class_specification; end # Parse a constant, which might be qualified by one or more class or module # names # - # source://rdoc//lib/rdoc/parser/ruby.rb#456 + # source://rdoc//lib/rdoc/parser/ruby.rb#465 def get_constant; end # Little hack going on here. In the statement: @@ -9367,28 +9362,28 @@ class RDoc::Parser::Ruby < ::RDoc::Parser # We see the RPAREN as the next token, so we need to exit early. This still # won't catch all cases (such as "a = yield + 1" # - # source://rdoc//lib/rdoc/parser/ruby.rb#558 + # source://rdoc//lib/rdoc/parser/ruby.rb#567 def get_end_token(tk); end # Get an included module that may be surrounded by parens # - # source://rdoc//lib/rdoc/parser/ruby.rb#473 + # source://rdoc//lib/rdoc/parser/ruby.rb#482 def get_included_module_with_optional_parens; end # Retrieves the method container for a singleton method. # - # source://rdoc//lib/rdoc/parser/ruby.rb#578 + # source://rdoc//lib/rdoc/parser/ruby.rb#587 def get_method_container(container, name_t); end # Extracts a name or symbol from the token stream. # - # source://rdoc//lib/rdoc/parser/ruby.rb#621 + # source://rdoc//lib/rdoc/parser/ruby.rb#630 def get_symbol_or_name; end # Retrieves the read token stream and replaces +pattern+ with +replacement+ # using gsub. If the result is only a ";" returns an empty string. # - # source://rdoc//lib/rdoc/parser/ruby.rb#194 + # source://rdoc//lib/rdoc/parser/ruby.rb#203 def get_tkread_clean(pattern, replacement); end # Extracts the visibility information for the visibility token +tk+ @@ -9398,7 +9393,7 @@ class RDoc::Parser::Ruby < ::RDoc::Parser # +singleton+ if the methods following should be converted to singleton # methods. # - # source://rdoc//lib/rdoc/parser/ruby.rb#208 + # source://rdoc//lib/rdoc/parser/ruby.rb#217 def get_visibility_information(tk, single); end # Look for directives in a normal comment block: @@ -9408,108 +9403,108 @@ class RDoc::Parser::Ruby < ::RDoc::Parser # # This routine modifies its +comment+ parameter. # - # source://rdoc//lib/rdoc/parser/ruby.rb#661 + # source://rdoc//lib/rdoc/parser/ruby.rb#670 def look_for_directives_in(container, comment); end # Adds useful info about the parser to +message+ # - # source://rdoc//lib/rdoc/parser/ruby.rb#681 + # source://rdoc//lib/rdoc/parser/ruby.rb#690 def make_message(message); end # Creates a comment with the correct format # - # source://rdoc//lib/rdoc/parser/ruby.rb#693 + # source://rdoc//lib/rdoc/parser/ruby.rb#702 def new_comment(comment, line_no = T.unsafe(nil)); end # Parses an +alias+ in +context+ with +comment+ # - # source://rdoc//lib/rdoc/parser/ruby.rb#762 + # source://rdoc//lib/rdoc/parser/ruby.rb#771 def parse_alias(context, single, tk, comment); end # Creates an RDoc::Attr for the name following +tk+, setting the comment to # +comment+. # - # source://rdoc//lib/rdoc/parser/ruby.rb#704 + # source://rdoc//lib/rdoc/parser/ruby.rb#713 def parse_attr(context, single, tk, comment); end # Creates an RDoc::Attr for each attribute listed after +tk+, setting the # comment for each to +comment+. # - # source://rdoc//lib/rdoc/parser/ruby.rb#733 + # source://rdoc//lib/rdoc/parser/ruby.rb#742 def parse_attr_accessor(context, single, tk, comment); end # Extracts call parameters from the token stream. # - # source://rdoc//lib/rdoc/parser/ruby.rb#801 + # source://rdoc//lib/rdoc/parser/ruby.rb#811 def parse_call_parameters(tk); end # Parses a class in +context+ with +comment+ # - # source://rdoc//lib/rdoc/parser/ruby.rb#844 + # source://rdoc//lib/rdoc/parser/ruby.rb#854 def parse_class(container, single, tk, comment); end # Parses and creates a regular class # - # source://rdoc//lib/rdoc/parser/ruby.rb#878 + # source://rdoc//lib/rdoc/parser/ruby.rb#888 def parse_class_regular(container, declaration_context, single, name_t, given_name, comment); end # Parses a singleton class in +container+ with the given +name+ and # +comment+. # - # source://rdoc//lib/rdoc/parser/ruby.rb#918 + # source://rdoc//lib/rdoc/parser/ruby.rb#928 def parse_class_singleton(container, name, comment); end # Generates an RDoc::Method or RDoc::Attr from +comment+ by looking for # :method: or :attr: directives in +comment+. # - # source://rdoc//lib/rdoc/parser/ruby.rb#1083 + # source://rdoc//lib/rdoc/parser/ruby.rb#1093 def parse_comment(container, tk, comment); end # Parse a comment that is describing an attribute in +container+ with the # given +name+ and +comment+. # - # source://rdoc//lib/rdoc/parser/ruby.rb#1111 + # source://rdoc//lib/rdoc/parser/ruby.rb#1121 def parse_comment_attr(container, type, name, comment); end - # source://rdoc//lib/rdoc/parser/ruby.rb#1123 + # source://rdoc//lib/rdoc/parser/ruby.rb#1133 def parse_comment_ghost(container, text, name, column, line_no, comment); end # Creates an RDoc::Method on +container+ from +comment+ if there is a # Signature section in the comment # - # source://rdoc//lib/rdoc/parser/ruby.rb#1162 + # source://rdoc//lib/rdoc/parser/ruby.rb#1172 def parse_comment_tomdoc(container, tk, comment); end # Parses a constant in +context+ with +comment+. If +ignore_constants+ is # true, no found constants will be added to RDoc. # - # source://rdoc//lib/rdoc/parser/ruby.rb#957 + # source://rdoc//lib/rdoc/parser/ruby.rb#967 def parse_constant(container, tk, comment, ignore_constants = T.unsafe(nil)); end - # source://rdoc//lib/rdoc/parser/ruby.rb#1024 + # source://rdoc//lib/rdoc/parser/ruby.rb#1034 def parse_constant_body(container, constant, is_array_or_hash); end # Parses a Module#private_constant or Module#public_constant call from +tk+. # - # source://rdoc//lib/rdoc/parser/ruby.rb#2094 + # source://rdoc//lib/rdoc/parser/ruby.rb#2109 def parse_constant_visibility(container, single, tk); end # Parses an +include+ or +extend+, indicated by the +klass+ and adds it to # +container+ # with +comment+ # - # source://rdoc//lib/rdoc/parser/ruby.rb#1197 + # source://rdoc//lib/rdoc/parser/ruby.rb#1207 def parse_extend_or_include(klass, container, comment); end # Parses identifiers that can create new methods or change visibility. # # Returns true if the comment was not consumed. # - # source://rdoc//lib/rdoc/parser/ruby.rb#1235 + # source://rdoc//lib/rdoc/parser/ruby.rb#1245 def parse_identifier(container, single, tk, comment); end # Parses an +included+ with a block feature of ActiveSupport::Concern. # - # source://rdoc//lib/rdoc/parser/ruby.rb#1217 + # source://rdoc//lib/rdoc/parser/ruby.rb#1227 def parse_included_with_activesupport_concern(container, comment); end # Parses a meta-programmed attribute and creates an RDoc::Attr. @@ -9540,34 +9535,34 @@ class RDoc::Parser::Ruby < ::RDoc::Parser # # end # - # source://rdoc//lib/rdoc/parser/ruby.rb#1299 + # source://rdoc//lib/rdoc/parser/ruby.rb#1309 def parse_meta_attr(context, single, tk, comment); end # Parses a meta-programmed method # - # source://rdoc//lib/rdoc/parser/ruby.rb#1333 + # source://rdoc//lib/rdoc/parser/ruby.rb#1343 def parse_meta_method(container, single, tk, comment); end # Parses the name of a metaprogrammed method. +comment+ is used to # determine the name while +tk+ is used in an error message if the name # cannot be determined. # - # source://rdoc//lib/rdoc/parser/ruby.rb#1379 + # source://rdoc//lib/rdoc/parser/ruby.rb#1388 def parse_meta_method_name(comment, tk); end # Parses the parameters and block for a meta-programmed method. # - # source://rdoc//lib/rdoc/parser/ruby.rb#1403 + # source://rdoc//lib/rdoc/parser/ruby.rb#1412 def parse_meta_method_params(container, single, meth, tk, comment); end # Parses a normal method defined by +def+ # - # source://rdoc//lib/rdoc/parser/ruby.rb#1435 + # source://rdoc//lib/rdoc/parser/ruby.rb#1444 def parse_method(container, single, tk, comment); end # Parses a method that needs to be ignored. # - # source://rdoc//lib/rdoc/parser/ruby.rb#1514 + # source://rdoc//lib/rdoc/parser/ruby.rb#1528 def parse_method_dummy(container); end # Parses the name of a method in +container+. @@ -9575,25 +9570,25 @@ class RDoc::Parser::Ruby < ::RDoc::Parser # Returns the method name, the container it is in (for def Foo.name) and if # it is a singleton or regular method. # - # source://rdoc//lib/rdoc/parser/ruby.rb#1527 + # source://rdoc//lib/rdoc/parser/ruby.rb#1541 def parse_method_name(container); end # For the given +container+ and initial name token +name_t+ the method name # is parsed from the token stream for a regular method. # - # source://rdoc//lib/rdoc/parser/ruby.rb#1554 + # source://rdoc//lib/rdoc/parser/ruby.rb#1568 def parse_method_name_regular(container, name_t); end # For the given +container+ and initial name token +name_t+ the method name # and the new +container+ (if necessary) are parsed from the token stream # for a singleton method. # - # source://rdoc//lib/rdoc/parser/ruby.rb#1572 + # source://rdoc//lib/rdoc/parser/ruby.rb#1586 def parse_method_name_singleton(container, name_t); end # Extracts +yield+ parameters from +method+ # - # source://rdoc//lib/rdoc/parser/ruby.rb#1616 + # source://rdoc//lib/rdoc/parser/ruby.rb#1630 def parse_method_or_yield_parameters(method = T.unsafe(nil), modifiers = T.unsafe(nil)); end # Capture the method's parameters. Along the way, look for a comment @@ -9603,69 +9598,69 @@ class RDoc::Parser::Ruby < ::RDoc::Parser # # and add this as the block_params for the method # - # source://rdoc//lib/rdoc/parser/ruby.rb#1683 + # source://rdoc//lib/rdoc/parser/ruby.rb#1697 def parse_method_parameters(method); end # Parses the parameters and body of +meth+ # - # source://rdoc//lib/rdoc/parser/ruby.rb#1484 + # source://rdoc//lib/rdoc/parser/ruby.rb#1498 def parse_method_params_and_body(container, single, meth, added_container); end # Parses an RDoc::NormalModule in +container+ with +comment+ # - # source://rdoc//lib/rdoc/parser/ruby.rb#1698 + # source://rdoc//lib/rdoc/parser/ruby.rb#1712 def parse_module(container, single, tk, comment); end # Parses an RDoc::Require in +context+ containing +comment+ # - # source://rdoc//lib/rdoc/parser/ruby.rb#1720 + # source://rdoc//lib/rdoc/parser/ruby.rb#1734 def parse_require(context, comment); end # Parses a rescue # - # source://rdoc//lib/rdoc/parser/ruby.rb#1741 + # source://rdoc//lib/rdoc/parser/ruby.rb#1755 def parse_rescue; end # The core of the Ruby parser. # - # source://rdoc//lib/rdoc/parser/ruby.rb#1772 + # source://rdoc//lib/rdoc/parser/ruby.rb#1786 def parse_statements(container, single = T.unsafe(nil), current_method = T.unsafe(nil), comment = T.unsafe(nil)); end # Parse up to +no+ symbol arguments # - # source://rdoc//lib/rdoc/parser/ruby.rb#1962 + # source://rdoc//lib/rdoc/parser/ruby.rb#1977 def parse_symbol_arg(no = T.unsafe(nil)); end # Parses up to +no+ symbol arguments surrounded by () and places them in # +args+. # - # source://rdoc//lib/rdoc/parser/ruby.rb#1977 + # source://rdoc//lib/rdoc/parser/ruby.rb#1992 def parse_symbol_arg_paren(no); end # Parses up to +no+ symbol arguments separated by spaces and places them in # +args+. # - # source://rdoc//lib/rdoc/parser/ruby.rb#2005 + # source://rdoc//lib/rdoc/parser/ruby.rb#2020 def parse_symbol_arg_space(no, tk); end # Returns symbol text from the next token # - # source://rdoc//lib/rdoc/parser/ruby.rb#2036 + # source://rdoc//lib/rdoc/parser/ruby.rb#2051 def parse_symbol_in_arg; end # Parses statements in the top-level +container+ # - # source://rdoc//lib/rdoc/parser/ruby.rb#2053 + # source://rdoc//lib/rdoc/parser/ruby.rb#2068 def parse_top_level_statements(container); end # Determines the visibility in +container+ from +tk+ # - # source://rdoc//lib/rdoc/parser/ruby.rb#2071 + # source://rdoc//lib/rdoc/parser/ruby.rb#2086 def parse_visibility(container, single, tk); end # Determines the block parameter for +context+ # - # source://rdoc//lib/rdoc/parser/ruby.rb#2110 + # source://rdoc//lib/rdoc/parser/ruby.rb#2125 def parse_yield(context, single, tk, method); end # Directives are modifier comments that can appear after class, module, or @@ -9680,7 +9675,7 @@ class RDoc::Parser::Ruby < ::RDoc::Parser # the name is in +allowed+. A directive can be found anywhere up to the end # of the current line. # - # source://rdoc//lib/rdoc/parser/ruby.rb#2131 + # source://rdoc//lib/rdoc/parser/ruby.rb#2146 def read_directive(allowed); end # Handles directives following the definition for +context+ (any @@ -9688,71 +9683,71 @@ class RDoc::Parser::Ruby < ::RDoc::Parser # # See also RDoc::Markup::PreProcess#handle_directive # - # source://rdoc//lib/rdoc/parser/ruby.rb#2163 + # source://rdoc//lib/rdoc/parser/ruby.rb#2178 def read_documentation_modifiers(context, allowed); end # Records the location of this +container+ in the file for this parser and # adds it to the list of classes and modules in the file. # - # source://rdoc//lib/rdoc/parser/ruby.rb#2182 + # source://rdoc//lib/rdoc/parser/ruby.rb#2197 def record_location(container); end # Retrieve comment body without =begin/=end # - # source://rdoc//lib/rdoc/parser/ruby.rb#1761 + # source://rdoc//lib/rdoc/parser/ruby.rb#1775 def retrieve_comment_body(tk); end # Scans this Ruby file for Ruby constructs # - # source://rdoc//lib/rdoc/parser/ruby.rb#2194 + # source://rdoc//lib/rdoc/parser/ruby.rb#2209 def scan; end # skip the var [in] part of a 'for' statement # - # source://rdoc//lib/rdoc/parser/ruby.rb#2282 + # source://rdoc//lib/rdoc/parser/ruby.rb#2297 def skip_for_variable; end # Skips the next method in +container+ # - # source://rdoc//lib/rdoc/parser/ruby.rb#2293 + # source://rdoc//lib/rdoc/parser/ruby.rb#2308 def skip_method(container); end # while, until, and for have an optional do # - # source://rdoc//lib/rdoc/parser/ruby.rb#2241 + # source://rdoc//lib/rdoc/parser/ruby.rb#2256 def skip_optional_do_after_expression; end # Skip opening parentheses and yield the block. # Skip closing parentheses too when exists. # - # source://rdoc//lib/rdoc/parser/ruby.rb#401 + # source://rdoc//lib/rdoc/parser/ruby.rb#410 def skip_parentheses(&block); end # Skip spaces until a comment is found # - # source://rdoc//lib/rdoc/parser/ruby.rb#2302 + # source://rdoc//lib/rdoc/parser/ruby.rb#2317 def skip_tkspace_comment(skip_nl = T.unsafe(nil)); end # Marks containers between +container+ and +ancestor+ as ignored # - # source://rdoc//lib/rdoc/parser/ruby.rb#646 + # source://rdoc//lib/rdoc/parser/ruby.rb#655 def suppress_parents(container, ancestor); end # Return +true+ if +tk+ is a newline. # # @return [Boolean] # - # source://rdoc//lib/rdoc/parser/ruby.rb#186 + # source://rdoc//lib/rdoc/parser/ruby.rb#195 def tk_nl?(tk); end # Updates visibility in +container+ from +vis_type+ and +vis+. # - # source://rdoc//lib/rdoc/parser/ruby.rb#2314 + # source://rdoc//lib/rdoc/parser/ruby.rb#2329 def update_visibility(container, vis_type, vis, singleton); end # Prints +message+ to +$stderr+ unless we're being quiet # - # source://rdoc//lib/rdoc/parser/ruby.rb#2359 + # source://rdoc//lib/rdoc/parser/ruby.rb#2374 def warn(message); end end @@ -9834,7 +9829,7 @@ class RDoc::Parser::Simple < ::RDoc::Parser # @return [Simple] a new instance of Simple # # source://rdoc//lib/rdoc/parser/simple.rb#17 - def initialize(top_level, file_name, content, options, stats); end + def initialize(top_level, content, options, stats); end # source://rdoc//lib/rdoc/parser/simple.rb#12 def content; end @@ -9873,310 +9868,310 @@ end # RD format parser for headings, paragraphs, lists, verbatim sections that # exist as blocks. # -# source://rdoc//lib/rdoc/rd/block_parser.rb#664 +# source://rdoc//lib/rdoc/rd/block_parser.rb#660 class RDoc::RD::BlockParser < ::Racc::Parser # Creates a new RDoc::RD::BlockParser. Use #parse to parse an rd-format # document. # # @return [BlockParser] a new instance of BlockParser # - # source://rdoc//lib/rdoc/rd/block_parser.rb#699 + # source://rdoc//lib/rdoc/rd/block_parser.rb#695 def initialize; end # reduce 0 omitted # - # source://rdoc//lib/rdoc/rd/block_parser.rb#1334 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1330 def _reduce_1(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1376 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1372 def _reduce_10(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1381 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1377 def _reduce_11(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1386 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1382 def _reduce_12(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1394 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1390 def _reduce_13(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1400 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1396 def _reduce_14(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1407 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1403 def _reduce_15(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1412 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1408 def _reduce_16(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1417 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1413 def _reduce_17(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1428 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1424 def _reduce_18(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1439 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1435 def _reduce_19(val, _values, result); end # @raise [ParseError] # - # source://rdoc//lib/rdoc/rd/block_parser.rb#1339 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1335 def _reduce_2(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1445 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1441 def _reduce_20(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1451 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1447 def _reduce_21(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1457 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1453 def _reduce_22(val, _values, result); end # reduce 26 omitted # - # source://rdoc//lib/rdoc/rd/block_parser.rb#1473 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1469 def _reduce_27(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1479 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1475 def _reduce_28(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1485 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1481 def _reduce_29(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1344 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1340 def _reduce_3(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1491 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1487 def _reduce_30(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1496 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1492 def _reduce_31(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1501 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1497 def _reduce_32(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1507 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1503 def _reduce_33(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1512 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1508 def _reduce_34(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1517 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1513 def _reduce_35(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1523 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1519 def _reduce_36(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1529 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1525 def _reduce_37(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1534 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1530 def _reduce_38(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1539 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1535 def _reduce_39(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1349 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1345 def _reduce_4(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1545 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1541 def _reduce_40(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1551 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1547 def _reduce_41(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1556 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1552 def _reduce_42(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1561 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1557 def _reduce_43(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1569 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1565 def _reduce_44(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1575 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1571 def _reduce_45(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1580 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1576 def _reduce_46(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1585 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1581 def _reduce_47(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1591 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1587 def _reduce_48(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1597 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1593 def _reduce_49(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1354 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1350 def _reduce_5(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1603 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1599 def _reduce_50(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1609 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1605 def _reduce_51(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1615 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1611 def _reduce_52(val, _values, result); end # reduce 53 omitted # - # source://rdoc//lib/rdoc/rd/block_parser.rb#1622 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1618 def _reduce_54(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1627 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1623 def _reduce_55(val, _values, result); end # reduce 56 omitted # - # source://rdoc//lib/rdoc/rd/block_parser.rb#1634 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1630 def _reduce_57(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1359 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1355 def _reduce_6(val, _values, result); end # reduce 61 omitted # - # source://rdoc//lib/rdoc/rd/block_parser.rb#1647 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1643 def _reduce_62(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1653 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1649 def _reduce_63(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1659 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1655 def _reduce_64(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1665 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1661 def _reduce_65(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1671 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1667 def _reduce_66(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1677 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1673 def _reduce_67(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1682 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1678 def _reduce_68(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1687 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1683 def _reduce_69(val, _values, result); end # reduce 70 omitted # - # source://rdoc//lib/rdoc/rd/block_parser.rb#1694 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1690 def _reduce_71(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1699 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1695 def _reduce_72(val, _values, result); end # reduce 7 omitted # - # source://rdoc//lib/rdoc/rd/block_parser.rb#1366 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1362 def _reduce_8(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1371 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1367 def _reduce_9(val, _values, result); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#1704 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1700 def _reduce_none(val, _values, result); end # Adds footnote +content+ to the document # - # source://rdoc//lib/rdoc/rd/block_parser.rb#1049 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1045 def add_footnote(content); end # Adds label +label+ to the document # - # source://rdoc//lib/rdoc/rd/block_parser.rb#1063 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1059 def add_label(label); end # Retrieves the content of +values+ as a single String # - # source://rdoc//lib/rdoc/rd/block_parser.rb#1032 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1028 def content(values); end # Footnotes for this document # - # source://rdoc//lib/rdoc/rd/block_parser.rb#683 + # source://rdoc//lib/rdoc/rd/block_parser.rb#679 def footnotes; end # Path to find included files in # - # source://rdoc//lib/rdoc/rd/block_parser.rb#693 + # source://rdoc//lib/rdoc/rd/block_parser.rb#689 def include_path; end # Path to find included files in # - # source://rdoc//lib/rdoc/rd/block_parser.rb#693 + # source://rdoc//lib/rdoc/rd/block_parser.rb#689 def include_path=(_arg0); end # Labels for items in this document # - # source://rdoc//lib/rdoc/rd/block_parser.rb#688 + # source://rdoc//lib/rdoc/rd/block_parser.rb#684 def labels; end # Current line number # - # source://rdoc//lib/rdoc/rd/block_parser.rb#987 + # source://rdoc//lib/rdoc/rd/block_parser.rb#983 def line_index; end # Returns the next token from the document # - # source://rdoc//lib/rdoc/rd/block_parser.rb#755 + # source://rdoc//lib/rdoc/rd/block_parser.rb#751 def next_token; end # Raises a ParseError when invalid formatting is found # # @raise [ParseError] # - # source://rdoc//lib/rdoc/rd/block_parser.rb#971 + # source://rdoc//lib/rdoc/rd/block_parser.rb#967 def on_error(et, ev, _values); end # Creates a paragraph for +value+ # - # source://rdoc//lib/rdoc/rd/block_parser.rb#1039 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1035 def paragraph(value); end # Parses +src+ and returns an RDoc::Markup::Document. # - # source://rdoc//lib/rdoc/rd/block_parser.rb#711 + # source://rdoc//lib/rdoc/rd/block_parser.rb#707 def parse(src); end private # Cuts off excess whitespace in +src+ # - # source://rdoc//lib/rdoc/rd/block_parser.rb#935 + # source://rdoc//lib/rdoc/rd/block_parser.rb#931 def cut_off(src); end # Formats line numbers +line_numbers+ prettily # - # source://rdoc//lib/rdoc/rd/block_parser.rb#1023 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1019 def format_line_num(*line_numbers); end # Retrieves the content for +file+ from the include_path # - # source://rdoc//lib/rdoc/rd/block_parser.rb#1004 + # source://rdoc//lib/rdoc/rd/block_parser.rb#1000 def get_included(file); end # Yields to the given block if +indent+ matches the current indent, otherwise # an indentation token is processed. # - # source://rdoc//lib/rdoc/rd/block_parser.rb#917 + # source://rdoc//lib/rdoc/rd/block_parser.rb#913 def if_current_indent_equal(indent); end # Parses subtree +src+ # - # source://rdoc//lib/rdoc/rd/block_parser.rb#994 + # source://rdoc//lib/rdoc/rd/block_parser.rb#990 def parse_subtree(src); end - # source://rdoc//lib/rdoc/rd/block_parser.rb#962 + # source://rdoc//lib/rdoc/rd/block_parser.rb#958 def set_term_to_element(parent, term); end end -# source://rdoc//lib/rdoc/rd/block_parser.rb#1328 +# source://rdoc//lib/rdoc/rd/block_parser.rb#1324 RDoc::RD::BlockParser::Racc_debug_parser = T.let(T.unsafe(nil), FalseClass) # Inline keeps track of markup and labels to create proper links. @@ -10229,234 +10224,234 @@ end # RD format parser for inline markup such as emphasis, links, footnotes, etc. # -# source://rdoc//lib/rdoc/rd/inline_parser.rb#665 +# source://rdoc//lib/rdoc/rd/inline_parser.rb#661 class RDoc::RD::InlineParser < ::Racc::Parser # Creates a new parser for inline markup in the rd format. The +block_parser+ # is used to for footnotes and labels in the inline text. # # @return [InlineParser] a new instance of InlineParser # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#738 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#734 def initialize(block_parser); end # reduce 100 omitted # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1750 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1746 def _reduce_101(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1757 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1753 def _reduce_102(val, _values, result); end # reduce 108 omitted # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1775 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1771 def _reduce_109(val, _values, result); end # reduce 110 omitted # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1782 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1778 def _reduce_111(val, _values, result); end # reduce 112 omitted # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1790 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1786 def _reduce_113(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1795 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1791 def _reduce_114(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1800 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1796 def _reduce_115(val, _values, result); end # reduce 12 omitted # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1413 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1409 def _reduce_13(val, _values, result); end # reduce 135 omitted # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1845 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1841 def _reduce_136(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1420 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1416 def _reduce_14(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1427 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1423 def _reduce_15(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1434 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1430 def _reduce_16(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1441 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1437 def _reduce_17(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1449 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1445 def _reduce_18(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1455 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1451 def _reduce_19(val, _values, result); end # reduce 1 omitted # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1385 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1381 def _reduce_2(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1463 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1459 def _reduce_20(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1469 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1465 def _reduce_21(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1478 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1474 def _reduce_22(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1484 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1480 def _reduce_23(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1490 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1486 def _reduce_24(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1496 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1492 def _reduce_25(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1505 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1501 def _reduce_26(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1511 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1507 def _reduce_27(val, _values, result); end # reduce 28 omitted # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1520 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1516 def _reduce_29(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1390 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1386 def _reduce_3(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1525 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1521 def _reduce_30(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1530 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1526 def _reduce_31(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1536 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1532 def _reduce_32(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1542 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1538 def _reduce_33(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1548 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1544 def _reduce_34(val, _values, result); end # reduce 35 omitted # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1556 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1552 def _reduce_36(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1561 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1557 def _reduce_37(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1566 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1562 def _reduce_38(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1572 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1568 def _reduce_39(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1578 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1574 def _reduce_40(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1584 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1580 def _reduce_41(val, _values, result); end # reduce 42 omitted # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1592 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1588 def _reduce_43(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1598 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1594 def _reduce_44(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1604 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1600 def _reduce_45(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1610 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1606 def _reduce_46(val, _values, result); end # reduce 56 omitted # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1636 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1632 def _reduce_57(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1642 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1638 def _reduce_58(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1648 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1644 def _reduce_59(val, _values, result); end - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1654 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1650 def _reduce_60(val, _values, result); end # reduce 61 omitted # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1661 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1657 def _reduce_62(val, _values, result); end # reduce 63 omitted # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1669 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1665 def _reduce_64(val, _values, result); end # reduce 77 omitted # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1701 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1697 def _reduce_78(val, _values, result); end # reduce 137 omitted # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#1852 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#1848 def _reduce_none(val, _values, result); end # Creates a new RDoc::RD::Inline for the +rdoc+ markup and the raw +reference+ # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#887 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#883 def inline(rdoc, reference = T.unsafe(nil)); end # Returns the next token from the inline text # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#756 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#752 def next_token; end # Returns words following an error # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#876 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#872 def next_words_on_error; end # Raises a ParseError when invalid formatting is found # # @raise [ParseError] # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#836 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#832 def on_error(et, ev, values); end # Parses the +inline+ text from RD format into RDoc format. # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#745 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#741 def parse(inline); end # Returns words before the error # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#853 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#849 def prev_words_on_error(ev); end private # Returns the last line of +src+ # - # source://rdoc//lib/rdoc/rd/inline_parser.rb#864 + # source://rdoc//lib/rdoc/rd/inline_parser.rb#860 def last_line(src); end end -# source://rdoc//lib/rdoc/rd/inline_parser.rb#1377 +# source://rdoc//lib/rdoc/rd/inline_parser.rb#1373 RDoc::RD::InlineParser::Racc_debug_parser = T.let(T.unsafe(nil), FalseClass) # This is the driver for generating RDoc output. It handles file parsing and @@ -10501,7 +10496,7 @@ class RDoc::RDoc # By default, output will be stored in a directory called "doc" below the # current directory, so make sure you're somewhere writable before invoking. # - # source://rdoc//lib/rdoc/rdoc.rb#450 + # source://rdoc//lib/rdoc/rdoc.rb#443 def document(options); end # Report an error message and exit @@ -10521,7 +10516,7 @@ class RDoc::RDoc # output dir using the generator selected # by the RDoc options # - # source://rdoc//lib/rdoc/rdoc.rb#515 + # source://rdoc//lib/rdoc/rdoc.rb#502 def generate; end # Generator instance used for creating output @@ -10554,7 +10549,7 @@ class RDoc::RDoc # files. However we may well contain subdirectories which must be tested # for .document files. # - # source://rdoc//lib/rdoc/rdoc.rb#323 + # source://rdoc//lib/rdoc/rdoc.rb#314 def list_files_in_directory(dir); end # Given a list of files and directories, create a list of all the Ruby @@ -10568,7 +10563,7 @@ class RDoc::RDoc # The effect of this is that if you want a file with a non-standard # extension parsed, you must name it explicitly. # - # source://rdoc//lib/rdoc/rdoc.rb#275 + # source://rdoc//lib/rdoc/rdoc.rb#266 def normalized_file_list(relative_files, force_doc = T.unsafe(nil), exclude_pattern = T.unsafe(nil)); end # RDoc options @@ -10583,35 +10578,35 @@ class RDoc::RDoc # Return the path name of the flag file in an output directory. # - # source://rdoc//lib/rdoc/rdoc.rb#240 + # source://rdoc//lib/rdoc/rdoc.rb#231 def output_flag_file(op_dir); end # The .document file contains a list of file and directory name patterns, # representing candidates for documentation. It may also contain comments # (starting with '#') # - # source://rdoc//lib/rdoc/rdoc.rb#249 + # source://rdoc//lib/rdoc/rdoc.rb#240 def parse_dot_doc_file(in_dir, filename); end # Parses +filename+ and returns an RDoc::TopLevel # - # source://rdoc//lib/rdoc/rdoc.rb#332 + # source://rdoc//lib/rdoc/rdoc.rb#323 def parse_file(filename); end # Parse each file on the command line, recursively entering directories. # - # source://rdoc//lib/rdoc/rdoc.rb#404 + # source://rdoc//lib/rdoc/rdoc.rb#394 def parse_files(files); end # Removes a siginfo handler and replaces the previous # - # source://rdoc//lib/rdoc/rdoc.rb#534 + # source://rdoc//lib/rdoc/rdoc.rb#522 def remove_siginfo_handler; end # Removes file extensions known to be unparseable from +files+ and TAGS # files for emacs and vim. # - # source://rdoc//lib/rdoc/rdoc.rb#428 + # source://rdoc//lib/rdoc/rdoc.rb#421 def remove_unparseable(files); end # Create an output dir if it doesn't exist. If it does exist, but doesn't @@ -10631,15 +10626,14 @@ class RDoc::RDoc # source://rdoc//lib/rdoc/rdoc.rb#72 def store; end - # Sets the current documentation tree to +store+ and sets the store's rdoc - # driver to this instance. + # The current documentation store # - # source://rdoc//lib/rdoc/rdoc.rb#215 - def store=(store); end + # source://rdoc//lib/rdoc/rdoc.rb#72 + def store=(_arg0); end # Update the flag file in an output directory. # - # source://rdoc//lib/rdoc/rdoc.rb#223 + # source://rdoc//lib/rdoc/rdoc.rb#214 def update_output_dir(op_dir, time, last = T.unsafe(nil)); end class << self @@ -10691,129 +10685,129 @@ class RDoc::RI::Driver # # @return [Driver] a new instance of Driver # - # source://rdoc//lib/rdoc/ri/driver.rb#391 + # source://rdoc//lib/rdoc/ri/driver.rb#402 def initialize(initial_options = T.unsafe(nil)); end # Adds paths for undocumented classes +also_in+ to +out+ # - # source://rdoc//lib/rdoc/ri/driver.rb#429 + # source://rdoc//lib/rdoc/ri/driver.rb#441 def add_also_in(out, also_in); end # Adds a class header to +out+ for class +name+ which is described in # +classes+. # - # source://rdoc//lib/rdoc/ri/driver.rb#446 + # source://rdoc//lib/rdoc/ri/driver.rb#458 def add_class(out, name, classes); end # Adds +extends+ to +out+ # - # source://rdoc//lib/rdoc/ri/driver.rb#473 + # source://rdoc//lib/rdoc/ri/driver.rb#485 def add_extends(out, extends); end # Adds a list of +extensions+ to this module of the given +type+ to +out+. # add_includes and add_extends call this, so you should use those directly. # - # source://rdoc//lib/rdoc/ri/driver.rb#481 + # source://rdoc//lib/rdoc/ri/driver.rb#493 def add_extension_modules(out, type, extensions); end # Renders multiple included +modules+ from +store+ to +out+. # - # source://rdoc//lib/rdoc/ri/driver.rb#499 + # source://rdoc//lib/rdoc/ri/driver.rb#511 def add_extension_modules_multiple(out, store, modules); end # Adds a single extension module +include+ from +store+ to +out+ # - # source://rdoc//lib/rdoc/ri/driver.rb#526 + # source://rdoc//lib/rdoc/ri/driver.rb#538 def add_extension_modules_single(out, store, include); end # Adds "(from ...)" to +out+ for +store+ # - # source://rdoc//lib/rdoc/ri/driver.rb#466 + # source://rdoc//lib/rdoc/ri/driver.rb#478 def add_from(out, store); end # Adds +includes+ to +out+ # - # source://rdoc//lib/rdoc/ri/driver.rb#540 + # source://rdoc//lib/rdoc/ri/driver.rb#552 def add_includes(out, includes); end # Looks up the method +name+ and adds it to +out+ # - # source://rdoc//lib/rdoc/ri/driver.rb#547 + # source://rdoc//lib/rdoc/ri/driver.rb#559 def add_method(out, name); end # Adds documentation for all methods in +klass+ to +out+ # - # source://rdoc//lib/rdoc/ri/driver.rb#558 + # source://rdoc//lib/rdoc/ri/driver.rb#567 def add_method_documentation(out, klass); end # Adds a list of +methods+ to +out+ with a heading of +name+ # - # source://rdoc//lib/rdoc/ri/driver.rb#571 + # source://rdoc//lib/rdoc/ri/driver.rb#580 def add_method_list(out, methods, name); end # Returns ancestor classes of +klass+ # - # source://rdoc//lib/rdoc/ri/driver.rb#591 + # source://rdoc//lib/rdoc/ri/driver.rb#600 def ancestors_of(klass); end - # source://rdoc//lib/rdoc/ri/driver.rb#926 + # source://rdoc//lib/rdoc/ri/driver.rb#946 def check_did_you_mean; end # For RubyGems backwards compatibility # - # source://rdoc//lib/rdoc/ri/driver.rb#622 + # source://rdoc//lib/rdoc/ri/driver.rb#631 def class_cache; end # Builds a RDoc::Markup::Document from +found+, +klasess+ and +includes+ # - # source://rdoc//lib/rdoc/ri/driver.rb#628 + # source://rdoc//lib/rdoc/ri/driver.rb#637 def class_document(name, found, klasses, includes, extends); end # Adds the class +comment+ to +out+. # - # source://rdoc//lib/rdoc/ri/driver.rb#650 - def class_document_comment(out, comment); end + # source://rdoc//lib/rdoc/ri/driver.rb#660 + def class_document_comment(out, document); end # Adds the constants from +klass+ to the Document +out+. # - # source://rdoc//lib/rdoc/ri/driver.rb#670 + # source://rdoc//lib/rdoc/ri/driver.rb#680 def class_document_constants(out, klass); end # Hash mapping a known class or module to the stores it can be loaded from # - # source://rdoc//lib/rdoc/ri/driver.rb#694 + # source://rdoc//lib/rdoc/ri/driver.rb#704 def classes; end # Returns the stores wherein +name+ is found along with the classes, # extends and includes that match it # - # source://rdoc//lib/rdoc/ri/driver.rb#714 + # source://rdoc//lib/rdoc/ri/driver.rb#724 def classes_and_includes_and_extends_for(name); end # Completes +name+ based on the caches. For Readline # - # source://rdoc//lib/rdoc/ri/driver.rb#739 + # source://rdoc//lib/rdoc/ri/driver.rb#749 def complete(name); end - # source://rdoc//lib/rdoc/ri/driver.rb#750 + # source://rdoc//lib/rdoc/ri/driver.rb#760 def complete_klass(name, klass, selector, method, completions); end - # source://rdoc//lib/rdoc/ri/driver.rb#769 + # source://rdoc//lib/rdoc/ri/driver.rb#779 def complete_method(name, klass, selector, completions); end # Converts +document+ to text and writes it to the pager # - # source://rdoc//lib/rdoc/ri/driver.rb#789 + # source://rdoc//lib/rdoc/ri/driver.rb#807 def display(document); end # Outputs formatted RI data for class +name+. Groups undocumented classes # - # source://rdoc//lib/rdoc/ri/driver.rb#802 + # source://rdoc//lib/rdoc/ri/driver.rb#820 def display_class(name); end # Outputs formatted RI data for method +name+ # - # source://rdoc//lib/rdoc/ri/driver.rb#818 + # source://rdoc//lib/rdoc/ri/driver.rb#836 def display_method(name); end # Outputs formatted RI data for the class or method +name+. @@ -10821,39 +10815,42 @@ class RDoc::RI::Driver # Returns true if +name+ was found, false if it was not an alternative could # be guessed, raises an error if +name+ couldn't be guessed. # - # source://rdoc//lib/rdoc/ri/driver.rb#832 + # source://rdoc//lib/rdoc/ri/driver.rb#852 def display_name(name); end # Displays each name in +name+ # - # source://rdoc//lib/rdoc/ri/driver.rb#861 + # source://rdoc//lib/rdoc/ri/driver.rb#881 def display_names(names); end # Outputs formatted RI data for page +name+. # - # source://rdoc//lib/rdoc/ri/driver.rb#872 + # source://rdoc//lib/rdoc/ri/driver.rb#892 def display_page(name); end # Outputs a formatted RI page list for the pages in +store+. # - # source://rdoc//lib/rdoc/ri/driver.rb#903 + # source://rdoc//lib/rdoc/ri/driver.rb#923 def display_page_list(store, pages = T.unsafe(nil), search = T.unsafe(nil)); end # Expands abbreviated klass +klass+ into a fully-qualified class. "Zl::Da" # will be expanded to Zlib::DataError. # - # source://rdoc//lib/rdoc/ri/driver.rb#947 + # source://rdoc//lib/rdoc/ri/driver.rb#967 def expand_class(klass); end # Expands the class portion of +name+ into a fully-qualified class. See # #expand_class. # - # source://rdoc//lib/rdoc/ri/driver.rb#965 + # source://rdoc//lib/rdoc/ri/driver.rb#985 def expand_name(name); end + # source://rdoc//lib/rdoc/ri/driver.rb#1534 + def expand_rdoc_refs_at_the_bottom(out); end + # Filters the methods in +found+ trying to find a match for +name+. # - # source://rdoc//lib/rdoc/ri/driver.rb#981 + # source://rdoc//lib/rdoc/ri/driver.rb#1001 def filter_methods(found, name); end # Yields items matching +name+ including the store they were found in, the @@ -10861,7 +10858,7 @@ class RDoc::RI::Driver # types of methods to look up (from #method_type), and the method name being # searched for # - # source://rdoc//lib/rdoc/ri/driver.rb#999 + # source://rdoc//lib/rdoc/ri/driver.rb#1019 def find_methods(name); end # Finds a store that matches +name+ which can be the name of a gem, "ruby", @@ -10871,73 +10868,73 @@ class RDoc::RI::Driver # # @raise [RDoc::RI::Driver::NotFoundError] # - # source://rdoc//lib/rdoc/ri/driver.rb#1045 + # source://rdoc//lib/rdoc/ri/driver.rb#1065 def find_store(name); end # Creates a new RDoc::Markup::Formatter. If a formatter is given with -f, # use it. If we're outputting to a pager, use bs, otherwise ansi. # - # source://rdoc//lib/rdoc/ri/driver.rb#1062 + # source://rdoc//lib/rdoc/ri/driver.rb#1082 def formatter(io); end # Runs ri interactively using Readline if it is available. # - # source://rdoc//lib/rdoc/ri/driver.rb#1075 + # source://rdoc//lib/rdoc/ri/driver.rb#1095 def interactive; end # Lists classes known to ri starting with +names+. If +names+ is empty all # known classes are shown. # - # source://rdoc//lib/rdoc/ri/driver.rb#1114 + # source://rdoc//lib/rdoc/ri/driver.rb#1134 def list_known_classes(names = T.unsafe(nil)); end # Returns an Array of methods matching +name+ # - # source://rdoc//lib/rdoc/ri/driver.rb#1146 + # source://rdoc//lib/rdoc/ri/driver.rb#1166 def list_methods_matching(name); end # Loads RI data for method +name+ on +klass+ from +store+. +type+ and # +cache+ indicate if it is a class or instance method. # - # source://rdoc//lib/rdoc/ri/driver.rb#1185 + # source://rdoc//lib/rdoc/ri/driver.rb#1205 def load_method(store, cache, klass, type, name); end # Returns an Array of RI data for methods matching +name+ # - # source://rdoc//lib/rdoc/ri/driver.rb#1208 + # source://rdoc//lib/rdoc/ri/driver.rb#1229 def load_methods_matching(name); end # Returns a filtered list of methods matching +name+ # - # source://rdoc//lib/rdoc/ri/driver.rb#1229 + # source://rdoc//lib/rdoc/ri/driver.rb#1250 def lookup_method(name); end # Builds a RDoc::Markup::Document from +found+, +klasses+ and +includes+ # - # source://rdoc//lib/rdoc/ri/driver.rb#1254 - def method_document(name, filtered); end + # source://rdoc//lib/rdoc/ri/driver.rb#1275 + def method_document(out, name, filtered); end # Returns the type of method (:both, :instance, :class) for +selector+ # - # source://rdoc//lib/rdoc/ri/driver.rb#1272 + # source://rdoc//lib/rdoc/ri/driver.rb#1291 def method_type(selector); end # Returns a regular expression for +name+ that will match an # RDoc::AnyMethod's name. # - # source://rdoc//lib/rdoc/ri/driver.rb#1284 + # source://rdoc//lib/rdoc/ri/driver.rb#1303 def name_regexp(name); end # Paginates output through a pager program. # - # source://rdoc//lib/rdoc/ri/driver.rb#1298 + # source://rdoc//lib/rdoc/ri/driver.rb#1317 def page; end # Are we using a pager? # # @return [Boolean] # - # source://rdoc//lib/rdoc/ri/driver.rb#1316 + # source://rdoc//lib/rdoc/ri/driver.rb#1335 def paging?; end # Extracts the class, selector and method name parts from +name+ like @@ -10946,36 +10943,36 @@ class RDoc::RI::Driver # NOTE: Given Foo::Bar, Bar is considered a class even though it may be a # method # - # source://rdoc//lib/rdoc/ri/driver.rb#1327 + # source://rdoc//lib/rdoc/ri/driver.rb#1346 def parse_name(name); end # Renders the +klass+ from +store+ to +out+. If the klass has no # documentable items the class is added to +also_in+ instead. # - # source://rdoc//lib/rdoc/ri/driver.rb#1359 + # source://rdoc//lib/rdoc/ri/driver.rb#1378 def render_class(out, store, klass, also_in); end - # source://rdoc//lib/rdoc/ri/driver.rb#1389 + # source://rdoc//lib/rdoc/ri/driver.rb#1408 def render_method(out, store, method, name); end - # source://rdoc//lib/rdoc/ri/driver.rb#1409 + # source://rdoc//lib/rdoc/ri/driver.rb#1428 def render_method_arguments(out, arglists); end - # source://rdoc//lib/rdoc/ri/driver.rb#1418 + # source://rdoc//lib/rdoc/ri/driver.rb#1437 def render_method_comment(out, method, alias_for = T.unsafe(nil)); end - # source://rdoc//lib/rdoc/ri/driver.rb#1436 + # source://rdoc//lib/rdoc/ri/driver.rb#1455 def render_method_superclass(out, method); end # Looks up and displays ri data according to the options given. # - # source://rdoc//lib/rdoc/ri/driver.rb#1448 + # source://rdoc//lib/rdoc/ri/driver.rb#1467 def run; end # Sets up a pager program to pass output through. Tries the RI_PAGER and # PAGER environment variables followed by pager, less then more. # - # source://rdoc//lib/rdoc/ri/driver.rb#1468 + # source://rdoc//lib/rdoc/ri/driver.rb#1487 def setup_pager; end # Show all method documentation following a class or module @@ -10990,7 +10987,7 @@ class RDoc::RI::Driver # Starts a WEBrick server for ri. # - # source://rdoc//lib/rdoc/ri/driver.rb#1494 + # source://rdoc//lib/rdoc/ri/driver.rb#1513 def start_server; end # An RDoc::RI::Store for each entry in the RI path @@ -11021,17 +11018,17 @@ class RDoc::RI::Driver # Dump +data_path+ using pp # - # source://rdoc//lib/rdoc/ri/driver.rb#98 + # source://rdoc//lib/rdoc/ri/driver.rb#99 def dump(data_path); end # Parses +argv+ and returns a Hash of options # - # source://rdoc//lib/rdoc/ri/driver.rb#109 + # source://rdoc//lib/rdoc/ri/driver.rb#110 def process_args(argv); end # Runs the ri command line executable using +argv+ # - # source://rdoc//lib/rdoc/ri/driver.rb#376 + # source://rdoc//lib/rdoc/ri/driver.rb#387 def run(argv = T.unsafe(nil)); end end end @@ -11054,6 +11051,9 @@ class RDoc::RI::Driver::NotFoundError < ::RDoc::RI::Driver::Error def name; end end +# source://rdoc//lib/rdoc/ri/driver.rb#1532 +RDoc::RI::Driver::RDOC_REFS_REGEXP = T.let(T.unsafe(nil), Regexp) + # For RubyGems backwards compatibility # # source://rdoc//lib/rdoc/ri/formatter.rb#5 @@ -11148,55 +11148,55 @@ RDoc::RI::Store = RDoc::Store # A file loaded by \#require # -# source://rdoc//lib/rdoc/require.rb#5 +# source://rdoc//lib/rdoc/code_object/require.rb#5 class RDoc::Require < ::RDoc::CodeObject # Creates a new Require that loads +name+ with +comment+ # # @return [Require] a new instance of Require # - # source://rdoc//lib/rdoc/require.rb#15 + # source://rdoc//lib/rdoc/code_object/require.rb#15 def initialize(name, comment); end - # source://rdoc//lib/rdoc/require.rb#22 + # source://rdoc//lib/rdoc/code_object/require.rb#22 def inspect; end # Name of the required file # - # source://rdoc//lib/rdoc/require.rb#10 + # source://rdoc//lib/rdoc/code_object/require.rb#10 def name; end # Name of the required file # - # source://rdoc//lib/rdoc/require.rb#10 + # source://rdoc//lib/rdoc/code_object/require.rb#10 def name=(_arg0); end - # source://rdoc//lib/rdoc/require.rb#31 + # source://rdoc//lib/rdoc/code_object/require.rb#31 def to_s; end # The RDoc::TopLevel corresponding to this require, or +nil+ if not found. # - # source://rdoc//lib/rdoc/require.rb#38 + # source://rdoc//lib/rdoc/code_object/require.rb#38 def top_level; end end # A singleton class # -# source://rdoc//lib/rdoc/single_class.rb#5 +# source://rdoc//lib/rdoc/code_object/single_class.rb#5 class RDoc::SingleClass < ::RDoc::ClassModule # Adds the superclass to the included modules. # - # source://rdoc//lib/rdoc/single_class.rb#10 + # source://rdoc//lib/rdoc/code_object/single_class.rb#10 def ancestors; end - # source://rdoc//lib/rdoc/single_class.rb#14 + # source://rdoc//lib/rdoc/code_object/single_class.rb#14 def aref_prefix; end # The definition of this singleton class, class << MyClassName # - # source://rdoc//lib/rdoc/single_class.rb#21 + # source://rdoc//lib/rdoc/code_object/single_class.rb#21 def definition; end - # source://rdoc//lib/rdoc/single_class.rb#25 + # source://rdoc//lib/rdoc/code_object/single_class.rb#25 def pretty_print(q); end end @@ -11484,56 +11484,56 @@ class RDoc::Store # # @return [Store] a new instance of Store # - # source://rdoc//lib/rdoc/store.rb#127 - def initialize(path = T.unsafe(nil), type = T.unsafe(nil)); end + # source://rdoc//lib/rdoc/store.rb#123 + def initialize(options, path: T.unsafe(nil), type: T.unsafe(nil)); end # Adds +module+ as an enclosure (namespace) for the given +variable+ for C # files. # - # source://rdoc//lib/rdoc/store.rb#169 + # source://rdoc//lib/rdoc/store.rb#165 def add_c_enclosure(variable, namespace); end # Adds C variables from an RDoc::Parser::C # - # source://rdoc//lib/rdoc/store.rb#176 + # source://rdoc//lib/rdoc/store.rb#172 def add_c_variables(c_parser); end # Adds the file with +name+ as an RDoc::TopLevel to the store. Returns the # created RDoc::TopLevel. # - # source://rdoc//lib/rdoc/store.rb#188 + # source://rdoc//lib/rdoc/store.rb#184 def add_file(absolute_name, relative_name: T.unsafe(nil), parser: T.unsafe(nil)); end # Returns all classes discovered by RDoc # - # source://rdoc//lib/rdoc/store.rb#212 + # source://rdoc//lib/rdoc/store.rb#220 def all_classes; end # Returns all classes and modules discovered by RDoc # - # source://rdoc//lib/rdoc/store.rb#219 + # source://rdoc//lib/rdoc/store.rb#227 def all_classes_and_modules; end # All TopLevels known to RDoc # - # source://rdoc//lib/rdoc/store.rb#226 + # source://rdoc//lib/rdoc/store.rb#234 def all_files; end # Returns all modules discovered by RDoc # - # source://rdoc//lib/rdoc/store.rb#233 + # source://rdoc//lib/rdoc/store.rb#241 def all_modules; end # Ancestors cache accessor. Maps a klass name to an Array of its ancestors # in this store. If Foo in this store inherits from Object, Kernel won't be # listed (it will be included from ruby's ri store). # - # source://rdoc//lib/rdoc/store.rb#242 + # source://rdoc//lib/rdoc/store.rb#250 def ancestors; end # Attributes cache accessor. Maps a class to an Array of its attributes. # - # source://rdoc//lib/rdoc/store.rb#249 + # source://rdoc//lib/rdoc/store.rb#257 def attributes; end # Maps C variables to class or module names for each parsed C file. @@ -11557,39 +11557,39 @@ class RDoc::Store # The contents of the Store # - # source://rdoc//lib/rdoc/store.rb#112 + # source://rdoc//lib/rdoc/store.rb#108 def cache; end # Path to the cache file # - # source://rdoc//lib/rdoc/store.rb#256 + # source://rdoc//lib/rdoc/store.rb#264 def cache_path; end # Path to the ri data for +klass_name+ # - # source://rdoc//lib/rdoc/store.rb#263 + # source://rdoc//lib/rdoc/store.rb#271 def class_file(klass_name); end # Class methods cache accessor. Maps a class to an Array of its class # methods (not full name). # - # source://rdoc//lib/rdoc/store.rb#272 + # source://rdoc//lib/rdoc/store.rb#280 def class_methods; end # Path where data for +klass_name+ will be stored (methods or class data) # - # source://rdoc//lib/rdoc/store.rb#279 + # source://rdoc//lib/rdoc/store.rb#287 def class_path(klass_name); end # Hash of all classes known to RDoc # - # source://rdoc//lib/rdoc/store.rb#286 + # source://rdoc//lib/rdoc/store.rb#294 def classes_hash; end # Removes empty items and ensures item in each collection are unique and # sorted # - # source://rdoc//lib/rdoc/store.rb#294 + # source://rdoc//lib/rdoc/store.rb#302 def clean_cache_collection(collection); end # Prepares the RDoc code object tree for use by a generator. @@ -11607,7 +11607,7 @@ class RDoc::Store # # See also RDoc::Context#remove_from_documentation? # - # source://rdoc//lib/rdoc/store.rb#322 + # source://rdoc//lib/rdoc/store.rb#330 def complete(min_visibility); end # If true this Store will not write any files @@ -11622,53 +11622,53 @@ class RDoc::Store # The encoding of the contents in the Store # - # source://rdoc//lib/rdoc/store.rb#117 + # source://rdoc//lib/rdoc/store.rb#113 def encoding; end # The encoding of the contents in the Store # - # source://rdoc//lib/rdoc/store.rb#117 + # source://rdoc//lib/rdoc/store.rb#113 def encoding=(_arg0); end # Hash of all files known to RDoc # - # source://rdoc//lib/rdoc/store.rb#362 + # source://rdoc//lib/rdoc/store.rb#370 def files_hash; end # Finds the enclosure (namespace) for the given C +variable+. # - # source://rdoc//lib/rdoc/store.rb#369 + # source://rdoc//lib/rdoc/store.rb#377 def find_c_enclosure(variable); end # Finds the class with +name+ in all discovered classes # - # source://rdoc//lib/rdoc/store.rb#394 + # source://rdoc//lib/rdoc/store.rb#402 def find_class_named(name); end # Finds the class with +name+ starting in namespace +from+ # - # source://rdoc//lib/rdoc/store.rb#401 + # source://rdoc//lib/rdoc/store.rb#409 def find_class_named_from(name, from); end # Finds the class or module with +name+ # - # source://rdoc//lib/rdoc/store.rb#419 + # source://rdoc//lib/rdoc/store.rb#427 def find_class_or_module(name); end # Finds the file with +name+ in all discovered files # - # source://rdoc//lib/rdoc/store.rb#427 + # source://rdoc//lib/rdoc/store.rb#435 def find_file_named(name); end # Finds the module with +name+ in all discovered modules # - # source://rdoc//lib/rdoc/store.rb#434 + # source://rdoc//lib/rdoc/store.rb#442 def find_module_named(name); end # Returns the RDoc::TopLevel that is a text file and has the given # +file_name+ # - # source://rdoc//lib/rdoc/store.rb#442 + # source://rdoc//lib/rdoc/store.rb#450 def find_text_page(file_name); end # Finds unique classes/modules defined in +all_hash+, @@ -11677,7 +11677,7 @@ class RDoc::Store # -- # TODO aliases should be registered by Context#add_module_alias # - # source://rdoc//lib/rdoc/store.rb#455 + # source://rdoc//lib/rdoc/store.rb#463 def find_unique(all_hash); end # Fixes the erroneous BasicObject < Object in 1.9. @@ -11688,47 +11688,47 @@ class RDoc::Store # We fix BasicObject right away if we are running in a Ruby # version >= 1.9. # - # source://rdoc//lib/rdoc/store.rb#474 + # source://rdoc//lib/rdoc/store.rb#482 def fix_basic_object_inheritance; end # Friendly rendition of #path # - # source://rdoc//lib/rdoc/store.rb#483 + # source://rdoc//lib/rdoc/store.rb#491 def friendly_path; end - # source://rdoc//lib/rdoc/store.rb#495 + # source://rdoc//lib/rdoc/store.rb#503 def inspect; end # Instance methods cache accessor. Maps a class to an Array of its # instance methods (not full name). # - # source://rdoc//lib/rdoc/store.rb#503 + # source://rdoc//lib/rdoc/store.rb#511 def instance_methods; end # Loads all items from this store into memory. This recreates a # documentation tree for use by a generator # - # source://rdoc//lib/rdoc/store.rb#511 + # source://rdoc//lib/rdoc/store.rb#519 def load_all; end # Loads cache file for this store # - # source://rdoc//lib/rdoc/store.rb#559 + # source://rdoc//lib/rdoc/store.rb#567 def load_cache; end # Loads ri data for +klass_name+ and hooks it up to this store. # - # source://rdoc//lib/rdoc/store.rb#600 + # source://rdoc//lib/rdoc/store.rb#606 def load_class(klass_name); end # Loads ri data for +klass_name+ # - # source://rdoc//lib/rdoc/store.rb#618 + # source://rdoc//lib/rdoc/store.rb#624 def load_class_data(klass_name); end # Loads ri data for +method_name+ in +klass_name+ # - # source://rdoc//lib/rdoc/store.rb#633 + # source://rdoc//lib/rdoc/store.rb#637 def load_method(klass_name, method_name); end # Loads ri data for +page_name+ @@ -11739,44 +11739,49 @@ class RDoc::Store # Gets the main page for this RDoc store. This page is used as the root of # the RDoc server. # - # source://rdoc//lib/rdoc/store.rb#671 + # source://rdoc//lib/rdoc/store.rb#669 def main; end # Sets the main page for this RDoc store. # - # source://rdoc//lib/rdoc/store.rb#678 + # source://rdoc//lib/rdoc/store.rb#676 def main=(page); end # Converts the variable => ClassModule map +variables+ from a C parser into # a variable => class name map. # - # source://rdoc//lib/rdoc/store.rb#686 + # source://rdoc//lib/rdoc/store.rb#684 def make_variable_map(variables); end # Path to the ri data for +method_name+ in +klass_name+ # - # source://rdoc//lib/rdoc/store.rb#699 + # source://rdoc//lib/rdoc/store.rb#697 def method_file(klass_name, method_name); end # Modules cache accessor. An Array of all the module (and class) names in # the store. # - # source://rdoc//lib/rdoc/store.rb#713 + # source://rdoc//lib/rdoc/store.rb#711 def module_names; end # Hash of all modules known to RDoc # - # source://rdoc//lib/rdoc/store.rb#720 + # source://rdoc//lib/rdoc/store.rb#718 def modules_hash; end + # Returns the value of attribute options. + # + # source://rdoc//lib/rdoc/store.rb#97 + def options; end + # Returns the RDoc::TopLevel that is a text file and has the given +name+ # - # source://rdoc//lib/rdoc/store.rb#727 + # source://rdoc//lib/rdoc/store.rb#725 def page(name); end # Path to the ri data for +page_name+ # - # source://rdoc//lib/rdoc/store.rb#736 + # source://rdoc//lib/rdoc/store.rb#734 def page_file(page_name); end # Path this store reads or writes @@ -11789,48 +11794,41 @@ class RDoc::Store # source://rdoc//lib/rdoc/store.rb#95 def path=(_arg0); end - # The RDoc::RDoc driver for this parse tree. This allows classes consulting - # the documentation tree to access user-set options, for example. - # - # source://rdoc//lib/rdoc/store.rb#101 - def rdoc; end - - # The RDoc::RDoc driver for this parse tree. This allows classes consulting - # the documentation tree to access user-set options, for example. - # - # source://rdoc//lib/rdoc/store.rb#101 - def rdoc=(_arg0); end - # Removes from +all_hash+ the contexts that are nodoc or have no content. # # See RDoc::Context#remove_from_documentation? # - # source://rdoc//lib/rdoc/store.rb#747 + # source://rdoc//lib/rdoc/store.rb#745 def remove_nodoc(all_hash); end + # Make sure any references to C variable names are resolved to the corresponding class. + # + # source://rdoc//lib/rdoc/store.rb#200 + def resolve_c_superclasses; end + # Saves all entries in the store # - # source://rdoc//lib/rdoc/store.rb#757 + # source://rdoc//lib/rdoc/store.rb#755 def save; end # Writes the cache file for this store # - # source://rdoc//lib/rdoc/store.rb#782 + # source://rdoc//lib/rdoc/store.rb#780 def save_cache; end # Writes the ri data for +klass+ (or module) # - # source://rdoc//lib/rdoc/store.rb#809 + # source://rdoc//lib/rdoc/store.rb#807 def save_class(klass); end # Writes the ri data for +method+ on +klass+ # - # source://rdoc//lib/rdoc/store.rb#883 + # source://rdoc//lib/rdoc/store.rb#881 def save_method(klass, method); end # Writes the ri data for +page+ # - # source://rdoc//lib/rdoc/store.rb#906 + # source://rdoc//lib/rdoc/store.rb#904 def save_page(page); end # Source of the contents of this store. @@ -11841,62 +11839,70 @@ class RDoc::Store # ri directory the store is "site". For other stores the source is the # #path. # - # source://rdoc//lib/rdoc/store.rb#932 + # source://rdoc//lib/rdoc/store.rb#930 def source; end # Gets the title for this RDoc store. This is used as the title in each # page on the RDoc server # - # source://rdoc//lib/rdoc/store.rb#946 + # source://rdoc//lib/rdoc/store.rb#944 def title; end # Sets the title page for this RDoc store. # - # source://rdoc//lib/rdoc/store.rb#953 + # source://rdoc//lib/rdoc/store.rb#951 def title=(title); end # Type of ri datastore this was loaded from. See RDoc::RI::Driver, # RDoc::RI::Paths. # - # source://rdoc//lib/rdoc/store.rb#107 + # source://rdoc//lib/rdoc/store.rb#103 def type; end # Type of ri datastore this was loaded from. See RDoc::RI::Driver, # RDoc::RI::Paths. # - # source://rdoc//lib/rdoc/store.rb#107 + # source://rdoc//lib/rdoc/store.rb#103 def type=(_arg0); end # Returns the unique classes discovered by RDoc. # # ::complete must have been called prior to using this method. # - # source://rdoc//lib/rdoc/store.rb#962 + # source://rdoc//lib/rdoc/store.rb#960 def unique_classes; end # Returns the unique classes and modules discovered by RDoc. # ::complete must have been called prior to using this method. # - # source://rdoc//lib/rdoc/store.rb#970 + # source://rdoc//lib/rdoc/store.rb#968 def unique_classes_and_modules; end # Returns the unique modules discovered by RDoc. # ::complete must have been called prior to using this method. # - # source://rdoc//lib/rdoc/store.rb#978 + # source://rdoc//lib/rdoc/store.rb#976 def unique_modules; end # The lazy constants alias will be discovered in passing # - # source://rdoc//lib/rdoc/store.rb#122 + # source://rdoc//lib/rdoc/store.rb#118 def unmatched_constant_alias; end # Sets the parser of +absolute_name+, unless it from a source code file. # - # source://rdoc//lib/rdoc/store.rb#203 + # source://rdoc//lib/rdoc/store.rb#211 def update_parser_of_file(absolute_name, parser); end + + private + + # source://rdoc//lib/rdoc/store.rb#981 + def marshal_load(file); end end +# source://rdoc//lib/rdoc/store.rb#985 +RDoc::Store::MarshalFilter = T.let(T.unsafe(nil), Proc) + # Raised when a stored file for a class, module, page or method is missing. # # source://rdoc//lib/rdoc/store.rb#36 @@ -11996,96 +12002,96 @@ class RDoc::Task < ::Rake::TaskLib # @yield [_self] # @yieldparam _self [RDoc::Task] the object that the method was called on # - # source://rdoc//lib/rdoc/task.rb#158 + # source://rdoc//lib/rdoc/task.rb#157 def initialize(name = T.unsafe(nil)); end # The block passed to this method will be called just before running the # RDoc generator. It is allowed to modify RDoc::Task attributes inside the # block. # - # source://rdoc//lib/rdoc/task.rb#288 + # source://rdoc//lib/rdoc/task.rb#287 def before_running_rdoc(&block); end # Ensures that +names+ only includes names for the :rdoc, :clobber_rdoc and # :rerdoc. If other names are given an ArgumentError is raised. # - # source://rdoc//lib/rdoc/task.rb#174 + # source://rdoc//lib/rdoc/task.rb#173 def check_names(names); end # Task description for the clobber rdoc task or its renamed equivalent # - # source://rdoc//lib/rdoc/task.rb#188 + # source://rdoc//lib/rdoc/task.rb#187 def clobber_task_description; end # Task description for the coverage task or its renamed description # - # source://rdoc//lib/rdoc/task.rb#309 + # source://rdoc//lib/rdoc/task.rb#308 def coverage_task_description; end # Sets default task values # - # source://rdoc//lib/rdoc/task.rb#195 + # source://rdoc//lib/rdoc/task.rb#194 def defaults; end # Create the tasks defined by this task lib. # - # source://rdoc//lib/rdoc/task.rb#224 + # source://rdoc//lib/rdoc/task.rb#223 def define; end # Whether to run the rdoc process as an external shell (default is false) # - # source://rdoc//lib/rdoc/task.rb#152 + # source://rdoc//lib/rdoc/task.rb#151 def external; end # Whether to run the rdoc process as an external shell (default is false) # - # source://rdoc//lib/rdoc/task.rb#152 + # source://rdoc//lib/rdoc/task.rb#151 def external=(_arg0); end # Name of format generator (--format) used by rdoc. (defaults to # rdoc's default) # - # source://rdoc//lib/rdoc/task.rb#137 + # source://rdoc//lib/rdoc/task.rb#136 def generator; end # Name of format generator (--format) used by rdoc. (defaults to # rdoc's default) # - # source://rdoc//lib/rdoc/task.rb#137 + # source://rdoc//lib/rdoc/task.rb#136 def generator=(_arg0); end # All source is inline now. This method is deprecated # - # source://rdoc//lib/rdoc/task.rb#209 + # source://rdoc//lib/rdoc/task.rb#208 def inline_source; end # All source is inline now. This method is deprecated # - # source://rdoc//lib/rdoc/task.rb#217 + # source://rdoc//lib/rdoc/task.rb#216 def inline_source=(value); end # Name of file to be used as the main, top level file of the RDoc. (default # is none) # - # source://rdoc//lib/rdoc/task.rb#126 + # source://rdoc//lib/rdoc/task.rb#125 def main; end # Name of file to be used as the main, top level file of the RDoc. (default # is none) # - # source://rdoc//lib/rdoc/task.rb#126 + # source://rdoc//lib/rdoc/task.rb#125 def main=(_arg0); end - # Comment markup format. rdoc, rd and tomdoc are supported. (default is - # 'rdoc') + # The markup format; one of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+. + # See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats]. # - # source://rdoc//lib/rdoc/task.rb#110 + # source://rdoc//lib/rdoc/task.rb#109 def markup; end - # Comment markup format. rdoc, rd and tomdoc are supported. (default is - # 'rdoc') + # The markup format; one of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+. + # See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats]. # - # source://rdoc//lib/rdoc/task.rb#110 + # source://rdoc//lib/rdoc/task.rb#109 def markup=(_arg0); end # Name of the main, top level task. (default is :rdoc) @@ -12100,84 +12106,84 @@ class RDoc::Task < ::Rake::TaskLib # List of options that will be supplied to RDoc # - # source://rdoc//lib/rdoc/task.rb#272 + # source://rdoc//lib/rdoc/task.rb#271 def option_list; end # Additional list of options to be passed rdoc. (default is []) # - # source://rdoc//lib/rdoc/task.rb#147 + # source://rdoc//lib/rdoc/task.rb#146 def options; end # Additional list of options to be passed rdoc. (default is []) # - # source://rdoc//lib/rdoc/task.rb#147 + # source://rdoc//lib/rdoc/task.rb#146 def options=(_arg0); end # Name of directory to receive the html output files. (default is "html") # - # source://rdoc//lib/rdoc/task.rb#115 + # source://rdoc//lib/rdoc/task.rb#114 def rdoc_dir; end # Name of directory to receive the html output files. (default is "html") # - # source://rdoc//lib/rdoc/task.rb#115 + # source://rdoc//lib/rdoc/task.rb#114 def rdoc_dir=(_arg0); end # List of files to be included in the rdoc generation. (default is []) # - # source://rdoc//lib/rdoc/task.rb#142 + # source://rdoc//lib/rdoc/task.rb#141 def rdoc_files; end # List of files to be included in the rdoc generation. (default is []) # - # source://rdoc//lib/rdoc/task.rb#142 + # source://rdoc//lib/rdoc/task.rb#141 def rdoc_files=(_arg0); end # Task description for the rdoc task or its renamed equivalent # - # source://rdoc//lib/rdoc/task.rb#295 + # source://rdoc//lib/rdoc/task.rb#294 def rdoc_task_description; end # Task description for the rerdoc task or its renamed description # - # source://rdoc//lib/rdoc/task.rb#302 + # source://rdoc//lib/rdoc/task.rb#301 def rerdoc_task_description; end # Name of template to be used by rdoc. (defaults to rdoc's default) # - # source://rdoc//lib/rdoc/task.rb#131 + # source://rdoc//lib/rdoc/task.rb#130 def template; end # Name of template to be used by rdoc. (defaults to rdoc's default) # - # source://rdoc//lib/rdoc/task.rb#131 + # source://rdoc//lib/rdoc/task.rb#130 def template=(_arg0); end # Title of RDoc documentation. (defaults to rdoc's default) # - # source://rdoc//lib/rdoc/task.rb#120 + # source://rdoc//lib/rdoc/task.rb#119 def title; end # Title of RDoc documentation. (defaults to rdoc's default) # - # source://rdoc//lib/rdoc/task.rb#120 + # source://rdoc//lib/rdoc/task.rb#119 def title=(_arg0); end private - # source://rdoc//lib/rdoc/task.rb#326 + # source://rdoc//lib/rdoc/task.rb#325 def clobber_task_name; end - # source://rdoc//lib/rdoc/task.rb#340 + # source://rdoc//lib/rdoc/task.rb#339 def coverage_task_name; end - # source://rdoc//lib/rdoc/task.rb#315 + # source://rdoc//lib/rdoc/task.rb#314 def rdoc_target; end - # source://rdoc//lib/rdoc/task.rb#319 + # source://rdoc//lib/rdoc/task.rb#318 def rdoc_task_name; end - # source://rdoc//lib/rdoc/task.rb#333 + # source://rdoc//lib/rdoc/task.rb#332 def rerdoc_task_name; end end @@ -12321,13 +12327,7 @@ end # A parser for TomDoc based on TomDoc 1.0.0-rc1 (02adef9b5a) # -# The TomDoc specification can be found at: -# -# http://tomdoc.org -# -# The latest version of the TomDoc specification can be found at: -# -# https://github.com/mojombo/tomdoc/blob/master/tomdoc.md +# The TomDoc specification can be found at http://tomdoc.org. # # To choose TomDoc as your only default format see RDoc::Options@Saved+Options # for instructions on setting up a .rdoc_options file to store @@ -12357,13 +12357,13 @@ end # This class is documented in TomDoc format. Since this is a subclass of the # RDoc markup parser there isn't much to see here, unfortunately. # -# source://rdoc//lib/rdoc/tom_doc.rb#42 +# source://rdoc//lib/rdoc/tom_doc.rb#36 class RDoc::TomDoc < ::RDoc::Markup::Parser # Public: Creates a new TomDoc parser. See also RDoc::Markup::parse # # @return [TomDoc] a new instance of TomDoc # - # source://rdoc//lib/rdoc/tom_doc.rb#130 + # source://rdoc//lib/rdoc/tom_doc.rb#124 def initialize; end # Internal: Builds a heading from the token stream @@ -12372,7 +12372,7 @@ class RDoc::TomDoc < ::RDoc::Markup::Parser # # Returns an RDoc::Markup::Heading # - # source://rdoc//lib/rdoc/tom_doc.rb#143 + # source://rdoc//lib/rdoc/tom_doc.rb#137 def build_heading(level); end # Internal: Builds a paragraph from the token stream @@ -12381,7 +12381,7 @@ class RDoc::TomDoc < ::RDoc::Markup::Parser # # Returns an RDoc::Markup::Paragraph. # - # source://rdoc//lib/rdoc/tom_doc.rb#173 + # source://rdoc//lib/rdoc/tom_doc.rb#167 def build_paragraph(margin); end # Internal: Builds a verbatim from the token stream. A verbatim in the @@ -12392,12 +12392,12 @@ class RDoc::TomDoc < ::RDoc::Markup::Parser # # Returns an RDoc::Markup::Verbatim # - # source://rdoc//lib/rdoc/tom_doc.rb#159 + # source://rdoc//lib/rdoc/tom_doc.rb#153 def build_verbatim(margin); end # Detects a section change to "Returns" and adds a heading # - # source://rdoc//lib/rdoc/tom_doc.rb#213 + # source://rdoc//lib/rdoc/tom_doc.rb#207 def parse_text(parent, indent); end # Internal: Turns text into an Array of tokens @@ -12406,12 +12406,12 @@ class RDoc::TomDoc < ::RDoc::Markup::Parser # # Returns self. # - # source://rdoc//lib/rdoc/tom_doc.rb#231 + # source://rdoc//lib/rdoc/tom_doc.rb#225 def tokenize(text); end # Internal: Token accessor # - # source://rdoc//lib/rdoc/tom_doc.rb#46 + # source://rdoc//lib/rdoc/tom_doc.rb#40 def tokens; end class << self @@ -12420,7 +12420,7 @@ class RDoc::TomDoc < ::RDoc::Markup::Parser # # Returns nothing. # - # source://rdoc//lib/rdoc/tom_doc.rb#53 + # source://rdoc//lib/rdoc/tom_doc.rb#47 def add_post_processor; end # Public: Parses TomDoc from text @@ -12438,7 +12438,7 @@ class RDoc::TomDoc < ::RDoc::Markup::Parser # # Returns an RDoc::Markup::Document representing the TomDoc format. # - # source://rdoc//lib/rdoc/tom_doc.rb#84 + # source://rdoc//lib/rdoc/tom_doc.rb#78 def parse(text); end # Internal: Extracts the Signature section's method signature @@ -12448,14 +12448,14 @@ class RDoc::TomDoc < ::RDoc::Markup::Parser # # Returns a String containing the signature and nil if not # - # source://rdoc//lib/rdoc/tom_doc.rb#100 + # source://rdoc//lib/rdoc/tom_doc.rb#94 def signature(comment); end end end # A TopLevel context is a representation of the contents of a single file # -# source://rdoc//lib/rdoc/top_level.rb#5 +# source://rdoc//lib/rdoc/code_object/top_level.rb#5 class RDoc::TopLevel < ::RDoc::Context # Creates a new TopLevel for the file at +absolute_name+. If documentation # is being generated outside the source dir +relative_name+ is relative to @@ -12463,60 +12463,60 @@ class RDoc::TopLevel < ::RDoc::Context # # @return [TopLevel] a new instance of TopLevel # - # source://rdoc//lib/rdoc/top_level.rb#43 + # source://rdoc//lib/rdoc/code_object/top_level.rb#36 def initialize(absolute_name, relative_name = T.unsafe(nil)); end # An RDoc::TopLevel is equal to another with the same relative_name # - # source://rdoc//lib/rdoc/top_level.rb#67 + # source://rdoc//lib/rdoc/code_object/top_level.rb#58 def ==(other); end # Absolute name of this file # - # source://rdoc//lib/rdoc/top_level.rb#22 + # source://rdoc//lib/rdoc/code_object/top_level.rb#17 def absolute_name; end # Absolute name of this file # - # source://rdoc//lib/rdoc/top_level.rb#22 + # source://rdoc//lib/rdoc/code_object/top_level.rb#17 def absolute_name=(_arg0); end # Adds +an_alias+ to +Object+ instead of +self+. # - # source://rdoc//lib/rdoc/top_level.rb#76 + # source://rdoc//lib/rdoc/code_object/top_level.rb#67 def add_alias(an_alias); end # Adds +constant+ to +Object+ instead of +self+. # - # source://rdoc//lib/rdoc/top_level.rb#85 + # source://rdoc//lib/rdoc/code_object/top_level.rb#76 def add_constant(constant); end # Adds +include+ to +Object+ instead of +self+. # - # source://rdoc//lib/rdoc/top_level.rb#94 + # source://rdoc//lib/rdoc/code_object/top_level.rb#85 def add_include(include); end # Adds +method+ to +Object+ instead of +self+. # - # source://rdoc//lib/rdoc/top_level.rb#103 + # source://rdoc//lib/rdoc/code_object/top_level.rb#94 def add_method(method); end # Adds class or module +mod+. Used in the building phase # by the Ruby parser. # - # source://rdoc//lib/rdoc/top_level.rb#113 + # source://rdoc//lib/rdoc/code_object/top_level.rb#104 def add_to_classes_or_modules(mod); end # Base name of this file # - # source://rdoc//lib/rdoc/top_level.rb#120 + # source://rdoc//lib/rdoc/code_object/top_level.rb#111 def base_name; end # All the classes or modules that were declared in # this file. These are assigned to either +#classes_hash+ # or +#modules_hash+ once we know what they really are. # - # source://rdoc//lib/rdoc/top_level.rb#29 + # source://rdoc//lib/rdoc/code_object/top_level.rb#24 def classes_or_modules; end # Returns a URL for this source file on some web repository. Use the -W @@ -12525,151 +12525,130 @@ class RDoc::TopLevel < ::RDoc::Context # source://rdoc//lib/rdoc/generator/markup.rb#149 def cvs_url; end - # source://rdoc//lib/rdoc/top_level.rb#31 - def diagram; end - - # source://rdoc//lib/rdoc/top_level.rb#31 - def diagram=(_arg0); end - # Only a TopLevel that contains text file) will be displayed. See also # RDoc::CodeObject#display? # # @return [Boolean] # - # source://rdoc//lib/rdoc/top_level.rb#130 + # source://rdoc//lib/rdoc/code_object/top_level.rb#121 def display?; end # An RDoc::TopLevel is equal to another with the same relative_name # - # source://rdoc//lib/rdoc/top_level.rb#67 + # source://rdoc//lib/rdoc/code_object/top_level.rb#58 def eql?(other); end - # This TopLevel's File::Stat struct - # - # source://rdoc//lib/rdoc/top_level.rb#12 - def file_stat; end - - # This TopLevel's File::Stat struct - # - # source://rdoc//lib/rdoc/top_level.rb#12 - def file_stat=(_arg0); end - # See RDoc::TopLevel::find_class_or_module # -- # TODO Why do we search through all classes/modules found, not just the # ones of this instance? # - # source://rdoc//lib/rdoc/top_level.rb#140 + # source://rdoc//lib/rdoc/code_object/top_level.rb#131 def find_class_or_module(name); end # Finds a class or module named +symbol+ # - # source://rdoc//lib/rdoc/top_level.rb#147 + # source://rdoc//lib/rdoc/code_object/top_level.rb#138 def find_local_symbol(symbol); end # Finds a module or class with +name+ # - # source://rdoc//lib/rdoc/top_level.rb#154 + # source://rdoc//lib/rdoc/code_object/top_level.rb#145 def find_module_named(name); end # Returns the relative name of this file # - # source://rdoc//lib/rdoc/top_level.rb#161 + # source://rdoc//lib/rdoc/code_object/top_level.rb#152 def full_name; end # An RDoc::TopLevel has the same hash as another with the same # relative_name # - # source://rdoc//lib/rdoc/top_level.rb#169 + # source://rdoc//lib/rdoc/code_object/top_level.rb#160 def hash; end # URL for this with a +prefix+ # - # source://rdoc//lib/rdoc/top_level.rb#176 - def http_url(prefix); end + # source://rdoc//lib/rdoc/code_object/top_level.rb#167 + def http_url; end - # source://rdoc//lib/rdoc/top_level.rb#182 + # source://rdoc//lib/rdoc/code_object/top_level.rb#171 def inspect; end - # Time this file was last modified, if known - # - # source://rdoc//lib/rdoc/top_level.rb#194 - def last_modified; end - # Dumps this TopLevel for use by ri. See also #marshal_load # - # source://rdoc//lib/rdoc/top_level.rb#201 + # source://rdoc//lib/rdoc/code_object/top_level.rb#183 def marshal_dump; end # Loads this TopLevel from +array+. # - # source://rdoc//lib/rdoc/top_level.rb#213 + # source://rdoc//lib/rdoc/code_object/top_level.rb#195 def marshal_load(array); end # Base name of this file # - # source://rdoc//lib/rdoc/top_level.rb#120 + # source://rdoc//lib/rdoc/code_object/top_level.rb#111 def name; end # Returns the NormalClass "Object", creating it if not found. # # Records +self+ as a location in "Object". # - # source://rdoc//lib/rdoc/top_level.rb#227 + # source://rdoc//lib/rdoc/code_object/top_level.rb#207 def object_class; end # Base name of this file without the extension # - # source://rdoc//lib/rdoc/top_level.rb#238 + # source://rdoc//lib/rdoc/code_object/top_level.rb#218 def page_name; end # The parser class that processed this file # - # source://rdoc//lib/rdoc/top_level.rb#36 + # source://rdoc//lib/rdoc/code_object/top_level.rb#29 def parser; end # Sets the parser for this toplevel context, also the store. # - # source://rdoc//lib/rdoc/top_level.rb#58 + # source://rdoc//lib/rdoc/code_object/top_level.rb#49 def parser=(val); end # Path to this file for use with HTML generator output. # - # source://rdoc//lib/rdoc/top_level.rb#248 + # source://rdoc//lib/rdoc/code_object/top_level.rb#228 def path; end - # source://rdoc//lib/rdoc/top_level.rb#252 + # source://rdoc//lib/rdoc/code_object/top_level.rb#234 def pretty_print(q); end # Relative name of this file # - # source://rdoc//lib/rdoc/top_level.rb#17 + # source://rdoc//lib/rdoc/code_object/top_level.rb#12 def relative_name; end # Relative name of this file # - # source://rdoc//lib/rdoc/top_level.rb#17 + # source://rdoc//lib/rdoc/code_object/top_level.rb#12 def relative_name=(_arg0); end # Search record used by RDoc::Generator::JsonIndex # - # source://rdoc//lib/rdoc/top_level.rb#266 + # source://rdoc//lib/rdoc/code_object/top_level.rb#248 def search_record; end # Is this TopLevel from a text file instead of a source code file? # # @return [Boolean] # - # source://rdoc//lib/rdoc/top_level.rb#283 + # source://rdoc//lib/rdoc/code_object/top_level.rb#265 def text?; end - # source://rdoc//lib/rdoc/top_level.rb#287 + # source://rdoc//lib/rdoc/code_object/top_level.rb#269 def to_s; end end # :stopdoc: # -# source://rdoc//lib/rdoc/task.rb#347 +# source://rdoc//lib/rdoc/task.rb#346 module Rake extend ::FileUtils::StreamUtils_ extend ::FileUtils @@ -12677,5 +12656,5 @@ end # For backwards compatibility # -# source://rdoc//lib/rdoc/task.rb#352 +# source://rdoc//lib/rdoc/task.rb#351 Rake::RDocTask = RDoc::Task diff --git a/sorbet/rbi/gems/reline@0.4.2.rbi b/sorbet/rbi/gems/reline@0.6.1.rbi similarity index 100% rename from sorbet/rbi/gems/reline@0.4.2.rbi rename to sorbet/rbi/gems/reline@0.6.1.rbi diff --git a/sorbet/rbi/gems/ruby-lsp@0.23.15.rbi b/sorbet/rbi/gems/ruby-lsp@0.23.17.rbi similarity index 94% rename from sorbet/rbi/gems/ruby-lsp@0.23.15.rbi rename to sorbet/rbi/gems/ruby-lsp@0.23.17.rbi index ff8ae86..f6115c2 100644 --- a/sorbet/rbi/gems/ruby-lsp@0.23.15.rbi +++ b/sorbet/rbi/gems/ruby-lsp@0.23.17.rbi @@ -94,7 +94,7 @@ class RubyIndexer::DeclarationListener # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#501 def add_class(name_or_nesting, full_location, name_location, parent_class_name: T.unsafe(nil), comments: T.unsafe(nil)); end - # : (String name, Prism::Location node_location, Array[Entry::Signature] signatures, ?visibility: Entry::Visibility, ?comments: String?) -> void + # : (String name, Prism::Location node_location, Array[Entry::Signature] signatures, ?visibility: Symbol, ?comments: String?) -> void # # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#469 def add_method(name, node_location, signatures, visibility: T.unsafe(nil), comments: T.unsafe(nil)); end @@ -308,7 +308,7 @@ class RubyIndexer::DeclarationListener # : (String short_name, Entry::Namespace entry) -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#1024 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#1021 def advance_namespace_stack(short_name, entry); end # : (Prism::Node node) -> String? @@ -325,7 +325,7 @@ class RubyIndexer::DeclarationListener # : -> VisibilityScope # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#932 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#929 def current_visibility_scope; end # : (String name) -> String @@ -378,31 +378,31 @@ class RubyIndexer::DeclarationListener # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#603 def handle_private_constant(node); end - # : (Prism::CallNode, Entry::Visibility) -> void + # : (Prism::CallNode, Symbol) -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#1042 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#1039 def handle_visibility_change(node, visibility); end # Returns the last name in the stack not as we found it, but in terms of declared constants. For example, if the # last entry in the stack is a compact namespace like `Foo::Bar`, then the last name is `Bar` # : -> String? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#1034 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#1031 def last_name_in_stack; end # : (Prism::ParametersNode? parameters_node) -> Array[Entry::Parameter] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#937 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#934 def list_params(parameters_node); end # : (Prism::Node? node) -> Symbol? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#999 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#996 def parameter_name(node); end # : (Prism::CallNode) -> Array[String] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#1065 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb#1062 def string_or_symbol_argument_values(node); end end @@ -426,7 +426,7 @@ class RubyIndexer::Enhancement # # @return [Enhancement] a new instance of Enhancement # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/enhancement.rb#35 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/enhancement.rb#32 def initialize(listener); end # The `on_extend` indexing enhancement is invoked whenever an extend is encountered in the code. It can be used to @@ -434,29 +434,29 @@ class RubyIndexer::Enhancement # `ClassMethods` modules # : (Prism::CallNode node) -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/enhancement.rb#44 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/enhancement.rb#41 def on_call_node_enter(node); end # : (Prism::CallNode node) -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/enhancement.rb#48 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/enhancement.rb#45 def on_call_node_leave(node); end class << self # : (DeclarationListener listener) -> Array[Enhancement] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/enhancement.rb#23 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/enhancement.rb#20 def all(listener); end # Only available for testing purposes # : -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/enhancement.rb#29 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/enhancement.rb#26 def clear; end # : (Class[Enhancement] child) -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/enhancement.rb#17 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/enhancement.rb#14 def inherited(child); end end end @@ -467,326 +467,326 @@ class RubyIndexer::Entry # # @return [Entry] a new instance of Entry # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#29 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#21 def initialize(name, uri, location, comments); end # : -> String # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#69 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#61 def comments; end # : -> String # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#53 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#45 def file_name; end # : -> String? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#64 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#56 def file_path; end # : RubyIndexer::Location # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#21 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#13 def location; end # : String # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#15 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#7 def name; end # : RubyIndexer::Location # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#21 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#13 def name_location; end # : -> bool # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#48 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#40 def private?; end # : -> bool # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#43 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#35 def protected?; end # : -> bool # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#38 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#30 def public?; end # : URI::Generic # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#18 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#10 def uri; end - # : Visibility + # : Symbol # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#26 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#18 def visibility; end - # : Visibility + # : Symbol # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#26 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#18 def visibility=(_arg0); end end -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#344 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#333 class RubyIndexer::Entry::Accessor < ::RubyIndexer::Entry::Member # : -> Array[Signature] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#347 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#336 def signatures; end end # A block method parameter, e.g. `def foo(&block)` # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#277 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#266 class RubyIndexer::Entry::BlockParameter < ::RubyIndexer::Entry::Parameter # : -> Symbol # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#289 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#278 def decorated_name; end class << self # : -> BlockParameter # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#282 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#271 def anonymous; end end end # : Symbol # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#278 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#267 RubyIndexer::Entry::BlockParameter::DEFAULT_NAME = T.let(T.unsafe(nil), Symbol) -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#173 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#163 class RubyIndexer::Entry::Class < ::RubyIndexer::Entry::Namespace # : (Array[String] nesting, URI::Generic uri, Location location, Location name_location, String? comments, String? parent_class) -> void # # @return [Class] a new instance of Class # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#180 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#170 def initialize(nesting, uri, location, name_location, comments, parent_class); end # : -> Integer # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#187 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#177 def ancestor_hash; end # The unresolved name of the parent class. This may return `nil`, which indicates the lack of an explicit parent # and therefore ::Object is the correct parent class # : String? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#177 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#167 def parent_class; end end # Represents a class variable e.g.: @@a = 1 # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#421 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#410 class RubyIndexer::Entry::ClassVariable < ::RubyIndexer::Entry # : (String name, URI::Generic uri, Location location, String? comments, Entry::Namespace? owner) -> void # # @return [ClassVariable] a new instance of ClassVariable # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#426 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#415 def initialize(name, uri, location, comments, owner); end # : Entry::Namespace? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#423 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#412 def owner; end end -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#201 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#191 class RubyIndexer::Entry::Constant < ::RubyIndexer::Entry; end # Alias represents a resolved alias, which points to an existing constant target # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#399 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#388 class RubyIndexer::Entry::ConstantAlias < ::RubyIndexer::Entry # : (String target, UnresolvedConstantAlias unresolved_alias) -> void # # @return [ConstantAlias] a new instance of ConstantAlias # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#404 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#393 def initialize(target, unresolved_alias); end # : String # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#401 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#390 def target; end end # A forwarding method parameter, e.g. `def foo(...)` # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#295 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#284 class RubyIndexer::Entry::ForwardingParameter < ::RubyIndexer::Entry::Parameter # : -> void # # @return [ForwardingParameter] a new instance of ForwardingParameter # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#297 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#286 def initialize; end end # Represents a global variable e.g.: $DEBUG # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#418 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#407 class RubyIndexer::Entry::GlobalVariable < ::RubyIndexer::Entry; end -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#124 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#115 class RubyIndexer::Entry::Include < ::RubyIndexer::Entry::ModuleOperation; end # Represents an instance variable e.g.: @a = 1 # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#433 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#422 class RubyIndexer::Entry::InstanceVariable < ::RubyIndexer::Entry # : (String name, URI::Generic uri, Location location, String? comments, Entry::Namespace? owner) -> void # # @return [InstanceVariable] a new instance of InstanceVariable # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#438 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#427 def initialize(name, uri, location, comments, owner); end # : Entry::Namespace? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#435 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#424 def owner; end end # An required keyword method parameter, e.g. `def foo(a:)` # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#237 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#226 class RubyIndexer::Entry::KeywordParameter < ::RubyIndexer::Entry::Parameter # : -> Symbol # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#240 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#229 def decorated_name; end end # A keyword rest method parameter, e.g. `def foo(**a)` # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#266 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#255 class RubyIndexer::Entry::KeywordRestParameter < ::RubyIndexer::Entry::Parameter # : -> Symbol # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#271 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#260 def decorated_name; end end # : Symbol # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#267 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#256 RubyIndexer::Entry::KeywordRestParameter::DEFAULT_NAME = T.let(T.unsafe(nil), Symbol) # @abstract It cannot be directly instantiated. Subclasses must implement the `abstract` methods below. # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#303 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#292 class RubyIndexer::Entry::Member < ::RubyIndexer::Entry abstract! - # : (String name, URI::Generic uri, Location location, String? comments, Visibility visibility, Entry::Namespace? owner) -> void + # : (String name, URI::Generic uri, Location location, String? comments, Symbol visibility, Entry::Namespace? owner) -> void # # @return [Member] a new instance of Member # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#313 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#302 def initialize(name, uri, location, comments, visibility, owner); end # : -> String # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#323 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#312 def decorated_parameters; end # : -> String # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#331 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#320 def formatted_signatures; end # : Entry::Namespace? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#310 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#299 def owner; end # @abstract # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#320 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#309 sig { abstract.returns(T::Array[::RubyIndexer::Entry::Signature]) } def signatures; end end -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#356 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#345 class RubyIndexer::Entry::Method < ::RubyIndexer::Entry::Member - # : (String name, URI::Generic uri, Location location, Location name_location, String? comments, Array[Signature] signatures, Visibility visibility, Entry::Namespace? owner) -> void + # : (String name, URI::Generic uri, Location location, Location name_location, String? comments, Array[Signature] signatures, Symbol visibility, Entry::Namespace? owner) -> void # # @return [Method] a new instance of Method # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#365 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#354 def initialize(name, uri, location, name_location, comments, signatures, visibility, owner); end # Returns the location of the method name, excluding parameters or the body # : Location # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#362 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#351 def name_location; end # : Array[Signature] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#358 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#347 def signatures; end end # A method alias is a resolved alias entry that points to the exact method target it refers to # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#465 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#454 class RubyIndexer::Entry::MethodAlias < ::RubyIndexer::Entry # : ((Member | MethodAlias) target, UnresolvedMethodAlias unresolved_alias) -> void # # @return [MethodAlias] a new instance of MethodAlias # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#473 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#462 def initialize(target, unresolved_alias); end # : -> String # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#490 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#479 def decorated_parameters; end # : -> String # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#495 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#484 def formatted_signatures; end # : Entry::Namespace? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#470 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#459 def owner; end # : -> Array[Signature] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#500 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#489 def signatures; end # : (Member | MethodAlias) # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#467 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#456 def target; end end -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#170 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#160 class RubyIndexer::Entry::Module < ::RubyIndexer::Entry::Namespace; end # @abstract It cannot be directly instantiated. Subclasses must implement the `abstract` methods below. # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#109 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#101 class RubyIndexer::Entry::ModuleOperation abstract! @@ -794,18 +794,18 @@ class RubyIndexer::Entry::ModuleOperation # # @return [ModuleOperation] a new instance of ModuleOperation # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#119 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#110 def initialize(module_name); end # : String # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#116 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#107 def module_name; end end # @abstract It cannot be directly instantiated. Subclasses must implement the `abstract` methods below. # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#127 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#118 class RubyIndexer::Entry::Namespace < ::RubyIndexer::Entry abstract! @@ -813,17 +813,17 @@ class RubyIndexer::Entry::Namespace < ::RubyIndexer::Entry # # @return [Namespace] a new instance of Namespace # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#141 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#131 def initialize(nesting, uri, location, name_location, comments); end # : -> Integer # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#165 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#155 def ancestor_hash; end # : -> Array[String] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#152 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#142 def mixin_operation_module_names; end # Stores all explicit prepend, include and extend operations in the exact order they were discovered in the source @@ -831,44 +831,44 @@ class RubyIndexer::Entry::Namespace < ::RubyIndexer::Entry # and prepended # : -> Array[ModuleOperation] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#160 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#150 def mixin_operations; end # Returns the location of the constant name, excluding the parent class or the body # : Location # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#138 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#128 def name_location; end # : Array[String] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#134 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#124 def nesting; end end # An optional keyword method parameter, e.g. `def foo(a: 123)` # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#246 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#235 class RubyIndexer::Entry::OptionalKeywordParameter < ::RubyIndexer::Entry::Parameter # : -> Symbol # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#249 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#238 def decorated_name; end end # An optional method parameter, e.g. `def foo(a = 123)` # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#228 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#217 class RubyIndexer::Entry::OptionalParameter < ::RubyIndexer::Entry::Parameter # : -> Symbol # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#231 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#220 def decorated_name; end end # @abstract It cannot be directly instantiated. Subclasses must implement the `abstract` methods below. # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#204 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#194 class RubyIndexer::Entry::Parameter abstract! @@ -876,70 +876,70 @@ class RubyIndexer::Entry::Parameter # # @return [Parameter] a new instance of Parameter # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#218 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#207 def initialize(name:); end # Name includes just the name of the parameter, excluding symbols like splats # : Symbol # Decorated name is the parameter name including the splat or block prefix, e.g.: `*foo`, `**foo` or `&block` # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#212 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#201 def decorated_name; end # Name includes just the name of the parameter, excluding symbols like splats # : Symbol # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#212 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#201 def name; end end -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#125 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#116 class RubyIndexer::Entry::Prepend < ::RubyIndexer::Entry::ModuleOperation; end # A required method parameter, e.g. `def foo(a)` # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#224 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#213 class RubyIndexer::Entry::RequiredParameter < ::RubyIndexer::Entry::Parameter; end # A rest method parameter, e.g. `def foo(*a)` # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#255 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#244 class RubyIndexer::Entry::RestParameter < ::RubyIndexer::Entry::Parameter # : -> Symbol # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#260 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#249 def decorated_name; end end # : Symbol # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#256 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#245 RubyIndexer::Entry::RestParameter::DEFAULT_NAME = T.let(T.unsafe(nil), Symbol) # Ruby doesn't support method overloading, so a method will have only one signature. # However RBS can represent the concept of method overloading, with different return types based on the arguments # passed, so we need to store all the signatures. # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#508 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#497 class RubyIndexer::Entry::Signature # : (Array[Parameter] parameters) -> void # # @return [Signature] a new instance of Signature # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#513 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#502 def initialize(parameters); end # Returns a string with the decorated names of the parameters of this member. E.g.: `(a, b = 1, c: 2)` # : -> String # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#519 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#508 def format; end # : (Array[Prism::Node]? args, Array[Symbol] names) -> bool # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#603 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#593 def keyword_arguments_match?(args, names); end # Returns `true` if the given call node arguments array matches this method signature. This method will prefer @@ -961,27 +961,27 @@ class RubyIndexer::Entry::Signature # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#539 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#528 def matches?(arguments); end # : Array[Parameter] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#510 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#499 def parameters; end # : (Array[Prism::Node] positional_args, Array[Prism::Node] forwarding_arguments, Array[Prism::Node]? keyword_args, Integer min_pos, (Integer | Float) max_pos) -> bool # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#590 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#580 def positional_arguments_match?(positional_args, forwarding_arguments, keyword_args, min_pos, max_pos); end end -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#192 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#182 class RubyIndexer::Entry::SingletonClass < ::RubyIndexer::Entry::Class # : (Location location, Location name_location, String? comments) -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#194 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#184 def update_singleton_information(location, name_location, comments); end end @@ -996,23 +996,23 @@ end # target in [rdoc-ref:Index#resolve]. If the right hand side contains a constant that doesn't exist, then it's not # possible to resolve the alias and it will remain an UnresolvedAlias until the right hand side constant exists # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#382 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#371 class RubyIndexer::Entry::UnresolvedConstantAlias < ::RubyIndexer::Entry # : (String target, Array[String] nesting, String name, URI::Generic uri, Location location, String? comments) -> void # # @return [UnresolvedConstantAlias] a new instance of UnresolvedConstantAlias # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#390 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#379 def initialize(target, nesting, name, uri, location, comments); end # : Array[String] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#387 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#376 def nesting; end # : String # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#384 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#373 def target; end end @@ -1020,62 +1020,53 @@ end # example, if we have `alias a b`, we create an unresolved alias for `a` because we aren't sure immediate what `b` # is referring to # -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#447 +# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#436 class RubyIndexer::Entry::UnresolvedMethodAlias < ::RubyIndexer::Entry # : (String new_name, String old_name, Entry::Namespace? owner, URI::Generic uri, Location location, String? comments) -> void # # @return [UnresolvedMethodAlias] a new instance of UnresolvedMethodAlias # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#455 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#444 def initialize(new_name, old_name, owner, uri, location, comments); end # : String # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#449 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#438 def new_name; end # : String # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#449 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#438 def old_name; end # : Entry::Namespace? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#452 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#441 def owner; end end -# source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/entry.rb#6 -class RubyIndexer::Entry::Visibility < ::T::Enum - enums do - PRIVATE = new - PROTECTED = new - PUBLIC = new - end -end - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#5 class RubyIndexer::Index # : -> void # # @return [Index] a new instance of Index # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#54 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#52 def initialize; end # : (String fully_qualified_name) -> Array[Entry]? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#139 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#137 def [](fully_qualified_name); end # : (Entry entry, ?skip_prefix_tree: bool) -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#124 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#122 def add(entry, skip_prefix_tree: T.unsafe(nil)); end # : (String name, String owner_name) -> Array[Entry::ClassVariable] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#642 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#616 def class_variable_completion_candidates(name, owner_name); end # : Configuration @@ -1083,38 +1074,38 @@ class RubyIndexer::Index # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#14 def configuration; end - # : (String name, Array[String] nesting) -> Array[Array[(Entry::Constant | Entry::ConstantAlias | Entry::Namespace | Entry::UnresolvedConstantAlias)]] + # : (String name, Array[String] nesting) -> Array[Array[Entry::Constant | Entry::ConstantAlias | Entry::Namespace | Entry::UnresolvedConstantAlias]] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#276 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#266 def constant_completion_candidates(name, nesting); end # : (URI::Generic uri, ?skip_require_paths_tree: bool) -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#94 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#92 def delete(uri, skip_require_paths_tree: T.unsafe(nil)); end # : -> bool # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#693 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#665 def empty?; end # : [T] (String uri, ?Class[(T & Entry)]? type) -> (Array[Entry] | Array[T])? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#736 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#708 def entries_for(uri, type = T.unsafe(nil)); end # : (String name) -> Entry::SingletonClass # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#713 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#685 def existing_or_new_singleton_class(name); end # Searches for a constant based on an unqualified name and returns the first possible match regardless of whether # there are more possible matching entries - # : (String name) -> Array[(Entry::Namespace | Entry::ConstantAlias | Entry::UnresolvedConstantAlias | Entry::Constant)]? + # : (String name) -> Array[Entry::Constant | Entry::ConstantAlias | Entry::Namespace | Entry::UnresolvedConstantAlias]? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#151 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#149 def first_unqualified_const(name); end # Follows aliases in a namespace. The algorithm keeps checking if the name is an alias and then recursively follows @@ -1129,13 +1120,13 @@ class RubyIndexer::Index # aliases, so we have to invoke `follow_aliased_namespace` again to check until we only return a real name # : (String name, ?Array[String] seen_names) -> String # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#435 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#409 def follow_aliased_namespace(name, seen_names = T.unsafe(nil)); end # Fuzzy searches index entries based on Jaro-Winkler similarity. If no query is provided, all entries are returned # : (String? query) -> Array[Entry] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#209 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#199 def fuzzy_search(query); end # Synchronizes a change made to the given URI. This method will ensure that new declarations are indexed, removed @@ -1144,7 +1135,7 @@ class RubyIndexer::Index # document's source (used to handle unsaved changes to files) # : (URI::Generic uri, ?String? source) ?{ (Index index) -> void } -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#658 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#632 def handle_change(uri, source = T.unsafe(nil), &block); end # Index all files for the given URIs, which defaults to what is configured. A block can be used to track and control @@ -1152,25 +1143,25 @@ class RubyIndexer::Index # indexing or `false` to stop indexing. # : (?uris: Array[URI::Generic]) ?{ (Integer progress) -> bool } -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#368 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#342 def index_all(uris: T.unsafe(nil), &block); end # Indexes a File URI by reading the contents from disk # : (URI::Generic uri, ?collect_comments: bool) -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#416 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#390 def index_file(uri, collect_comments: T.unsafe(nil)); end # : (URI::Generic uri, String source, ?collect_comments: bool) -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#394 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#368 def index_single(uri, source, collect_comments: T.unsafe(nil)); end # : (String name) -> bool # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#703 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#675 def indexed?(name); end # : bool @@ -1182,12 +1173,12 @@ class RubyIndexer::Index # include the `@` prefix # : (String name, String owner_name) -> Array[(Entry::InstanceVariable | Entry::ClassVariable)] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#612 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#586 def instance_variable_completion_candidates(name, owner_name); end # : -> Integer # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#708 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#680 def length; end # Linearizes the ancestors for a given name, returning the order of namespaces in which Ruby will search for method @@ -1202,17 +1193,17 @@ class RubyIndexer::Index # # @raise [NonExistingNamespaceError] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#509 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#483 def linearized_ancestors_of(fully_qualified_name); end # : (String? name, String receiver_name) -> Array[(Entry::Member | Entry::MethodAlias)] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#233 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#223 def method_completion_candidates(name, receiver_name); end # : -> Array[String] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#698 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#670 def names; end # Searches entries in the index based on an exact prefix, intended for providing autocomplete. All possible matches @@ -1230,13 +1221,13 @@ class RubyIndexer::Index # ``` # : (String query, ?Array[String]? nesting) -> Array[Array[Entry]] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#189 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#179 def prefix_search(query, nesting = T.unsafe(nil)); end # Register an included `hook` that will be executed when `module_name` is included into any namespace # : (String module_name) { (Index index, Entry::Namespace base) -> void } -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#89 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#87 def register_included_hook(module_name, &hook); end # Resolve a constant to its declaration based on its name and the nesting where the reference was found. Parameter @@ -1246,21 +1237,21 @@ class RubyIndexer::Index # nesting: the nesting structure where the reference was found (e.g.: ["Foo", "Bar"]) # seen_names: this parameter should not be used by consumers of the api. It is used to avoid infinite recursion when # resolving circular references - # : (String name, Array[String] nesting, ?Array[String] seen_names) -> Array[(Entry::Namespace | Entry::ConstantAlias | Entry::UnresolvedConstantAlias)]? + # : (String name, Array[String] nesting, ?Array[String] seen_names) -> Array[Entry::Constant | Entry::ConstantAlias | Entry::Namespace | Entry::UnresolvedConstantAlias]? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#332 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#306 def resolve(name, nesting, seen_names = T.unsafe(nil)); end # : (String variable_name, String owner_name) -> Array[Entry::ClassVariable]? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#599 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#573 def resolve_class_variable(variable_name, owner_name); end # Resolves an instance variable name for a given owner name. This method will linearize the ancestors of the owner # and find inherited instance variables as well # : (String variable_name, String owner_name) -> Array[Entry::InstanceVariable]? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#588 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#562 def resolve_instance_variable(variable_name, owner_name); end # Attempts to find methods for a resolved fully qualified receiver name. Do not provide the `seen_names` parameter @@ -1268,12 +1259,12 @@ class RubyIndexer::Index # Returns `nil` if the method does not exist on that receiver # : (String method_name, String receiver_name, ?Array[String] seen_names, ?inherited_only: bool) -> Array[(Entry::Member | Entry::MethodAlias)]? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#471 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#445 def resolve_method(method_name, receiver_name, seen_names = T.unsafe(nil), inherited_only: T.unsafe(nil)); end # : (String query) -> Array[URI::Generic] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#144 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#142 def search_require_paths(query); end private @@ -1284,68 +1275,68 @@ class RubyIndexer::Index # the nesting # : (String name, Array[String] nesting) -> String # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#1010 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#979 def build_non_redundant_full_name(name, nesting); end - # : (String full_name, Array[String] seen_names) -> Array[(Entry::Namespace | Entry::ConstantAlias | Entry::UnresolvedConstantAlias)]? + # : (String full_name, Array[String] seen_names) -> Array[Entry::Constant | Entry::ConstantAlias | Entry::Namespace | Entry::UnresolvedConstantAlias]? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#1031 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#1000 def direct_or_aliased_constant(full_name, seen_names); end # : (String? name, Array[String] nesting) -> Array[Array[(Entry::Namespace | Entry::ConstantAlias | Entry::UnresolvedConstantAlias | Entry::Constant)]] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#968 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#937 def inherited_constant_completion_candidates(name, nesting); end # Linearize mixins for an array of namespace entries. This method will mutate the `ancestors` array with the # linearized ancestors of the mixins # : (Array[String] ancestors, Array[Entry::Namespace] namespace_entries, Array[String] nesting) -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#792 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#764 def linearize_mixins(ancestors, namespace_entries, nesting); end # Linearize the superclass of a given namespace (including modules with the implicit `Module` superclass). This # method will mutate the `ancestors` array with the linearized ancestors of the superclass # : (Array[String] ancestors, String attached_class_name, String fully_qualified_name, Array[Entry::Namespace] namespace_entries, Array[String] nesting, Integer singleton_levels) -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#834 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#806 def linearize_superclass(ancestors, attached_class_name, fully_qualified_name, namespace_entries, nesting, singleton_levels); end # Always returns the linearized ancestors for the attached class, regardless of whether `name` refers to a singleton # or attached namespace # : (String name) -> Array[String] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#748 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#720 def linearized_attached_ancestors(name); end - # : (String name, Array[String] nesting, Array[String] seen_names) -> Array[(Entry::Namespace | Entry::ConstantAlias | Entry::UnresolvedConstantAlias)]? + # : (String name, Array[String] nesting, Array[String] seen_names) -> Array[Entry::Constant | Entry::ConstantAlias | Entry::Namespace | Entry::UnresolvedConstantAlias]? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#946 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#915 def lookup_ancestor_chain(name, nesting, seen_names); end - # : (String name, Array[String] nesting, Array[String] seen_names) -> Array[(Entry::Namespace | Entry::ConstantAlias | Entry::UnresolvedConstantAlias)]? + # : (String name, Array[String] nesting, Array[String] seen_names) -> Array[Entry::Constant | Entry::ConstantAlias | Entry::Namespace | Entry::UnresolvedConstantAlias]? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#926 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#895 def lookup_enclosing_scopes(name, nesting, seen_names); end # Attempts to resolve an UnresolvedAlias into a resolved Alias. If the unresolved alias is pointing to a constant # that doesn't exist, then we return the same UnresolvedAlias # : (Entry::UnresolvedConstantAlias entry, Array[String] seen_names) -> (Entry::ConstantAlias | Entry::UnresolvedConstantAlias) # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#902 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#871 def resolve_alias(entry, seen_names); end # Attempt to resolve a given unresolved method alias. This method returns the resolved alias if we managed to # identify the target or the same unresolved alias entry if we couldn't # : (Entry::UnresolvedMethodAlias entry, String receiver_name, Array[String] seen_names) -> (Entry::MethodAlias | Entry::UnresolvedMethodAlias) # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#1047 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#1011 def resolve_method_alias(entry, receiver_name, seen_names); end # Runs the registered included hooks # : (String fully_qualified_name, Array[String] nesting) -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#762 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#734 def run_included_hooks(fully_qualified_name, nesting); end class << self @@ -1359,7 +1350,7 @@ class RubyIndexer::Index # Returns the unresolved name for a constant reference including all parts of a constant path, or `nil` if the # constant contains dynamic or incomplete parts - # : ((Prism::ConstantPathNode | Prism::ConstantReadNode | Prism::ConstantPathTargetNode | Prism::CallNode | Prism::MissingNode) node) -> String? + # : (Prism::Node) -> String? # # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/index.rb#40 def constant_name(node); end @@ -1579,7 +1570,7 @@ class RubyIndexer::RBSIndexer # : ((RBS::AST::Declarations::Class | RBS::AST::Declarations::Module | RBS::AST::Declarations::Constant | RBS::AST::Declarations::Global | RBS::AST::Members::MethodDefinition | RBS::AST::Members::Alias) declaration) -> String? # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#295 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#286 def comments_to_string(declaration); end # : ((RBS::AST::Declarations::Class | RBS::AST::Declarations::Module) declaration, Pathname pathname) -> void @@ -1603,12 +1594,12 @@ class RubyIndexer::RBSIndexer # And we need to handle their nesting differently. # : (RBS::AST::Declarations::Constant declaration, Array[String] nesting, URI::Generic uri) -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#252 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#243 def handle_constant(declaration, nesting, uri); end # : (RBS::AST::Declarations::Global declaration, Pathname pathname) -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#263 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#254 def handle_global_variable(declaration, pathname); end # : (RBS::AST::Members::MethodDefinition member, Entry::Namespace owner) -> void @@ -1618,12 +1609,12 @@ class RubyIndexer::RBSIndexer # : (RBS::AST::Members::Alias member, Entry::Namespace owner_entry) -> void # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#278 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#269 def handle_signature_alias(member, owner_entry); end # : (RBS::Types::Function function) -> Array[Entry::Parameter] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#163 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#154 def parse_arguments(function); end # : (RBS::AST::Declarations::Base declaration, Pathname pathname) -> void @@ -1633,42 +1624,42 @@ class RubyIndexer::RBSIndexer # : (RBS::Types::Function function) -> Array[Entry::OptionalKeywordParameter] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#222 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#213 def process_optional_keywords(function); end # : (RBS::AST::Members::MethodDefinition::Overload overload) -> Array[Entry::Parameter] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#142 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#133 def process_overload(overload); end # : (RBS::Types::Function function) -> Array[Entry::RequiredParameter] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#175 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#166 def process_required_and_optional_positionals(function); end # : (RBS::Types::Function function) -> Array[Entry::KeywordParameter] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#215 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#206 def process_required_keywords(function); end # : (RBS::Types::Function function) -> Entry::KeywordRestParameter # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#229 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#220 def process_rest_keywords(function); end # : (RBS::Types::Function function) -> Entry::RestParameter # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#206 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#197 def process_rest_positionals(function); end # : (RBS::Types::Function function) -> Array[Entry::OptionalParameter] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#199 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#190 def process_trailing_positionals(function); end # : (RBS::AST::Members::MethodDefinition member) -> Array[Entry::Signature] # - # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#134 + # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb#125 def signatures(member); end # : (RBS::Location rbs_location) -> RubyIndexer::Location @@ -1921,7 +1912,7 @@ end # # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/visibility_scope.rb#7 class RubyIndexer::VisibilityScope - # : (?visibility: Entry::Visibility, ?module_func: bool) -> void + # : (?visibility: Symbol, ?module_func: bool) -> void # # @return [VisibilityScope] a new instance of VisibilityScope # @@ -1933,7 +1924,7 @@ class RubyIndexer::VisibilityScope # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/visibility_scope.rb#24 def module_func; end - # : Entry::Visibility + # : Symbol # # source://ruby-lsp//lib/ruby_indexer/lib/ruby_indexer/visibility_scope.rb#21 def visibility; end @@ -2346,125 +2337,125 @@ class RubyLsp::Document # # @return [Document] a new instance of Document # - # source://ruby-lsp//lib/ruby_lsp/document.rb#50 + # source://ruby-lsp//lib/ruby_lsp/document.rb#42 def initialize(source:, version:, uri:, global_state:); end # : (Document[untyped] other) -> bool # - # source://ruby-lsp//lib/ruby_lsp/document.rb#65 + # source://ruby-lsp//lib/ruby_lsp/document.rb#62 def ==(other); end # : [T] (String request_name) { (Document[ParseResultType] document) -> T } -> T # - # source://ruby-lsp//lib/ruby_lsp/document.rb#73 + # source://ruby-lsp//lib/ruby_lsp/document.rb#70 def cache_fetch(request_name, &block); end # : (String request_name) -> untyped # - # source://ruby-lsp//lib/ruby_lsp/document.rb#88 + # source://ruby-lsp//lib/ruby_lsp/document.rb#85 def cache_get(request_name); end # : [T] (String request_name, T value) -> T # - # source://ruby-lsp//lib/ruby_lsp/document.rb#83 + # source://ruby-lsp//lib/ruby_lsp/document.rb#80 def cache_set(request_name, value); end # : Encoding # - # source://ruby-lsp//lib/ruby_lsp/document.rb#41 + # source://ruby-lsp//lib/ruby_lsp/document.rb#33 def encoding; end # : (Hash[Symbol, untyped] start_pos, ?Hash[Symbol, untyped]? end_pos) -> [Integer, Integer?] # - # source://ruby-lsp//lib/ruby_lsp/document.rb#135 + # source://ruby-lsp//lib/ruby_lsp/document.rb#132 def find_index_by_position(start_pos, end_pos = T.unsafe(nil)); end # @abstract # - # source://ruby-lsp//lib/ruby_lsp/document.rb#70 - sig { abstract.returns(::RubyLsp::Document::LanguageId) } + # source://ruby-lsp//lib/ruby_lsp/document.rb#67 + sig { abstract.returns(::Symbol) } def language_id; end # : Edit? # - # source://ruby-lsp//lib/ruby_lsp/document.rb#44 + # source://ruby-lsp//lib/ruby_lsp/document.rb#36 def last_edit; end # Returns `true` if the document was parsed and `false` if nothing needed parsing # # @abstract # - # source://ruby-lsp//lib/ruby_lsp/document.rb#124 + # source://ruby-lsp//lib/ruby_lsp/document.rb#121 sig { abstract.returns(T::Boolean) } def parse!; end # : ParseResultType # - # source://ruby-lsp//lib/ruby_lsp/document.rb#29 + # source://ruby-lsp//lib/ruby_lsp/document.rb#21 def parse_result; end # : -> bool # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_lsp/document.rb#130 + # source://ruby-lsp//lib/ruby_lsp/document.rb#127 def past_expensive_limit?; end # : (Array[Hash[Symbol, untyped]] edits, version: Integer) -> void # - # source://ruby-lsp//lib/ruby_lsp/document.rb#93 + # source://ruby-lsp//lib/ruby_lsp/document.rb#90 def push_edits(edits, version:); end # : (Interface::SemanticTokens | Object) # - # source://ruby-lsp//lib/ruby_lsp/document.rb#47 + # source://ruby-lsp//lib/ruby_lsp/document.rb#39 def semantic_tokens; end # : (Interface::SemanticTokens | Object) # - # source://ruby-lsp//lib/ruby_lsp/document.rb#47 + # source://ruby-lsp//lib/ruby_lsp/document.rb#39 def semantic_tokens=(_arg0); end # : String # - # source://ruby-lsp//lib/ruby_lsp/document.rb#32 + # source://ruby-lsp//lib/ruby_lsp/document.rb#24 def source; end # @abstract # - # source://ruby-lsp//lib/ruby_lsp/document.rb#127 + # source://ruby-lsp//lib/ruby_lsp/document.rb#124 sig { abstract.returns(T::Boolean) } def syntax_error?; end # : URI::Generic # - # source://ruby-lsp//lib/ruby_lsp/document.rb#38 + # source://ruby-lsp//lib/ruby_lsp/document.rb#30 def uri; end # : Integer # - # source://ruby-lsp//lib/ruby_lsp/document.rb#35 + # source://ruby-lsp//lib/ruby_lsp/document.rb#27 def version; end private # : -> Scanner # - # source://ruby-lsp//lib/ruby_lsp/document.rb#147 + # source://ruby-lsp//lib/ruby_lsp/document.rb#144 def create_scanner; end end -# source://ruby-lsp//lib/ruby_lsp/document.rb#168 +# source://ruby-lsp//lib/ruby_lsp/document.rb#165 class RubyLsp::Document::Delete < ::RubyLsp::Document::Edit; end # : Object # -# source://ruby-lsp//lib/ruby_lsp/document.rb#24 +# source://ruby-lsp//lib/ruby_lsp/document.rb#16 RubyLsp::Document::EMPTY_CACHE = T.let(T.unsafe(nil), Object) # @abstract It cannot be directly instantiated. Subclasses must implement the `abstract` methods below. # -# source://ruby-lsp//lib/ruby_lsp/document.rb#151 +# source://ruby-lsp//lib/ruby_lsp/document.rb#148 class RubyLsp::Document::Edit abstract! @@ -2472,70 +2463,61 @@ class RubyLsp::Document::Edit # # @return [Edit] a new instance of Edit # - # source://ruby-lsp//lib/ruby_lsp/document.rb#161 + # source://ruby-lsp//lib/ruby_lsp/document.rb#158 def initialize(range); end # : Hash[Symbol, untyped] # - # source://ruby-lsp//lib/ruby_lsp/document.rb#158 + # source://ruby-lsp//lib/ruby_lsp/document.rb#155 def range; end end -# source://ruby-lsp//lib/ruby_lsp/document.rb#166 +# source://ruby-lsp//lib/ruby_lsp/document.rb#163 class RubyLsp::Document::Insert < ::RubyLsp::Document::Edit; end -# source://ruby-lsp//lib/ruby_lsp/document.rb#6 -class RubyLsp::Document::LanguageId < ::T::Enum - enums do - ERB = new - RBS = new - Ruby = new - end -end - -# source://ruby-lsp//lib/ruby_lsp/document.rb#18 +# source://ruby-lsp//lib/ruby_lsp/document.rb#10 class RubyLsp::Document::LocationNotFoundError < ::StandardError; end # This maximum number of characters for providing expensive features, like semantic highlighting and diagnostics. # This is the same number used by the TypeScript extension in VS Code # -# source://ruby-lsp//lib/ruby_lsp/document.rb#23 +# source://ruby-lsp//lib/ruby_lsp/document.rb#15 RubyLsp::Document::MAXIMUM_CHARACTERS_FOR_EXPENSIVE_FEATURES = T.let(T.unsafe(nil), Integer) -# source://ruby-lsp//lib/ruby_lsp/document.rb#167 +# source://ruby-lsp//lib/ruby_lsp/document.rb#164 class RubyLsp::Document::Replace < ::RubyLsp::Document::Edit; end -# source://ruby-lsp//lib/ruby_lsp/document.rb#170 +# source://ruby-lsp//lib/ruby_lsp/document.rb#167 class RubyLsp::Document::Scanner # : (String source, Encoding encoding) -> void # # @return [Scanner] a new instance of Scanner # - # source://ruby-lsp//lib/ruby_lsp/document.rb#178 + # source://ruby-lsp//lib/ruby_lsp/document.rb#175 def initialize(source, encoding); end # Finds the character index inside the source string for a given line and column # : (Hash[Symbol, untyped] position) -> Integer # - # source://ruby-lsp//lib/ruby_lsp/document.rb#187 + # source://ruby-lsp//lib/ruby_lsp/document.rb#184 def find_char_position(position); end # Subtract 1 for each character after 0xFFFF in the current line from the column position, so that we hit the # right character in the UTF-8 representation # : (Integer current_position, Integer requested_position) -> Integer # - # source://ruby-lsp//lib/ruby_lsp/document.rb#217 + # source://ruby-lsp//lib/ruby_lsp/document.rb#214 def utf_16_character_position_correction(current_position, requested_position); end end # : Integer # -# source://ruby-lsp//lib/ruby_lsp/document.rb#173 +# source://ruby-lsp//lib/ruby_lsp/document.rb#170 RubyLsp::Document::Scanner::LINE_BREAK = T.let(T.unsafe(nil), Integer) # After character 0xFFFF, UTF-16 considers characters to have length 2 and we have to account for that # -# source://ruby-lsp//lib/ruby_lsp/document.rb#175 +# source://ruby-lsp//lib/ruby_lsp/document.rb#172 RubyLsp::Document::Scanner::SURROGATE_PAIR_START = T.let(T.unsafe(nil), Integer) # source://ruby-lsp//lib/ruby_lsp/erb_document.rb#5 @@ -2568,7 +2550,7 @@ class RubyLsp::ERBDocument < ::RubyLsp::Document # source://ruby-lsp//lib/ruby_lsp/erb_document.rb#67 def inside_host_language?(char_position); end - # : -> LanguageId + # : -> Symbol # # source://ruby-lsp//lib/ruby_lsp/erb_document.rb#50 def language_id; end @@ -2633,28 +2615,28 @@ class RubyLsp::ERBDocument::ERBScanner def scan_char; end end -# source://ruby-lsp//lib/ruby_lsp/utils.rb#189 +# source://ruby-lsp//lib/ruby_lsp/utils.rb#199 class RubyLsp::Error # : (id: Integer, code: Integer, message: String, ?data: Hash[Symbol, untyped]?) -> void # # @return [Error] a new instance of Error # - # source://ruby-lsp//lib/ruby_lsp/utils.rb#197 + # source://ruby-lsp//lib/ruby_lsp/utils.rb#207 def initialize(id:, code:, message:, data: T.unsafe(nil)); end # : Integer # - # source://ruby-lsp//lib/ruby_lsp/utils.rb#194 + # source://ruby-lsp//lib/ruby_lsp/utils.rb#204 def code; end # : String # - # source://ruby-lsp//lib/ruby_lsp/utils.rb#191 + # source://ruby-lsp//lib/ruby_lsp/utils.rb#201 def message; end # : -> Hash[Symbol, untyped] # - # source://ruby-lsp//lib/ruby_lsp/utils.rb#205 + # source://ruby-lsp//lib/ruby_lsp/utils.rb#215 def to_hash; end end @@ -2952,7 +2934,7 @@ RubyLsp::Listeners::CodeLens::SUPPORTED_TEST_LIBRARIES = T.let(T.unsafe(nil), Ar class RubyLsp::Listeners::Completion include ::RubyLsp::Requests::Support::Common - # : (ResponseBuilders::CollectionResponseBuilder[Interface::CompletionItem] response_builder, GlobalState global_state, NodeContext node_context, RubyDocument::SorbetLevel sorbet_level, Prism::Dispatcher dispatcher, URI::Generic uri, String? trigger_character) -> void + # : (ResponseBuilders::CollectionResponseBuilder[Interface::CompletionItem] response_builder, GlobalState global_state, NodeContext node_context, SorbetLevel sorbet_level, Prism::Dispatcher dispatcher, URI::Generic uri, String? trigger_character) -> void # # @return [Completion] a new instance of Completion # @@ -3152,7 +3134,7 @@ RubyLsp::Listeners::Completion::KEYWORDS = T.let(T.unsafe(nil), Array) class RubyLsp::Listeners::Definition include ::RubyLsp::Requests::Support::Common - # : (ResponseBuilders::CollectionResponseBuilder[(Interface::Location | Interface::LocationLink)] response_builder, GlobalState global_state, Document::LanguageId language_id, URI::Generic uri, NodeContext node_context, Prism::Dispatcher dispatcher, RubyDocument::SorbetLevel sorbet_level) -> void + # : (ResponseBuilders::CollectionResponseBuilder[(Interface::Location | Interface::LocationLink)] response_builder, GlobalState global_state, Symbol language_id, URI::Generic uri, NodeContext node_context, Prism::Dispatcher dispatcher, SorbetLevel sorbet_level) -> void # # @return [Definition] a new instance of Definition # @@ -3725,7 +3707,7 @@ class RubyLsp::Listeners::DocumentLink # 3. The version from the gemspec # : (URI::Source uri) -> String? # - # source://ruby-lsp//lib/ruby_lsp/listeners/document_link.rb#144 + # source://ruby-lsp//lib/ruby_lsp/listeners/document_link.rb#141 def resolve_version(uri); end class << self @@ -4095,7 +4077,7 @@ end class RubyLsp::Listeners::Hover include ::RubyLsp::Requests::Support::Common - # : (ResponseBuilders::Hover response_builder, GlobalState global_state, URI::Generic uri, NodeContext node_context, Prism::Dispatcher dispatcher, RubyDocument::SorbetLevel sorbet_level) -> void + # : (ResponseBuilders::Hover response_builder, GlobalState global_state, URI::Generic uri, NodeContext node_context, Prism::Dispatcher dispatcher, SorbetLevel sorbet_level) -> void # # @return [Hover] a new instance of Hover # @@ -4241,7 +4223,7 @@ class RubyLsp::Listeners::Hover # : (Prism::CallNode node) -> void # - # source://ruby-lsp//lib/ruby_lsp/listeners/hover.rb#377 + # source://ruby-lsp//lib/ruby_lsp/listeners/hover.rb#378 def generate_gem_hover(node); end # : ((Prism::InterpolatedStringNode | Prism::StringNode) node) -> void @@ -4485,7 +4467,7 @@ RubyLsp::Listeners::SemanticHighlighting::SPECIAL_RUBY_METHODS = T.let(T.unsafe( class RubyLsp::Listeners::SignatureHelp include ::RubyLsp::Requests::Support::Common - # : (ResponseBuilders::SignatureHelp response_builder, GlobalState global_state, NodeContext node_context, Prism::Dispatcher dispatcher, RubyDocument::SorbetLevel sorbet_level) -> void + # : (ResponseBuilders::SignatureHelp response_builder, GlobalState global_state, NodeContext node_context, Prism::Dispatcher dispatcher, SorbetLevel sorbet_level) -> void # # @return [SignatureHelp] a new instance of SignatureHelp # @@ -4512,41 +4494,41 @@ end # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#6 class RubyLsp::Listeners::SpecStyle < ::RubyLsp::Listeners::TestDiscovery - # : (response_builder: ResponseBuilders::TestCollection, global_state: GlobalState, dispatcher: Prism::Dispatcher, uri: URI::Generic) -> void + # : (ResponseBuilders::TestCollection, GlobalState, Prism::Dispatcher, URI::Generic) -> void # # @return [SpecStyle] a new instance of SpecStyle # - # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#10 + # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#8 def initialize(response_builder, global_state, dispatcher, uri); end - # : (node: Prism::CallNode) -> void + # : (Prism::CallNode) -> void # - # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#41 + # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#39 def on_call_node_enter(node); end - # : (node: Prism::CallNode) -> void + # : (Prism::CallNode) -> void # - # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#51 + # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#49 def on_call_node_leave(node); end - # : (node: Prism::ClassNode) -> void + # : (Prism::ClassNode) -> void # - # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#26 + # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#24 def on_class_node_enter(node); end - # : (node: Prism::ClassNode) -> void + # : (Prism::ClassNode) -> void # - # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#34 + # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#32 def on_class_node_leave(node); end private - # : (description: String, node: Prism::CallNode) -> void + # : (String, Prism::CallNode) -> void # - # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#97 + # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#96 def add_to_parent_test_group(description, node); end - # : (node: Prism::CallNode) -> String? + # : (Prism::CallNode) -> String? # # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#133 def extract_description(node); end @@ -4556,14 +4538,14 @@ class RubyLsp::Listeners::SpecStyle < ::RubyLsp::Listeners::TestDiscovery # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#112 def find_parent_test_group; end - # : (node: Prism::CallNode) -> void + # : (Prism::CallNode) -> void # - # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#60 + # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#58 def handle_describe(node); end - # : (node: Prism::CallNode) -> void + # : (Prism::CallNode) -> void # - # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#85 + # source://ruby-lsp//lib/ruby_lsp/listeners/spec_style.rb#84 def handle_example(node); end # : -> bool @@ -4632,7 +4614,7 @@ RubyLsp::Listeners::TestDiscovery::DYNAMIC_REFERENCE_MARKER = T.let(T.unsafe(nil # source://ruby-lsp//lib/ruby_lsp/listeners/test_style.rb#6 class RubyLsp::Listeners::TestStyle < ::RubyLsp::Listeners::TestDiscovery - # : (ResponseBuilders::TestCollection response_builder, GlobalState global_state, Prism::Dispatcher dispatcher, URI::Generic uri) -> void + # : (ResponseBuilders::TestCollection, GlobalState, Prism::Dispatcher, URI::Generic) -> void # # @return [TestStyle] a new instance of TestStyle # @@ -4641,12 +4623,12 @@ class RubyLsp::Listeners::TestStyle < ::RubyLsp::Listeners::TestDiscovery # : (Prism::CallNode node) -> void # - # source://ruby-lsp//lib/ruby_lsp/listeners/test_style.rb#204 + # source://ruby-lsp//lib/ruby_lsp/listeners/test_style.rb#209 def on_call_node_enter(node); end # : (Prism::CallNode node) -> void # - # source://ruby-lsp//lib/ruby_lsp/listeners/test_style.rb#212 + # source://ruby-lsp//lib/ruby_lsp/listeners/test_style.rb#217 def on_call_node_leave(node); end # : (Prism::ClassNode node) -> void @@ -4656,7 +4638,7 @@ class RubyLsp::Listeners::TestStyle < ::RubyLsp::Listeners::TestDiscovery # : (Prism::DefNode node) -> void # - # source://ruby-lsp//lib/ruby_lsp/listeners/test_style.rb#180 + # source://ruby-lsp//lib/ruby_lsp/listeners/test_style.rb#183 def on_def_node_enter(node); end private @@ -4665,7 +4647,7 @@ class RubyLsp::Listeners::TestStyle < ::RubyLsp::Listeners::TestDiscovery # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_lsp/listeners/test_style.rb#223 + # source://ruby-lsp//lib/ruby_lsp/listeners/test_style.rb#228 def non_declarative_minitest?(attached_ancestors, fully_qualified_name); end class << self @@ -4850,7 +4832,7 @@ class RubyLsp::RBSDocument < ::RubyLsp::Document # source://ruby-lsp//lib/ruby_lsp/rbs_document.rb#11 def initialize(source:, version:, uri:, global_state:); end - # : -> LanguageId + # : -> Symbol # # source://ruby-lsp//lib/ruby_lsp/rbs_document.rb#40 def language_id; end @@ -4868,54 +4850,54 @@ class RubyLsp::RBSDocument < ::RubyLsp::Document def syntax_error?; end end -# source://ruby-lsp//lib/ruby_lsp/utils.rb#145 +# source://ruby-lsp//lib/ruby_lsp/utils.rb#150 class RubyLsp::Request < ::RubyLsp::Message # : (id: (Integer | String), method: String, params: Object) -> void # # @return [Request] a new instance of Request # - # source://ruby-lsp//lib/ruby_lsp/utils.rb#175 + # source://ruby-lsp//lib/ruby_lsp/utils.rb#180 def initialize(id:, method:, params:); end # : -> Hash[Symbol, untyped] # - # source://ruby-lsp//lib/ruby_lsp/utils.rb#182 + # source://ruby-lsp//lib/ruby_lsp/utils.rb#187 def to_hash; end class << self # : (Integer id, (Interface::RelativePattern | String) pattern, ?kind: Integer, ?registration_id: String?) -> Request # - # source://ruby-lsp//lib/ruby_lsp/utils.rb#148 + # source://ruby-lsp//lib/ruby_lsp/utils.rb#153 def register_watched_files(id, pattern, kind: T.unsafe(nil), registration_id: T.unsafe(nil)); end end end # A request configuration, to turn on/off features # -# source://ruby-lsp//lib/ruby_lsp/utils.rb#238 +# source://ruby-lsp//lib/ruby_lsp/utils.rb#248 class RubyLsp::RequestConfig # : (Hash[Symbol, bool] configuration) -> void # # @return [RequestConfig] a new instance of RequestConfig # - # source://ruby-lsp//lib/ruby_lsp/utils.rb#243 + # source://ruby-lsp//lib/ruby_lsp/utils.rb#253 def initialize(configuration); end # : Hash[Symbol, bool] # - # source://ruby-lsp//lib/ruby_lsp/utils.rb#240 + # source://ruby-lsp//lib/ruby_lsp/utils.rb#250 def configuration; end # : Hash[Symbol, bool] # - # source://ruby-lsp//lib/ruby_lsp/utils.rb#240 + # source://ruby-lsp//lib/ruby_lsp/utils.rb#250 def configuration=(_arg0); end # : (Symbol feature) -> bool? # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_lsp/utils.rb#248 + # source://ruby-lsp//lib/ruby_lsp/utils.rb#258 def enabled?(feature); end end @@ -4934,63 +4916,68 @@ class RubyLsp::Requests::CodeActionResolve < ::RubyLsp::Requests::Request # # @return [CodeActionResolve] a new instance of CodeActionResolve # - # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#26 + # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#21 def initialize(document, global_state, code_action); end - # : -> (Interface::CodeAction | Error) + # : -> (Interface::CodeAction) # - # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#35 + # @raise [EmptySelectionError] + # + # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#30 def perform; end private - # : -> (Interface::CodeAction | Error) + # : -> (Interface::CodeAction) # - # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#335 + # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#346 def create_attribute_accessor; end # : (Hash[Symbol, untyped] range, String new_text) -> Interface::TextEdit # - # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#266 + # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#277 def create_text_edit(range, new_text); end # : (Prism::BlockNode node, String? indentation) -> String # - # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#277 + # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#288 def recursively_switch_nested_block_styles(node, indentation); end - # : -> (Interface::CodeAction | Error) + # : -> (Interface::CodeAction) + # + # @raise [EmptySelectionError] # - # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#194 + # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#201 def refactor_method; end - # : -> (Interface::CodeAction | Error) + # : -> (Interface::CodeAction) # - # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#95 + # @raise [EmptySelectionError] + # + # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#94 def refactor_variable; end # : (Prism::Node body, String? indentation) -> String # - # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#306 + # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#317 def switch_block_body(body, indentation); end - # : -> (Interface::CodeAction | Error) + # : -> (Interface::CodeAction) + # + # @raise [EmptySelectionError] # - # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#57 + # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#52 def switch_block_style; end end # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#15 class RubyLsp::Requests::CodeActionResolve::CodeActionError < ::StandardError; end +# source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#16 +class RubyLsp::Requests::CodeActionResolve::EmptySelectionError < ::RubyLsp::Requests::CodeActionResolve::CodeActionError; end + # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#17 -class RubyLsp::Requests::CodeActionResolve::Error < ::T::Enum - enums do - EmptySelection = new - InvalidTargetRange = new - UnknownCodeAction = new - end -end +class RubyLsp::Requests::CodeActionResolve::InvalidTargetRangeError < ::RubyLsp::Requests::CodeActionResolve::CodeActionError; end # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#13 RubyLsp::Requests::CodeActionResolve::NEW_METHOD_NAME = T.let(T.unsafe(nil), String) @@ -4998,6 +4985,9 @@ RubyLsp::Requests::CodeActionResolve::NEW_METHOD_NAME = T.let(T.unsafe(nil), Str # source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#12 RubyLsp::Requests::CodeActionResolve::NEW_VARIABLE_NAME = T.let(T.unsafe(nil), String) +# source://ruby-lsp//lib/ruby_lsp/requests/code_action_resolve.rb#18 +class RubyLsp::Requests::CodeActionResolve::UnknownCodeActionError < ::RubyLsp::Requests::CodeActionResolve::CodeActionError; end + # The [code actions](https://microsoft.github.io/language-server-protocol/specification#textDocument_codeAction) # request informs the editor of RuboCop quick fixes that can be applied. These are accessible by hovering over a # specific diagnostic. @@ -5067,7 +5057,7 @@ class RubyLsp::Requests::CodeLens < ::RubyLsp::Requests::Request # : -> Array[Interface::CodeLens] # - # source://ruby-lsp//lib/ruby_lsp/requests/code_lens.rb#35 + # source://ruby-lsp//lib/ruby_lsp/requests/code_lens.rb#47 def perform; end class << self @@ -5083,7 +5073,7 @@ end # # source://ruby-lsp//lib/ruby_lsp/requests/completion.rb#10 class RubyLsp::Requests::Completion < ::RubyLsp::Requests::Request - # : ((RubyDocument | ERBDocument) document, GlobalState global_state, Hash[Symbol, untyped] params, RubyDocument::SorbetLevel sorbet_level, Prism::Dispatcher dispatcher) -> void + # : ((RubyDocument | ERBDocument) document, GlobalState global_state, Hash[Symbol, untyped] params, SorbetLevel sorbet_level, Prism::Dispatcher dispatcher) -> void # # @return [Completion] a new instance of Completion # @@ -5150,7 +5140,7 @@ RubyLsp::Requests::CompletionResolve::MAX_DOCUMENTATION_ENTRIES = T.let(T.unsafe # # source://ruby-lsp//lib/ruby_lsp/requests/definition.rb#11 class RubyLsp::Requests::Definition < ::RubyLsp::Requests::Request - # : ((RubyDocument | ERBDocument) document, GlobalState global_state, Hash[Symbol, untyped] position, Prism::Dispatcher dispatcher, RubyDocument::SorbetLevel sorbet_level) -> void + # : ((RubyDocument | ERBDocument) document, GlobalState global_state, Hash[Symbol, untyped] position, Prism::Dispatcher dispatcher, SorbetLevel sorbet_level) -> void # # @return [Definition] a new instance of Definition # @@ -5159,7 +5149,7 @@ class RubyLsp::Requests::Definition < ::RubyLsp::Requests::Request # : -> Array[(Interface::Location | Interface::LocationLink)] # - # source://ruby-lsp//lib/ruby_lsp/requests/definition.rb#98 + # source://ruby-lsp//lib/ruby_lsp/requests/definition.rb#97 def perform; end private @@ -5168,7 +5158,7 @@ class RubyLsp::Requests::Definition < ::RubyLsp::Requests::Request # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_lsp/requests/definition.rb#106 + # source://ruby-lsp//lib/ruby_lsp/requests/definition.rb#105 def position_outside_target?(position, target); end end @@ -5374,12 +5364,12 @@ class RubyLsp::Requests::GoToRelevantFile < ::RubyLsp::Requests::Request # # @return [GoToRelevantFile] a new instance of GoToRelevantFile # - # source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#23 + # source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#21 def initialize(path, workspace_path); end # : -> Array[String] # - # source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#32 + # source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#30 def perform; end private @@ -5392,45 +5382,45 @@ class RubyLsp::Requests::GoToRelevantFile < ::RubyLsp::Requests::Request # would be the parts of the path separated by path divider.) # : (Array[String] candidates) -> Array[String] # - # source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#67 + # source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#65 def find_most_similar_with_jaccard(candidates); end # : -> Array[String] # - # source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#39 + # source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#37 def find_relevant_paths; end # : (String path) -> Set[String] # - # source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#82 + # source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#80 def get_dir_parts(path); end # : -> String # - # source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#47 + # source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#45 def relevant_filename_pattern; end end -# source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#13 +# source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#11 RubyLsp::Requests::GoToRelevantFile::TEST_KEYWORDS = T.let(T.unsafe(nil), Array) -# source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#17 +# source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#15 RubyLsp::Requests::GoToRelevantFile::TEST_PATTERN = T.let(T.unsafe(nil), Regexp) # : String # -# source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#19 +# source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#17 RubyLsp::Requests::GoToRelevantFile::TEST_PREFIX_GLOB = T.let(T.unsafe(nil), String) -# source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#15 +# source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#13 RubyLsp::Requests::GoToRelevantFile::TEST_PREFIX_PATTERN = T.let(T.unsafe(nil), Regexp) # : String # -# source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#20 +# source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#18 RubyLsp::Requests::GoToRelevantFile::TEST_SUFFIX_GLOB = T.let(T.unsafe(nil), String) -# source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#16 +# source://ruby-lsp//lib/ruby_lsp/requests/go_to_relevant_file.rb#14 RubyLsp::Requests::GoToRelevantFile::TEST_SUFFIX_PATTERN = T.let(T.unsafe(nil), Regexp) # The [hover request](https://microsoft.github.io/language-server-protocol/specification#textDocument_hover) @@ -5442,7 +5432,7 @@ class RubyLsp::Requests::Hover < ::RubyLsp::Requests::Request ResponseType = type_member { { fixed: T.nilable(::LanguageServer::Protocol::Interface::Hover) } } - # : ((RubyDocument | ERBDocument) document, GlobalState global_state, Hash[Symbol, untyped] position, Prism::Dispatcher dispatcher, RubyDocument::SorbetLevel sorbet_level) -> void + # : ((RubyDocument | ERBDocument) document, GlobalState global_state, Hash[Symbol, untyped] position, Prism::Dispatcher dispatcher, SorbetLevel sorbet_level) -> void # # @return [Hover] a new instance of Hover # @@ -5672,12 +5662,12 @@ class RubyLsp::Requests::References < ::RubyLsp::Requests::Request # : (RubyIndexer::ReferenceFinder::Target target, Prism::ParseResult parse_result, URI::Generic uri) -> void # - # source://ruby-lsp//lib/ruby_lsp/requests/references.rb#126 + # source://ruby-lsp//lib/ruby_lsp/requests/references.rb#111 def collect_references(target, parse_result, uri); end # : ((Prism::ConstantReadNode | Prism::ConstantPathNode | Prism::ConstantPathTargetNode | Prism::InstanceVariableAndWriteNode | Prism::InstanceVariableOperatorWriteNode | Prism::InstanceVariableOrWriteNode | Prism::InstanceVariableReadNode | Prism::InstanceVariableTargetNode | Prism::InstanceVariableWriteNode | Prism::CallNode | Prism::DefNode) target_node, NodeContext node_context) -> RubyIndexer::ReferenceFinder::Target? # - # source://ruby-lsp//lib/ruby_lsp/requests/references.rb#100 + # source://ruby-lsp//lib/ruby_lsp/requests/references.rb#85 def create_reference_target(target_node, node_context); end end @@ -5705,27 +5695,27 @@ class RubyLsp::Requests::Rename < ::RubyLsp::Requests::Request # : (String name, RubyIndexer::ReferenceFinder::Reference reference) -> Interface::TextEdit # - # source://ruby-lsp//lib/ruby_lsp/requests/rename.rb#168 + # source://ruby-lsp//lib/ruby_lsp/requests/rename.rb#165 def adjust_reference_for_edit(name, reference); end # : (RubyIndexer::ReferenceFinder::Target target, Prism::ParseResult parse_result, String name, URI::Generic uri) -> Array[Interface::TextEdit] # - # source://ruby-lsp//lib/ruby_lsp/requests/rename.rb#157 + # source://ruby-lsp//lib/ruby_lsp/requests/rename.rb#154 def collect_changes(target, parse_result, name, uri); end # : (String fully_qualified_name, Array[(Interface::RenameFile | Interface::TextDocumentEdit)] document_changes) -> void # - # source://ruby-lsp//lib/ruby_lsp/requests/rename.rb#96 + # source://ruby-lsp//lib/ruby_lsp/requests/rename.rb#93 def collect_file_renames(fully_qualified_name, document_changes); end # : (RubyIndexer::ReferenceFinder::Target target, String name) -> Hash[String, Array[Interface::TextEdit]] # - # source://ruby-lsp//lib/ruby_lsp/requests/rename.rb#132 + # source://ruby-lsp//lib/ruby_lsp/requests/rename.rb#129 def collect_text_edits(target, name); end # : (String constant_name) -> String # - # source://ruby-lsp//lib/ruby_lsp/requests/rename.rb#178 + # source://ruby-lsp//lib/ruby_lsp/requests/rename.rb#175 def file_from_constant_name(constant_name); end class << self @@ -5766,7 +5756,7 @@ class RubyLsp::Requests::Request # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_lsp/requests/request.rb#75 + # source://ruby-lsp//lib/ruby_lsp/requests/request.rb#76 def covers_position?(location, position); end # Signals to the client that the request should be delegated to the language server server for the host language @@ -5826,7 +5816,7 @@ end # # source://ruby-lsp//lib/ruby_lsp/requests/semantic_highlighting.rb#11 class RubyLsp::Requests::SemanticHighlighting < ::RubyLsp::Requests::Request - # : (GlobalState global_state, Prism::Dispatcher dispatcher, (RubyDocument | ERBDocument) document, String? previous_result_id, ?range: T::Range[Integer]?) -> void + # : (GlobalState global_state, Prism::Dispatcher dispatcher, (RubyDocument | ERBDocument) document, String? previous_result_id, ?range: Range[Integer]?) -> void # # @return [SemanticHighlighting] a new instance of SemanticHighlighting # @@ -5890,7 +5880,7 @@ end # # source://ruby-lsp//lib/ruby_lsp/requests/signature_help.rb#11 class RubyLsp::Requests::SignatureHelp < ::RubyLsp::Requests::Request - # : ((RubyDocument | ERBDocument) document, GlobalState global_state, Hash[Symbol, untyped] position, Hash[Symbol, untyped]? context, Prism::Dispatcher dispatcher, RubyDocument::SorbetLevel sorbet_level) -> void + # : ((RubyDocument | ERBDocument) document, GlobalState global_state, Hash[Symbol, untyped] position, Hash[Symbol, untyped]? context, Prism::Dispatcher dispatcher, SorbetLevel sorbet_level) -> void # # @return [SignatureHelp] a new instance of SignatureHelp # @@ -5935,7 +5925,7 @@ module RubyLsp::Requests::Support; end # source://ruby-lsp//lib/ruby_lsp/requests/support/annotation.rb#7 class RubyLsp::Requests::Support::Annotation - # : (arity: (Integer | T::Range[Integer]), ?receiver: bool) -> void + # : (arity: (Integer | Range[Integer]), ?receiver: bool) -> void # # @return [Annotation] a new instance of Annotation # @@ -6031,13 +6021,6 @@ module RubyLsp::Requests::Support::Common # # source://ruby-lsp//lib/ruby_lsp/requests/support/common.rb#64 def self_receiver?(node); end - - # : (RubyDocument::SorbetLevel sorbet_level) -> bool - # - # @return [Boolean] - # - # source://ruby-lsp//lib/ruby_lsp/requests/support/common.rb#164 - def sorbet_level_true_or_higher?(sorbet_level); end end # @abstract Subclasses must implement the `abstract` methods below. @@ -6292,22 +6275,22 @@ class RubyLsp::Requests::Support::TestItem # # @return [TestItem] a new instance of TestItem # - # source://ruby-lsp//lib/ruby_lsp/requests/support/test_item.rb#17 + # source://ruby-lsp//lib/ruby_lsp/requests/support/test_item.rb#23 def initialize(id, label, uri, range, framework:); end # : (String id) -> TestItem? # - # source://ruby-lsp//lib/ruby_lsp/requests/support/test_item.rb#32 + # source://ruby-lsp//lib/ruby_lsp/requests/support/test_item.rb#38 def [](id); end # : (TestItem item) -> void # - # source://ruby-lsp//lib/ruby_lsp/requests/support/test_item.rb#27 + # source://ruby-lsp//lib/ruby_lsp/requests/support/test_item.rb#33 def add(item); end # : -> Array[TestItem] # - # source://ruby-lsp//lib/ruby_lsp/requests/support/test_item.rb#37 + # source://ruby-lsp//lib/ruby_lsp/requests/support/test_item.rb#43 def children; end # : String @@ -6320,10 +6303,20 @@ class RubyLsp::Requests::Support::TestItem # source://ruby-lsp//lib/ruby_lsp/requests/support/test_item.rb#14 def label; end + # : Interface::Range + # + # source://ruby-lsp//lib/ruby_lsp/requests/support/test_item.rb#20 + def range; end + # : -> Hash[Symbol, untyped] # - # source://ruby-lsp//lib/ruby_lsp/requests/support/test_item.rb#42 + # source://ruby-lsp//lib/ruby_lsp/requests/support/test_item.rb#48 def to_hash; end + + # : URI::Generic + # + # source://ruby-lsp//lib/ruby_lsp/requests/support/test_item.rb#17 + def uri; end end # The [type hierarchy supertypes @@ -6659,49 +6652,59 @@ class RubyLsp::ResponseBuilders::TestCollection < ::RubyLsp::ResponseBuilders::R # # @return [TestCollection] a new instance of TestCollection # - # source://ruby-lsp//lib/ruby_lsp/response_builders/test_collection.rb#12 + # source://ruby-lsp//lib/ruby_lsp/response_builders/test_collection.rb#15 def initialize; end # : (String id) -> ResponseType? # - # source://ruby-lsp//lib/ruby_lsp/response_builders/test_collection.rb#23 + # source://ruby-lsp//lib/ruby_lsp/response_builders/test_collection.rb#60 def [](id); end # : (ResponseType item) -> void # - # source://ruby-lsp//lib/ruby_lsp/response_builders/test_collection.rb#18 + # source://ruby-lsp//lib/ruby_lsp/response_builders/test_collection.rb#22 def add(item); end + # : (ResponseType item) -> void + # + # source://ruby-lsp//lib/ruby_lsp/response_builders/test_collection.rb#27 + def add_code_lens(item); end + + # : Array[Interface::CodeLens] + # + # source://ruby-lsp//lib/ruby_lsp/response_builders/test_collection.rb#12 + def code_lens; end + # : -> Array[ResponseType] # - # source://ruby-lsp//lib/ruby_lsp/response_builders/test_collection.rb#29 + # source://ruby-lsp//lib/ruby_lsp/response_builders/test_collection.rb#66 def response; end end # The final result of running a request before its IO is finalized # -# source://ruby-lsp//lib/ruby_lsp/utils.rb#218 +# source://ruby-lsp//lib/ruby_lsp/utils.rb#228 class RubyLsp::Result # : (id: Integer, response: untyped) -> void # # @return [Result] a new instance of Result # - # source://ruby-lsp//lib/ruby_lsp/utils.rb#226 + # source://ruby-lsp//lib/ruby_lsp/utils.rb#236 def initialize(id:, response:); end # : Integer # - # source://ruby-lsp//lib/ruby_lsp/utils.rb#223 + # source://ruby-lsp//lib/ruby_lsp/utils.rb#233 def id; end # : untyped # - # source://ruby-lsp//lib/ruby_lsp/utils.rb#220 + # source://ruby-lsp//lib/ruby_lsp/utils.rb#230 def response; end # : -> Hash[Symbol, untyped] # - # source://ruby-lsp//lib/ruby_lsp/utils.rb#232 + # source://ruby-lsp//lib/ruby_lsp/utils.rb#242 def to_hash; end end @@ -6715,51 +6718,46 @@ class RubyLsp::RubyDocument < ::RubyLsp::Document # # @return [RubyDocument] a new instance of RubyDocument # - # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#133 + # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#123 def initialize(source:, version:, uri:, global_state:); end # : (^(Integer arg0) -> Integer | Prism::CodeUnitsCache) # - # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#130 + # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#120 def code_units_cache; end - # : -> LanguageId + # : -> Symbol # - # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#158 + # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#148 def language_id; end # : (Hash[Symbol, untyped] range, ?node_types: Array[singleton(Prism::Node)]) -> Prism::Node? # - # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#183 + # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#153 def locate_first_within_range(range, node_types: T.unsafe(nil)); end # : (Hash[Symbol, untyped] position, ?node_types: Array[singleton(Prism::Node)]) -> NodeContext # - # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#211 + # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#181 def locate_node(position, node_types: T.unsafe(nil)); end # : -> bool # - # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#141 + # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#131 def parse!; end # : -> bool # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#223 + # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#193 def should_index?; end - # : -> SorbetLevel - # - # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#163 - def sorbet_level; end - # : -> bool # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#152 + # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#142 def syntax_error?; end private @@ -6768,20 +6766,20 @@ class RubyLsp::RubyDocument < ::RubyLsp::Document # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#234 + # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#204 def last_edit_may_change_declarations?; end # : (Hash[Symbol, Integer] position) -> bool # # @return [Boolean] # - # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#248 + # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#218 def position_may_impact_declarations?(position); end class << self # : (Prism::Node node, Integer char_position, code_units_cache: (^(Integer arg0) -> Integer | Prism::CodeUnitsCache), ?node_types: Array[singleton(Prism::Node)]) -> NodeContext # - # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#38 + # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#28 def locate(node, char_position, code_units_cache:, node_types: T.unsafe(nil)); end end end @@ -6789,17 +6787,6 @@ end # source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#10 RubyLsp::RubyDocument::METHODS_THAT_CHANGE_DECLARATIONS = T.let(T.unsafe(nil), Array) -# source://ruby-lsp//lib/ruby_lsp/ruby_document.rb#26 -class RubyLsp::RubyDocument::SorbetLevel < ::T::Enum - enums do - False = new - Ignore = new - None = new - Strict = new - True = new - end -end - # The path to the `static_docs` directory, where we keep long-form static documentation # # source://ruby-lsp//lib/ruby_lsp/static_docs.rb#6 @@ -6874,17 +6861,17 @@ class RubyLsp::Server < ::RubyLsp::BaseServer # : (String id, String title, ?percentage: Integer) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1274 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1290 def begin_progress(id, title, percentage: T.unsafe(nil)); end # : -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1304 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1320 def check_formatter_is_available; end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#863 + # source://ruby-lsp//lib/ruby_lsp/server.rb#882 def code_action_resolve(message); end # NOTE: all servers methods are void because they can produce several messages for the client. The only reason this @@ -6892,65 +6879,65 @@ class RubyLsp::Server < ::RubyLsp::BaseServer # not supposed to rely on the return of this method # : (Hash[Symbol, untyped] message) -> Thread? # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1378 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1394 def compose_bundle(message); end # Returns internal state information for debugging purposes # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1427 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1443 def diagnose_state(message); end # Discovers all available test groups and examples in a given file taking into consideration the merged response of # all add-ons # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1447 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1463 def discover_tests(message); end # : (String id) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1294 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1310 def end_progress(id); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1154 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1170 def experimental_go_to_relevant_file(message); end # : (URI::Generic uri) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1102 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1118 def handle_rubocop_config_change(uri); end # : (RubyIndexer::Index index, String file_path, Integer change_type) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1075 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1091 def handle_ruby_file_change(index, file_path, change_type); end # : -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1242 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1258 def perform_initial_indexing; end # : (Hash[Symbol, untyped]? indexing_options) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1322 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1338 def process_indexing_configuration(indexing_options); end # : (String id, Integer percentage) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1287 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1303 def progress(id, percentage); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1468 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1484 def resolve_test_commands(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#469 + # source://ruby-lsp//lib/ruby_lsp/server.rb#471 def run_combined_requests(message); end # : (Hash[Symbol, untyped] message) -> void @@ -6960,192 +6947,251 @@ class RubyLsp::Server < ::RubyLsp::BaseServer # : -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#356 + # source://ruby-lsp//lib/ruby_lsp/server.rb#358 def run_initialized; end # : -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1237 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1253 def shutdown; end - # : (Document[untyped] document) -> RubyDocument::SorbetLevel + # : (Document[untyped] document) -> SorbetLevel # - # source://ruby-lsp//lib/ruby_lsp/server.rb#799 + # source://ruby-lsp//lib/ruby_lsp/server.rb#814 def sorbet_level(document); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#841 + # source://ruby-lsp//lib/ruby_lsp/server.rb#860 def text_document_code_action(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#469 + # source://ruby-lsp//lib/ruby_lsp/server.rb#471 def text_document_code_lens(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#928 + # source://ruby-lsp//lib/ruby_lsp/server.rb#943 def text_document_completion(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#953 + # source://ruby-lsp//lib/ruby_lsp/server.rb#968 def text_document_completion_item_resolve(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#998 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1013 def text_document_definition(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#888 + # source://ruby-lsp//lib/ruby_lsp/server.rb#899 def text_document_diagnostic(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#433 + # source://ruby-lsp//lib/ruby_lsp/server.rb#435 def text_document_did_change(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#422 + # source://ruby-lsp//lib/ruby_lsp/server.rb#424 def text_document_did_close(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#383 + # source://ruby-lsp//lib/ruby_lsp/server.rb#385 def text_document_did_open(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#679 + # source://ruby-lsp//lib/ruby_lsp/server.rb#694 def text_document_document_highlight(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#469 + # source://ruby-lsp//lib/ruby_lsp/server.rb#471 def text_document_document_link(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#469 + # source://ruby-lsp//lib/ruby_lsp/server.rb#471 def text_document_document_symbol(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#469 + # source://ruby-lsp//lib/ruby_lsp/server.rb#471 def text_document_folding_range(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#635 + # source://ruby-lsp//lib/ruby_lsp/server.rb#646 def text_document_formatting(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#718 + # source://ruby-lsp//lib/ruby_lsp/server.rb#733 def text_document_hover(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#807 + # source://ruby-lsp//lib/ruby_lsp/server.rb#826 def text_document_inlay_hint(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#695 + # source://ruby-lsp//lib/ruby_lsp/server.rb#710 def text_document_on_type_formatting(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#763 + # source://ruby-lsp//lib/ruby_lsp/server.rb#778 def text_document_prepare_rename(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1173 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1189 def text_document_prepare_type_hierarchy(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#607 + # source://ruby-lsp//lib/ruby_lsp/server.rb#618 def text_document_range_formatting(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#781 + # source://ruby-lsp//lib/ruby_lsp/server.rb#796 def text_document_references(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#743 + # source://ruby-lsp//lib/ruby_lsp/server.rb#758 def text_document_rename(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#443 + # source://ruby-lsp//lib/ruby_lsp/server.rb#445 def text_document_selection_range(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#553 + # source://ruby-lsp//lib/ruby_lsp/server.rb#564 def text_document_semantic_tokens_delta(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#532 + # source://ruby-lsp//lib/ruby_lsp/server.rb#543 def text_document_semantic_tokens_full(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#578 + # source://ruby-lsp//lib/ruby_lsp/server.rb#589 def text_document_semantic_tokens_range(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1135 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1151 def text_document_show_syntax_tree(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#972 + # source://ruby-lsp//lib/ruby_lsp/server.rb#987 def text_document_signature_help(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1201 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1217 def type_hierarchy_subtypes(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1192 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1208 def type_hierarchy_supertypes(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1363 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1379 def window_show_message_request(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1208 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1224 def workspace_dependencies(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1023 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1038 def workspace_did_change_watched_files(message); end # : (Hash[Symbol, untyped] message) -> void # - # source://ruby-lsp//lib/ruby_lsp/server.rb#1122 + # source://ruby-lsp//lib/ruby_lsp/server.rb#1138 def workspace_symbol(message); end end module RubyLsp::ShouldaContext; end +# source://ruby-lsp//lib/ruby_lsp/utils.rb#263 +class RubyLsp::SorbetLevel + # : (String?) -> void + # + # @return [SorbetLevel] a new instance of SorbetLevel + # + # source://ruby-lsp//lib/ruby_lsp/utils.rb#272 + def initialize(sigil); end + + # : -> bool + # + # @return [Boolean] + # + # source://ruby-lsp//lib/ruby_lsp/utils.rb#291 + def false?; end + + # : -> bool + # + # @return [Boolean] + # + # source://ruby-lsp//lib/ruby_lsp/utils.rb#288 + def ignore?; end + + # : -> bool + # + # @return [Boolean] + # + # source://ruby-lsp//lib/ruby_lsp/utils.rb#300 + def none?; end + + # : -> bool + # + # @return [Boolean] + # + # source://ruby-lsp//lib/ruby_lsp/utils.rb#297 + def strict?; end + + # : -> bool + # + # @return [Boolean] + # + # source://ruby-lsp//lib/ruby_lsp/utils.rb#294 + def true?; end + + # : -> bool + # + # @return [Boolean] + # + # source://ruby-lsp//lib/ruby_lsp/utils.rb#303 + def true_or_higher?; end + + class << self + # : -> SorbetLevel + # + # source://ruby-lsp//lib/ruby_lsp/utils.rb#266 + def ignore; end + end +end + # source://ruby-lsp//lib/ruby_lsp/store.rb#5 class RubyLsp::Store # : (GlobalState global_state) -> void @@ -7219,7 +7265,7 @@ class RubyLsp::Store # source://ruby-lsp//lib/ruby_lsp/store.rb#67 def push_edits(uri:, edits:, version:); end - # : (uri: URI::Generic, source: String, version: Integer, language_id: Document::LanguageId) -> Document[untyped] + # : (uri: URI::Generic, source: String, version: Integer, language_id: Symbol) -> Document[untyped] # # source://ruby-lsp//lib/ruby_lsp/store.rb#55 def set(uri:, source:, version:, language_id:); end @@ -7372,7 +7418,7 @@ URI::Generic::PARSER = T.let(T.unsafe(nil), URI::RFC2396_Parser) class URI::Source < ::URI::File # : (String? v) -> bool # - # source://ruby-lsp//lib/ruby_lsp/requests/support/source_uri.rb#55 + # source://ruby-lsp//lib/ruby_lsp/requests/support/source_uri.rb#57 def check_host(v); end # source://uri/1.0.3/uri/generic.rb#243 @@ -7380,7 +7426,7 @@ class URI::Source < ::URI::File # : String? # - # source://ruby-lsp//lib/ruby_lsp/requests/support/source_uri.rb#28 + # source://ruby-lsp//lib/ruby_lsp/requests/support/source_uri.rb#30 def gem_version; end # source://uri/1.0.3/uri/generic.rb#283 @@ -7388,18 +7434,18 @@ class URI::Source < ::URI::File # : (String? v) -> void # - # source://ruby-lsp//lib/ruby_lsp/requests/support/source_uri.rb#45 + # source://ruby-lsp//lib/ruby_lsp/requests/support/source_uri.rb#47 def set_path(v); end # : -> String # - # source://ruby-lsp//lib/ruby_lsp/requests/support/source_uri.rb#67 + # source://ruby-lsp//lib/ruby_lsp/requests/support/source_uri.rb#69 def to_s; end class << self # : (gem_name: String, gem_version: String?, path: String, line_number: String?) -> URI::Source # - # source://ruby-lsp//lib/ruby_lsp/requests/support/source_uri.rb#32 + # source://ruby-lsp//lib/ruby_lsp/requests/support/source_uri.rb#34 def build(gem_name:, gem_version:, path:, line_number:); end end end diff --git a/sorbet/rbi/gems/stringio@3.1.0.rbi b/sorbet/rbi/gems/stringio@3.1.7.rbi similarity index 100% rename from sorbet/rbi/gems/stringio@3.1.0.rbi rename to sorbet/rbi/gems/stringio@3.1.7.rbi diff --git a/spec/README.md b/spec/README.md new file mode 100644 index 0000000..73ce0e5 --- /dev/null +++ b/spec/README.md @@ -0,0 +1,3 @@ +# Spec examples + +This folder contains some examples of the shoulda-context DSL implementation for development. diff --git a/examples/sample_1_test.rb b/spec/sample_1_test.rb similarity index 100% rename from examples/sample_1_test.rb rename to spec/sample_1_test.rb diff --git a/examples/sample_2_test.rb b/spec/sample_2_test.rb similarity index 84% rename from examples/sample_2_test.rb rename to spec/sample_2_test.rb index a48f82b..2321545 100644 --- a/examples/sample_2_test.rb +++ b/spec/sample_2_test.rb @@ -7,17 +7,17 @@ class CalculatorTest < Minitest::Test context "context 1" do should "test 1" do - assert true + assert false end end context "context 2" do should "test 1" do - assert true + assert false end should "test 2" do - assert true + assert false end end end diff --git a/examples/sample_3_test.rb b/spec/sample_3_test.rb similarity index 100% rename from examples/sample_3_test.rb rename to spec/sample_3_test.rb diff --git a/test/ruby-lsp/shoulda_context_style_test.rb b/test/ruby-lsp/shoulda_context_style_test.rb new file mode 100644 index 0000000..ab68ea4 --- /dev/null +++ b/test/ruby-lsp/shoulda_context_style_test.rb @@ -0,0 +1,292 @@ +# typed: true +# frozen_string_literal: true + +require "test_helper" + +module RubyLsp + module RubyLspShouldaContext + class ShouldaContextStyleTest < Minitest::Test + def test_discover_context_with_should + source = <<~RUBY + module Foo + class MyTest < Minitest::Test + context "test 1" do + should "test 11" do + assert true + end + + should "test 12" do + assert true + end + end + + context "test 2" do + should "test 21" do + assert true + end + end + end + end + RUBY + + file = URI("file:///test.rb") + + with_server(source, file) do |server, uri| + server.process_message(id: 1, method: "rubyLsp/discoverTests", params: { + textDocument: { uri: uri }, + }) + + result = pop_result(server) + + items = result.response + assert_equal 1, items.size + + # Check class is root + # TODO: Improve taking into account the module + class_item = items.first + assert_equal "Foo::MyTest", class_item.fetch(:id) + assert_equal "Foo::MyTest", class_item.fetch(:label) + assert_equal "framework:shoulda", class_item.fetch(:tags).first + assert_equal 2, class_item.fetch(:children).size + + # Check context is child of class + context_item = class_item.fetch(:children).first + assert_equal "test 1", context_item.fetch(:id) + assert_equal "test 1", context_item.fetch(:label) + assert_equal "framework:shoulda", context_item.fetch(:tags).first + assert_equal 2, context_item.fetch(:children).size + + # Check the should inside the class is child of context + should_item = context_item.fetch(:children).first + assert_equal "test 11", should_item.fetch(:id) + assert_equal "test 11", should_item.fetch(:label) + assert_equal "framework:shoulda", should_item.fetch(:tags).first + assert_equal 0, should_item.fetch(:children).size + + # Check the second should inside the class is child of context + should_item = context_item.fetch(:children).last + assert_equal "test 12", should_item.fetch(:id) + assert_equal "test 12", should_item.fetch(:label) + assert_equal "framework:shoulda", should_item.fetch(:tags).first + assert_equal 0, should_item.fetch(:children).size + + # Check second context + context_item = class_item.fetch(:children).last + assert_equal "test 2", context_item.fetch(:id) + assert_equal "test 2", context_item.fetch(:label) + assert_equal "framework:shoulda", context_item.fetch(:tags).first + assert_equal 1, context_item.fetch(:children).size + + # Check the should inside the class is child of + # the class + should_item = context_item.fetch(:children).first + assert_equal "test 21", should_item.fetch(:id) + assert_equal "test 21", should_item.fetch(:label) + assert_equal "framework:shoulda", should_item.fetch(:tags).first + assert_equal 0, should_item.fetch(:children).size + end + end + + def test_discover_context + source = <<~RUBY + class MyTest < Minitest::Test + context "test 1" do + assert true + end + end + RUBY + + file = URI("file:///test.rb") + + with_server(source, file) do |server, uri| + server.process_message(id: 1, method: "rubyLsp/discoverTests", params: { + textDocument: { uri: uri }, + }) + + result = pop_result(server) + + items = result.response + assert_equal 1, items.size + + test_item = items.first + + assert_equal "MyTest", test_item.fetch(:id) + assert_equal "MyTest", test_item.fetch(:label) + assert_equal "framework:shoulda", test_item.fetch(:tags).first + assert_equal 1, test_item.fetch(:children).size + + # Inner context + assert_equal "test 1", test_item.fetch(:children).first.fetch(:id) + assert_equal "test 1", test_item.fetch(:children).first.fetch(:label) + assert_equal "framework:shoulda", test_item.fetch(:children).first.fetch(:tags).first + assert_equal 0, test_item.fetch(:children).first.fetch(:children).size + end + end + + def test_discover_should_with_methods + source = <<~RUBY + class MyTest < Minitest::Test + should validate_prescence_of(:name) + end + RUBY + + file = URI("file:///test.rb") + + with_server(source, file) do |server, uri| + server.process_message(id: 1, method: "rubyLsp/discoverTests", params: { + textDocument: { uri: uri }, + }) + + result = pop_result(server) + + items = result.response + assert_equal 1, items.size + + class_item = items.first + assert_equal "MyTest", class_item.fetch(:id) + assert_equal "MyTest", class_item.fetch(:label) + assert_equal "framework:shoulda", class_item.fetch(:tags).first + + # Check the should inside the class is child of + # the class + should_item = class_item.fetch(:children).first + assert_equal "", should_item.fetch(:id) + assert_equal "", should_item.fetch(:label) + assert_equal "framework:shoulda", should_item.fetch(:tags).first + assert_equal 0, should_item.fetch(:children).size + end + end + + def test_discover_should + source = <<~RUBY + class MyTest < Minitest::Test + should "test 1" do + assert true + end + end + RUBY + + file = URI("file:///test.rb") + + with_server(source, file) do |server, uri| + server.process_message(id: 1, method: "rubyLsp/discoverTests", params: { + textDocument: { uri: uri }, + }) + + result = pop_result(server) + + items = result.response + assert_equal 1, items.size + + class_item = items.first + assert_equal "MyTest", class_item.fetch(:id) + assert_equal "MyTest", class_item.fetch(:label) + assert_equal "framework:shoulda", class_item.fetch(:tags).first + + # Check the should inside the class is child of + # the class + should_item = class_item.fetch(:children).first + assert_equal "test 1", should_item.fetch(:id) + assert_equal "test 1", should_item.fetch(:label) + assert_equal "framework:shoulda", should_item.fetch(:tags).first + assert_equal 0, should_item.fetch(:children).size + end + end + + def test_not_discover_invalid_context + source = <<~RUBY + class MyTest < Minitest::Test + context do + end + end + RUBY + + file = URI("file:///test.rb") + + with_server(source, file) do |server, uri| + server.process_message(id: 1, method: "rubyLsp/discoverTests", params: { + textDocument: { uri: uri }, + }) + + result = pop_result(server) + + items = result.response + assert_equal 1, items.size + + test_item = items.first + assert_equal "MyTest", test_item.fetch(:id) + assert_equal "MyTest", test_item.fetch(:label) + assert_equal "framework:shoulda", test_item.fetch(:tags).first + assert_equal 0, test_item.fetch(:children).size + end + end + + def test_not_parse_if_not_in_test_class + source = <<~RUBY + context "test 1" do + assert true + end + RUBY + + file = URI("file:///test.rb") + + with_server(source, file) do |server, uri| + server.process_message(id: 1, method: "rubyLsp/discoverTests", params: { + textDocument: { uri: uri }, + }) + + result = pop_result(server) + + items = result.response + assert_equal 0, items.size + end + end + + # Command Resolution + + def test_resolve_test_commands + with_server do |server| + server.process_message({ + id: 1, + method: "rubyLsp/resolveTestCommands", + params: { + items: [ + { + id: "Foo::MyTest", + uri: "file:///test/my_test.rb", + label: "Foo::MyTest", + tags: ["framework:shoulda", "test_group"], + children: [ + { + id: "test 1", + uri: "file:///test/my_test.rb", + label: "test 1", + tags: ["framework:shoulda", "test_group"], + children: [ + { + id: "test 11", + uri: "file:///test/my_test.rb", + label: "test 11", + tags: ["framework:shoulda"], + children: [], + }, + ], + }, + ], + }, + ], + }, + }) + + response = pop_result(server).response + assert_equal( + [ + "bundle exec ruby -ITest /test/my_test.rb --name \"/Foo::MyTest#test_: test 1 should test 11/\"", + ], + response[:commands], + ) + end + end + end + end +end