Class: RDoc::RI::Description

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

Direct Known Subclasses

MethodDescription, ModuleDescription

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#commentObject

Returns the value of attribute comment.



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

def comment
  @comment
end

#full_nameObject

Returns the value of attribute full_name.



62
63
64
# File 'lib/rdoc/ri/descriptions.rb', line 62

def full_name
  @full_name
end

#nameObject

Returns the value of attribute name.



61
62
63
# File 'lib/rdoc/ri/descriptions.rb', line 61

def name
  @name
end

Class Method Details

.deserialize(from) ⇒ Object



69
70
71
# File 'lib/rdoc/ri/descriptions.rb', line 69

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

Instance Method Details

#<=>(other) ⇒ Object



73
74
75
# File 'lib/rdoc/ri/descriptions.rb', line 73

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

#serializeObject



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

def serialize
  self.to_yaml
end