In Files

  • rdoc/ri/descriptions.rb

Files

Class/Module Index [+]

Quicksearch

RDoc::RI::ModuleDescription

Attributes

attributes[RW]
class_method_extensions[RW]
class_methods[RW]
constants[RW]
includes[RW]
instance_method_extensions[RW]
instance_methods[RW]

Public Instance Methods

display_name() click to toggle source
 
               # File rdoc/ri/descriptions.rb, line 108
def display_name
    "Module"
end
            
merge_in(old) click to toggle source

merge in another class description into this one

 
               # File rdoc/ri/descriptions.rb, line 88
def merge_in(old)
  merge(@class_methods, old.class_methods)
  merge(@instance_methods, old.instance_methods)
  merge(@attributes, old.attributes)
  merge(@constants, old.constants)
  merge(@includes, old.includes)
  if @comment.nil? || @comment.empty?
    @comment = old.comment
  else
    unless old.comment.nil? or old.comment.empty? then
      if @comment.nil? or @comment.empty? then
        @comment = old.comment
      else
        @comment << RDoc::Markup::Flow::RULE.new
        @comment.concat old.comment
      end
    end
  end
end
            
superclass_string() click to toggle source

the ‘ClassDescription’ subclass overrides this to format up the name of a parent

 
               # File rdoc/ri/descriptions.rb, line 114
def superclass_string
  nil
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus