In Files

  • rdoc/ri/descriptions.rb

Parent

Methods

Files

Class/Module Index [+]

Quicksearch

RDoc::RI::NamedThing

Descriptions are created by RDoc (in ri_generator) and written out in serialized form into the documentation tree. ri then reads these to generate the documentation

Attributes

name[R]

Public Class Methods

new(name) click to toggle source
 
               # File rdoc/ri/descriptions.rb, line 12
def initialize(name)
  @name = name
end
            

Public Instance Methods

<=>(other) click to toggle source
 
               # File rdoc/ri/descriptions.rb, line 16
def <=>(other)
  @name <=> other.name
end
            
eql?(other) click to toggle source
 
               # File rdoc/ri/descriptions.rb, line 24
def eql?(other)
  @name.eql?(other)
end
            
hash() click to toggle source
 
               # File rdoc/ri/descriptions.rb, line 20
def hash
  @name.hash
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