Class: RI::Description

Inherits:
Object
  • Object
show all
Defined in:
lib/rdoc/ri/ri_descriptions.rb

Direct Known Subclasses

MethodDescription, ModuleDescription

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#comment ⇒ Object

Returns the value of attribute comment



65
66
67
 
# File 'lib/rdoc/ri/ri_descriptions.rb', line 65

def comment
  @comment
end

#full_name ⇒ Object

Returns the value of attribute full_name



64
65
66
 
# File 'lib/rdoc/ri/ri_descriptions.rb', line 64

def full_name
  @full_name
end

#name ⇒ Object

Returns the value of attribute name



63
64
65
 
# File 'lib/rdoc/ri/ri_descriptions.rb', line 63

def name
  @name
end

Class Method Details

.deserialize(from) ⇒ Object 



71
72
73
 
# File 'lib/rdoc/ri/ri_descriptions.rb', line 71

def Description.deserialize(from)
  YAML.load(from)
end

Instance Method Details

#<=>(other) ⇒ Object 



75
76
77
 
# File 'lib/rdoc/ri/ri_descriptions.rb', line 75

def <=>(other)
  @name <=> other.name
end

#serialize ⇒ Object 



67
68
69
 
# File 'lib/rdoc/ri/ri_descriptions.rb', line 67

def serialize
  self.to_yaml
end