Class: RDoc::Attr

Inherits:

CodeObject

• Object
• CodeObject
• RDoc::Attr

Defined in:

lib/rdoc/code_objects.rb

Overview

Represent attributes

Instance Attribute Summary

• #name ⇒ Object

  Returns the value of attribute name.

• #rw ⇒ Object

  Returns the value of attribute rw.

• #text ⇒ Object

  Returns the value of attribute text.

• #visibility ⇒ Object

  Returns the value of attribute visibility.

Attributes inherited from CodeObject

#comment, #document_children, #document_self, #done_documenting, #force_documentation, #parent, #section, #viewer

Instance Method Summary

• #<=>(other) ⇒ Object
• #initialize(text, name, rw, comment) ⇒ Attr constructor

  A new instance of Attr.

• #to_s ⇒ Object

Methods inherited from CodeObject

attr_overridable, #remove_classes_and_modules, #remove_methods_etc, #start_doc, #stop_doc

Constructor Details

#initialize(text, name, rw, comment) ⇒ Attr

Returns a new instance of Attr.

# File 'lib/rdoc/code_objects.rb', line 722

def initialize(text, name, rw, comment)
  super()
  @text = text
  @name = name
  @rw = rw
  @visibility = :public
  self.comment = comment
end

Instance Attribute Details

#name ⇒ Object

Returns the value of attribute name.

# File 'lib/rdoc/code_objects.rb', line 720

def name
  @name
end

#rw ⇒ Object

Returns the value of attribute rw.

# File 'lib/rdoc/code_objects.rb', line 720

def rw
  @rw
end

#text ⇒ Object

Returns the value of attribute text.

# File 'lib/rdoc/code_objects.rb', line 720

def text
  @text
end

#visibility ⇒ Object

Returns the value of attribute visibility.

# File 'lib/rdoc/code_objects.rb', line 720

def visibility
  @visibility
end

Instance Method Details

#<=>(other) ⇒ Object

# File 'lib/rdoc/code_objects.rb', line 735

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

#to_s ⇒ Object

# File 'lib/rdoc/code_objects.rb', line 731

def to_s
  "attr: #{self.name} #{self.rw}\n#{self.comment}"
end