rdoc 6.13.0 → 6.14.0

data/lib/rdoc/markup/to_table_of_contents.rb

@@ -33,7 +33,7 @@ class RDoc::Markup::ToTableOfContents < RDoc::Markup::Formatter
   ##
   # Adds +document+ to the output, using its heading cutoff if present
 
-  def accept_document document
+  def accept_document(document)
     @omit_headings_below = document.omit_headings_below
 
     super
@@ -42,7 +42,7 @@ class RDoc::Markup::ToTableOfContents < RDoc::Markup::Formatter
   ##
   # Adds +heading+ to the table of contents
 
-  def accept_heading heading
+  def accept_heading(heading)
     @res << heading unless suppressed? heading
   end
 
@@ -64,7 +64,7 @@ class RDoc::Markup::ToTableOfContents < RDoc::Markup::Formatter
   ##
   # Returns true if +heading+ is below the display threshold
 
-  def suppressed? heading
+  def suppressed?(heading)
     return false unless @omit_headings_below
 
     heading.level > @omit_headings_below

data/lib/rdoc/markup/to_test.rb

@@ -22,7 +22,7 @@ class RDoc::Markup::ToTest < RDoc::Markup::Formatter
     @res << convert_flow(@am.flow(paragraph.text))
   end
 
-  def accept_raw raw
+  def accept_raw(raw)
     @res << raw.parts.join
   end
 

data/lib/rdoc/markup/to_tt_only.rb

@@ -18,7 +18,7 @@ class RDoc::Markup::ToTtOnly < RDoc::Markup::Formatter
   ##
   # Creates a new tt-only formatter.
 
-  def initialize markup = nil
+  def initialize(markup = nil)
     super nil, markup
 
     add_tag :TT, nil, nil
@@ -27,28 +27,28 @@ class RDoc::Markup::ToTtOnly < RDoc::Markup::Formatter
   ##
   # Adds tts from +block_quote+ to the output
 
-  def accept_block_quote block_quote
+  def accept_block_quote(block_quote)
     tt_sections block_quote.text
   end
 
   ##
   # Pops the list type for +list+ from #list_type
 
-  def accept_list_end list
+  def accept_list_end(list)
     @list_type.pop
   end
 
   ##
   # Pushes the list type for +list+ onto #list_type
 
-  def accept_list_start list
+  def accept_list_start(list)
     @list_type << list.type
   end
 
   ##
   # Prepares the visitor for consuming +list_item+
 
-  def accept_list_item_start list_item
+  def accept_list_item_start(list_item)
     case @list_type.last
     when :NOTE, :LABEL then
       Array(list_item.label).map do |label|
@@ -60,7 +60,7 @@ class RDoc::Markup::ToTtOnly < RDoc::Markup::Formatter
   ##
   # Adds +paragraph+ to the output
 
-  def accept_paragraph paragraph
+  def accept_paragraph(paragraph)
     tt_sections(paragraph.text)
   end
 
@@ -68,7 +68,7 @@ class RDoc::Markup::ToTtOnly < RDoc::Markup::Formatter
   # Does nothing to +markup_item+ because it doesn't have any user-built
   # content
 
-  def do_nothing markup_item
+  def do_nothing(markup_item)
   end
 
   alias accept_blank_line    do_nothing # :nodoc:
@@ -81,7 +81,7 @@ class RDoc::Markup::ToTtOnly < RDoc::Markup::Formatter
   ##
   # Extracts tt sections from +text+
 
-  def tt_sections text
+  def tt_sections(text)
     flow = @am.flow text.dup
 
     flow.each do |item|

data/lib/rdoc/markup/verbatim.rb

@@ -15,14 +15,14 @@ class RDoc::Markup::Verbatim < RDoc::Markup::Raw
     @format = nil
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     super and @format == other.format
   end
 
   ##
   # Calls #accept_verbatim on +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_verbatim self
   end
 
@@ -50,7 +50,7 @@ class RDoc::Markup::Verbatim < RDoc::Markup::Raw
     @parts = parts
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     self.class.name =~ /.*::(\w{1,4})/i
 
     q.group 2, "[#{$1.downcase}: ", ']' do

data/lib/rdoc/markup.rb

@@ -118,7 +118,7 @@ class RDoc::Markup
   ##
   # Parses +str+ into an RDoc::Markup::Document.
 
-  def self.parse str
+  def self.parse(str)
     RDoc::Markup::Parser.parse str
   rescue RDoc::Markup::Parser::Error => e
     $stderr.puts <<-EOF
@@ -148,7 +148,7 @@ https://github.com/ruby/rdoc/issues
   # structure (paragraphs, lists, and so on).  Invoke an event handler as we
   # identify significant chunks.
 
-  def initialize attribute_manager = nil
+  def initialize(attribute_manager = nil)
     @attribute_manager = attribute_manager || RDoc::Markup::AttributeManager.new
     @output = nil
   end
@@ -185,7 +185,7 @@ https://github.com/ruby/rdoc/issues
   # We take +input+, parse it if necessary, then invoke the output +formatter+
   # using a Visitor to render the result.
 
-  def convert input, formatter
+  def convert(input, formatter)
     document = case input
                when RDoc::Markup::Document then
                  input

data/lib/rdoc/options.rb

@@ -363,7 +363,22 @@ class RDoc::Options
   # Words to be ignored in autolink cross-references
   attr_accessor :autolink_excluded_words
 
-  def initialize loaded_options = nil # :nodoc:
+  ##
+  # The prefix to use for class and module page paths
+
+  attr_accessor :class_module_path_prefix
+
+  ##
+  # The prefix to use for file page paths
+
+  attr_accessor :file_path_prefix
+
+  ##
+  # The preferred root URL for the documentation
+
+  attr_accessor :canonical_root
+
+  def initialize(loaded_options = nil) # :nodoc:
     init_ivars
     override loaded_options if loaded_options
   end
@@ -417,9 +432,12 @@ class RDoc::Options
     @charset = @encoding.name
     @skip_tests = true
     @apply_default_exclude = true
+    @class_module_path_prefix = nil
+    @file_path_prefix = nil
+    @canonical_root = nil
   end
 
-  def init_with map # :nodoc:
+  def init_with(map) # :nodoc:
     init_ivars
 
     encoding = map['encoding']
@@ -450,11 +468,11 @@ class RDoc::Options
     @static_path  = sanitize_path map['static_path']
   end
 
-  def yaml_initialize tag, map # :nodoc:
+  def yaml_initialize(tag, map) # :nodoc:
     init_with map
   end
 
-  def override map # :nodoc:
+  def override(map) # :nodoc:
     if map.has_key?('encoding')
       encoding = map['encoding']
       @encoding = encoding ? Encoding.find(encoding) : encoding
@@ -480,6 +498,7 @@ class RDoc::Options
     @webcvs         = map['webcvs']         if map.has_key?('webcvs')
     @autolink_excluded_words = map['autolink_excluded_words'] if map.has_key?('autolink_excluded_words')
     @apply_default_exclude = map['apply_default_exclude'] if map.has_key?('apply_default_exclude')
+    @canonical_root = map['canonical_root'] if map.has_key?('canonical_root')
 
     @warn_missing_rdoc_ref = map['warn_missing_rdoc_ref'] if map.has_key?('warn_missing_rdoc_ref')
 
@@ -491,7 +510,7 @@ class RDoc::Options
     end
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     self.class === other and
       @encoding       == other.encoding       and
       @embed_mixins   == other.embed_mixins   and
@@ -683,7 +702,7 @@ class RDoc::Options
   ##
   # Parses command line options.
 
-  def parse argv
+  def parse(argv)
     ignore_invalid = true
 
     argv.insert(0, *ENV['RDOCOPT'].split) if ENV['RDOCOPT']
@@ -1262,14 +1281,14 @@ Usage: #{opt.program_name} [options] [names...]
   ##
   # Set quietness to +bool+
 
-  def quiet= bool
+  def quiet=(bool)
     @verbosity = bool ? 0 : 1
   end
 
   ##
   # Removes directories from +path+ that are outside the current directory
 
-  def sanitize_path path
+  def sanitize_path(path)
     require 'pathname'
     dot = Pathname.new('.').expand_path
 
@@ -1296,7 +1315,7 @@ Usage: #{opt.program_name} [options] [names...]
   # the options instance.  This allows generators to add custom options or set
   # default options.
 
-  def setup_generator generator_name = @generator_name
+  def setup_generator(generator_name = @generator_name)
     @generator = @generators[generator_name]
 
     unless @generator then
@@ -1318,7 +1337,7 @@ Usage: #{opt.program_name} [options] [names...]
   ##
   # Finds the template dir for +template+
 
-  def template_dir_for template
+  def template_dir_for(template)
     template_path = File.join 'rdoc', 'generator', 'template', template
 
     $LOAD_PATH.map do |path|
@@ -1335,7 +1354,7 @@ Usage: #{opt.program_name} [options] [names...]
   # When +:all+ is passed, visibility is set to +:private+, similarly to
   # RDOCOPT="--all", see #visibility for more information.
 
-  def visibility= visibility
+  def visibility=(visibility)
     case visibility
     when :all
       @visibility = :private
@@ -1347,7 +1366,7 @@ Usage: #{opt.program_name} [options] [names...]
   ##
   # Displays a warning using Kernel#warn if we're being verbose
 
-  def warn message
+  def warn(message)
     super message if @verbosity > 1
   end
 

data/lib/rdoc/parser/c.rb

@@ -168,7 +168,7 @@ class RDoc::Parser::C < RDoc::Parser
   # Prepares for parsing a C file.  See RDoc::Parser#initialize for details on
   # the arguments.
 
-  def initialize top_level, content, options, stats
+  def initialize(top_level, content, options, stats)
     super
 
     @known_classes = RDoc::KNOWN_CLASSES.dup
@@ -193,7 +193,7 @@ class RDoc::Parser::C < RDoc::Parser
 
     @enclosure_dependencies.extend TSort
 
-    def @enclosure_dependencies.tsort_each_node &block
+    def @enclosure_dependencies.tsort_each_node(&block)
       each_key(&block)
     rescue TSort::Cyclic => e
       cycle_vars = e.message.scan(/"(.*?)"/).flatten
@@ -211,7 +211,7 @@ class RDoc::Parser::C < RDoc::Parser
       retry
     end
 
-    def @enclosure_dependencies.tsort_each_child node, &block
+    def @enclosure_dependencies.tsort_each_child(node, &block)
       fetch(node, []).each(&block)
     end
   end
@@ -519,7 +519,7 @@ class RDoc::Parser::C < RDoc::Parser
   # Finds the comment for an alias on +class_name+ from +new_name+ to
   # +old_name+
 
-  def find_alias_comment class_name, new_name, old_name
+  def find_alias_comment(class_name, new_name, old_name)
     content =~ %r%((?>/\*.*?\*/\s+))
                   rb_define_alias\(\s*#{Regexp.escape class_name}\s*,
                                    \s*"#{Regexp.escape new_name}"\s*,
@@ -537,7 +537,7 @@ class RDoc::Parser::C < RDoc::Parser
   # +read+ and +write+ are the read/write flags ('1' or '0').  Either both or
   # neither must be provided.
 
-  def find_attr_comment var_name, attr_name, read = nil, write = nil
+  def find_attr_comment(var_name, attr_name, read = nil, write = nil)
     attr_name = Regexp.escape attr_name
 
     rw = if read and write then
@@ -570,7 +570,7 @@ class RDoc::Parser::C < RDoc::Parser
   ##
   # Generate a Ruby-method table
 
-  def gen_body_table file_content
+  def gen_body_table(file_content)
     table = {}
     file_content.scan(%r{
       ((?>/\*.*?\*/\s*)?)
@@ -594,7 +594,7 @@ class RDoc::Parser::C < RDoc::Parser
   ##
   # Find the C code corresponding to a Ruby method
 
-  def find_body class_name, meth_name, meth_obj, file_content, quiet = false
+  def find_body(class_name, meth_name, meth_obj, file_content, quiet = false)
     if file_content
       @body_table ||= {}
       @body_table[file_content] ||= gen_body_table file_content
@@ -719,7 +719,7 @@ class RDoc::Parser::C < RDoc::Parser
   #    */
   #   VALUE cFoo = rb_define_class("Foo", rb_cObject);
 
-  def find_class_comment class_name, class_mod
+  def find_class_comment(class_name, class_mod)
     comment = nil
 
     if @content =~ %r%
@@ -752,7 +752,7 @@ class RDoc::Parser::C < RDoc::Parser
   ##
   # Generate a const table
 
-  def gen_const_table file_content
+  def gen_const_table(file_content)
     table = {}
     @content.scan(%r{
       (?<doc>(?>^\s*/\*.*?\*/\s+))
@@ -806,7 +806,7 @@ class RDoc::Parser::C < RDoc::Parser
   ##
   # Handles modifiers in +comment+ and updates +meth_obj+ as appropriate.
 
-  def find_modifiers comment, meth_obj
+  def find_modifiers(comment, meth_obj)
     comment.normalize
     meth_obj.call_seq = comment.extract_call_seq
 
@@ -816,7 +816,7 @@ class RDoc::Parser::C < RDoc::Parser
   ##
   # Finds a <tt>Document-method</tt> override for +meth_obj+ on +class_name+
 
-  def find_override_comment class_name, meth_obj
+  def find_override_comment(class_name, meth_obj)
     name = Regexp.escape meth_obj.name
     prefix = Regexp.escape meth_obj.name_prefix
 
@@ -1060,7 +1060,7 @@ class RDoc::Parser::C < RDoc::Parser
   ##
   # Registers a singleton class +sclass_var+ as a singleton of +class_var+
 
-  def handle_singleton sclass_var, class_var
+  def handle_singleton(sclass_var, class_var)
     class_name = @known_classes[class_var]
 
     @known_classes[sclass_var]     = class_name
@@ -1071,7 +1071,7 @@ class RDoc::Parser::C < RDoc::Parser
   # Loads the variable map with the given +name+ from the RDoc::Store, if
   # present.
 
-  def load_variable_map map_name
+  def load_variable_map(map_name)
     return {} unless files = @store.cache[map_name]
     return {} unless name_map = files[@file_name]
 
@@ -1101,7 +1101,7 @@ 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.
 
-  def look_for_directives_in context, comment
+  def look_for_directives_in(context, comment)
     @preprocess.handle comment, context do |directive, param|
       case directive
       when 'main' then
@@ -1138,7 +1138,7 @@ class RDoc::Parser::C < RDoc::Parser
   # Extracts parameters from the +method_body+ and returns a method
   # parameter string.  Follows 1.9.3dev's scan-arg-spec, see README.EXT
 
-  def rb_scan_args method_body
+  def rb_scan_args(method_body)
     method_body =~ /rb_scan_args\((.*?)\)/m
     return '(*args)' unless $1
 
@@ -1249,7 +1249,7 @@ class RDoc::Parser::C < RDoc::Parser
   ##
   # Creates a RDoc::Comment instance.
 
-  def new_comment text = nil, location = nil, language = nil
+  def new_comment(text = nil, location = nil, language = nil)
     RDoc::Comment.new(text, location, language).tap do |comment|
       comment.format = @markup
     end

data/lib/rdoc/parser/changelog.rb

@@ -23,7 +23,7 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
   # Continued function listings are joined together as a single entry.
   # Continued descriptions are joined to make a single paragraph.
 
-  def continue_entry_body entry_body, continuation
+  def continue_entry_body(entry_body, continuation)
     return unless last = entry_body.last
 
     if last =~ /\)\s*\z/ and continuation =~ /\A\(/ then
@@ -41,7 +41,7 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
   ##
   # Creates an RDoc::Markup::Document given the +groups+ of ChangeLog entries.
 
-  def create_document groups
+  def create_document(groups)
     doc = RDoc::Markup::Document.new
     doc.omit_headings_below = 2
     doc.file = @top_level
@@ -63,7 +63,7 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
   # Returns a list of ChangeLog entries an RDoc::Markup nodes for the given
   # +entries+.
 
-  def create_entries entries
+  def create_entries(entries)
     out = []
 
     entries.each do |entry, items|
@@ -80,7 +80,7 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
   # Returns an RDoc::Markup::List containing the given +items+ in the
   # ChangeLog
 
-  def create_items items
+  def create_items(items)
     list = RDoc::Markup::List.new :NOTE
 
     items.each do |item|
@@ -100,7 +100,7 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
   ##
   # Groups +entries+ by date.
 
-  def group_entries entries
+  def group_entries(entries)
     @time_cache ||= {}
     entries.group_by do |title, _|
       begin
@@ -260,7 +260,7 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
     # RDoc::Parser::ChangeLog::Git::LogEntry list for the given
     # +entries+.
 
-    def create_entries entries
+    def create_entries(entries)
       # git log entries have no strictly itemized style like the old
       # style, just assume Markdown.
       entries.map do |commit, entry|
@@ -296,7 +296,7 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
         "label-#{commit}"
       end
 
-      def label context = nil
+      def label(context = nil)
         aref
       end
 
@@ -311,7 +311,7 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
         end + " {#{author}}[mailto:#{email}]"
       end
 
-      def accept visitor
+      def accept(visitor)
         visitor.accept_heading self
         begin
           if visitor.respond_to?(:code_object=)
@@ -328,7 +328,7 @@ class RDoc::Parser::ChangeLog < RDoc::Parser
         end
       end
 
-      def pretty_print q # :nodoc:
+      def pretty_print(q) # :nodoc:
         q.group(2, '[log_entry: ', ']') do
           q.text commit
           q.text ','

data/lib/rdoc/parser/prism_ruby.rb

@@ -77,7 +77,7 @@ class RDoc::Parser::PrismRuby < RDoc::Parser
   # 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.
 
-  def record_location container # :nodoc:
+  def record_location(container) # :nodoc:
     case container
     when RDoc::ClassModule then
       @top_level.add_to_classes_or_modules container