Class: RDoc::RI::NamedThing
- Inherits:
-
Object
- Object
- RDoc::RI::NamedThing
- Defined in:
- lib/rdoc/ri/descriptions.rb
Overview
– 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 ++
Direct Known Subclasses
AliasName, Attribute, Constant, IncludedModule, MethodSummary
Instance Attribute Summary collapse
-
#name ⇒ Object
readonly
Returns the value of attribute name.
Instance Method Summary collapse
- #<=>(other) ⇒ Object
- #eql?(other) ⇒ Boolean
- #hash ⇒ Object
-
#initialize(name) ⇒ NamedThing
constructor
A new instance of NamedThing.
Constructor Details
#initialize(name) ⇒ NamedThing
Returns a new instance of NamedThing.
13 14 15 |
# File 'lib/rdoc/ri/descriptions.rb', line 13 def initialize(name) @name = name end |
Instance Attribute Details
#name ⇒ Object (readonly)
Returns the value of attribute name.
12 13 14 |
# File 'lib/rdoc/ri/descriptions.rb', line 12 def name @name end |
Instance Method Details
#<=>(other) ⇒ Object
17 18 19 |
# File 'lib/rdoc/ri/descriptions.rb', line 17 def <=>(other) @name <=> other.name end |
#eql?(other) ⇒ Boolean
25 26 27 |
# File 'lib/rdoc/ri/descriptions.rb', line 25 def eql?(other) @name.eql?(other) end |
#hash ⇒ Object
21 22 23 |
# File 'lib/rdoc/ri/descriptions.rb', line 21 def hash @name.hash end |