Sync RDoc 6.14.0

Author: st0012

doc/rdoc/markup_reference.rb

@@ -859,6 +859,15 @@
 #   - On-page: <tt>DummyClass</tt> links to DummyClass.
 #   - Off-page: <tt>RDoc::Alias</tt> links to RDoc::Alias.
 #
+#   Note: For poeple want to mark up code (such as class, module,
+#   constant, and method) as "<tt>+code+</tt>" (for interoperability
+#   with other MarkDown parsers mainly), such word that refers a known
+#   code object and is marked up entirely and separately as "monofont"
+#   is also converted to a link.
+#
+#   - <tt>+DummyClass+</tt> links to DummyClass
+#   - <tt>+DummyClass-object+</tt> is not a link.
+#
 # [Module]
 #
 #   - On-page: <tt>DummyModule</tt> links to DummyModule.
@@ -987,8 +996,7 @@
 #   and entire <tt>rdoc-ref:</tt> square-bracketed clause is removed
 #   from the resulting text.
 #
-#   - <tt>Nosuch[rdoc-ref:RDoc::Nosuch]</tt> generates
-#     Nosuch[rdoc-ref:RDoc::Nosuch].
+#   - <tt>Nosuch[rdoc-ref:RDoc::Nosuch]</tt> generates Nosuch.
 #
 #
 # [<tt>rdoc-label</tt> Scheme]

lib/rdoc/code_object.rb

@@ -21,9 +21,10 @@
 #     * RDoc::MetaMethod
 # * RDoc::Alias
 # * RDoc::Constant
+# * RDoc::Require
 # * RDoc::Mixin
-#   * RDoc::Require
 #   * RDoc::Include
+#   * RDoc::Extend
 
 class RDoc::CodeObject
 
@@ -89,13 +90,6 @@ class RDoc::CodeObject
 
   attr_reader :store
 
-  ##
-  # 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.
-
-  attr_accessor :viewer
-
   ##
   # When mixed-in to a class, this points to the Context in which it was originally defined.
 
@@ -141,7 +135,6 @@ def initialize_visibility # :nodoc:
   def comment=(comment)
     @comment = case comment
                when NilClass               then ''
-               when RDoc::Markup::Document then comment
                when RDoc::Comment          then comment.normalize
                else
                  if comment and not comment.empty? then
@@ -217,20 +210,6 @@ def done_documenting=(value)
     @document_children = @document_self
   end
 
-  ##
-  # Yields each parent of this CodeObject.  See also
-  # RDoc::ClassModule#each_ancestor
-
-  def each_parent
-    code_object = self
-
-    while code_object = code_object.parent do
-      yield code_object
-    end
-
-    self
-  end
-
   ##
   # File name where this CodeObject was found.
   #
@@ -257,7 +236,7 @@ def force_documentation=(value)
   #
   # Set to +nil+ to clear RDoc's cached value
 
-  def full_name= full_name
+  def full_name=(full_name)
     @full_name = full_name
   end
 
@@ -301,11 +280,7 @@ def ignored?
   # This is used by Text#snippet
 
   def options
-    if @store and @store.rdoc then
-      @store.rdoc.options
-    else
-      RDoc::Options.new
-    end
+    @store&.options || RDoc::Options.new
   end
 
   ##
@@ -331,13 +306,6 @@ def parent
     end
   end
 
-  ##
-  # File name of our parent
-
-  def parent_file_name
-    @parent ? @parent.base_name : '(unknown)'
-  end
-
   ##
   # Name of our parent
 
@@ -348,7 +316,7 @@ def parent_name
   ##
   # Records the RDoc::TopLevel (file) where this code object was defined
 
-  def record_location top_level
+  def record_location(top_level)
     @ignored    = false
     @suppressed = false
     @file       = top_level
@@ -390,7 +358,7 @@ def stop_doc
   ##
   # Sets the +store+ that contains this CodeObject
 
-  def store= store
+  def store=(store)
     @store = store
 
     return unless @track_visibility

lib/rdoc/code_object/alias.rb

@@ -23,7 +23,7 @@ class RDoc::Alias < RDoc::CodeObject
   ##
   # Is this an alias declared in a singleton context?
 
-  attr_accessor :singleton
+  attr_reader :singleton
 
   ##
   # Source file token stream
@@ -34,7 +34,7 @@ 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.
 
-  def initialize(text, old_name, new_name, comment, singleton = false)
+  def initialize(text, old_name, new_name, comment, singleton: false)
     super()
 
     @text = text
@@ -59,13 +59,6 @@ def aref
     "#alias-#{type}-#{html_name}"
   end
 
-  ##
-  # Full old name including namespace
-
-  def full_old_name
-    @full_name || "#{parent.name}#{pretty_old_name}"
-  end
-
   ##
   # HTML id-friendly version of +#new_name+.
 

lib/rdoc/code_object/any_method.rb

@@ -29,10 +29,6 @@ class RDoc::AnyMethod < RDoc::MethodAttr
   # The section title of the method (if defined in a C file via +:category:+)
   attr_accessor :section_title
 
-  # Parameters for this method
-
-  attr_accessor :params
-
   ##
   # If true this method uses +super+ to call a superclass version
 
@@ -43,8 +39,8 @@ class RDoc::AnyMethod < RDoc::MethodAttr
   ##
   # Creates a new AnyMethod with a token stream +text+ and +name+
 
-  def initialize text, name
-    super
+  def initialize(text, name, singleton: false)
+    super(text, name, singleton: singleton)
 
     @c_function = nil
     @dont_rename_initialize = false
@@ -56,11 +52,10 @@ def initialize text, name
   ##
   # Adds +an_alias+ as an alias for this method in +context+.
 
-  def add_alias an_alias, context = nil
-    method = self.class.new an_alias.text, an_alias.new_name
+  def add_alias(an_alias, context = nil)
+    method = self.class.new an_alias.text, an_alias.new_name, singleton: singleton
 
     method.record_location an_alias.file
-    method.singleton = self.singleton
     method.params = self.params
     method.visibility = self.visibility
     method.comment = an_alias.comment
@@ -109,8 +104,8 @@ def call_seq
   #
   # See also #param_seq
 
-  def call_seq= call_seq
-    return if call_seq.empty?
+  def call_seq=(call_seq)
+    return if call_seq.nil? || call_seq.empty?
 
     @call_seq = call_seq
   end
@@ -181,7 +176,7 @@ def marshal_dump
   # * #full_name
   # * #parent_name
 
-  def marshal_load array
+  def marshal_load(array)
     initialize_visibility
 
     @dont_rename_initialize = nil
@@ -198,7 +193,7 @@ def marshal_load array
     @full_name     = array[2]
     @singleton     = array[3]
     @visibility    = array[4]
-    @comment       = array[5]
+    @comment       = RDoc::Comment.from_document array[5]
     @call_seq      = array[6]
     @block_params  = array[7]
     #                      8 handled below
@@ -210,8 +205,8 @@ def marshal_load array
     @section_title = array[14]
     @is_alias_for  = array[15]
 
-    array[8].each do |new_name, comment|
-      add_alias RDoc::Alias.new(nil, @name, new_name, comment, @singleton)
+    array[8].each do |new_name, document|
+      add_alias RDoc::Alias.new(nil, @name, new_name, RDoc::Comment.from_document(document), singleton: @singleton)
     end
 
     @parent_name ||= if @full_name =~ /#/ then
@@ -314,7 +309,7 @@ def skip_description?
   ##
   # Sets the store for this method and its referenced code objects.
 
-  def store= store
+  def store=(store)
     super
 
     @file = @store.add_file @file.full_name if @file

lib/rdoc/code_object/attr.rb

@@ -22,18 +22,17 @@ 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.
 
-  def initialize(text, name, rw, comment, singleton = false)
-    super text, name
+  def initialize(text, name, rw, comment, singleton: false)
+    super(text, name, singleton: singleton)
 
     @rw = rw
-    @singleton = singleton
     self.comment = comment
   end
 
   ##
   # Attributes are equal when their names, singleton and rw are identical
 
-  def == other
+  def ==(other)
     self.class == other.class and
       self.name == other.name and
       self.rw == other.rw and
@@ -44,9 +43,7 @@ def == other
   # Add +an_alias+ as an attribute in +context+.
 
   def add_alias(an_alias, context)
-    new_attr = self.class.new(self.text, an_alias.new_name, self.rw,
-                              self.comment, self.singleton)
-
+    new_attr = self.class.new(text, an_alias.new_name, rw, comment, singleton: singleton)
     new_attr.record_location an_alias.file
     new_attr.visibility = self.visibility
     new_attr.is_alias_for = self
@@ -121,7 +118,7 @@ def marshal_dump
   # * #full_name
   # * #parent_name
 
-  def marshal_load array
+  def marshal_load(array)
     initialize_visibility
 
     @aliases      = []
@@ -136,7 +133,7 @@ def marshal_load array
     @full_name     = array[2]
     @rw            = array[3]
     @visibility    = array[4]
-    @comment       = array[5]
+    @comment       = RDoc::Comment.from_document array[5]
     @singleton     = array[6] || false # MARSHAL_VERSION == 0
     #                      7 handled below
     @parent_name   = array[8]
@@ -148,7 +145,7 @@ def marshal_load array
     @parent_name ||= @full_name.split('#', 2).first
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.group 2, "[#{self.class.name} #{full_name} #{rw} #{visibility}", "]" do
       unless comment.empty? then
         q.breakable