Class: RDoc::Generator::Mdoc::Attribute

Inherits:

Object

• Object
• RDoc::Generator::Mdoc::Attribute

Defined in:

lib/rdoc/generator/mdoc/attribute.rb

Instance Method Summary

• #described? ⇒ Boolean
• #description ⇒ Object
• #initialize(rdoc_attribute) ⇒ Attribute constructor

  A new instance of Attribute.

• #name ⇒ Object
• #rw ⇒ Object

Constructor Details

#initialize(rdoc_attribute) ⇒ Attribute

Returns a new instance of Attribute.

# File 'lib/rdoc/generator/mdoc/attribute.rb', line 5

def initialize(rdoc_attribute)
  @rdoc_attribute = rdoc_attribute
end

Instance Method Details

#described? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/rdoc/generator/mdoc/attribute.rb', line 17

def described?
  !description.empty?
end

#description ⇒ Object

# File 'lib/rdoc/generator/mdoc/attribute.rb', line 21

def description
  comment.mdoc_formatted_content
end

#name ⇒ Object

# File 'lib/rdoc/generator/mdoc/attribute.rb', line 9

def name
  rdoc_attribute.name
end

#rw ⇒ Object

# File 'lib/rdoc/generator/mdoc/attribute.rb', line 13

def rw
  rdoc_attribute.rw
end