Class: RDoc::Generator::Mdoc::Constant

Inherits:

Object

• Object
• RDoc::Generator::Mdoc::Constant

Defined in:

lib/rdoc/generator/mdoc/constant.rb

Instance Method Summary

• #described? ⇒ Boolean
• #description ⇒ Object
• #initialize(rdoc_constant) ⇒ Constant constructor

  A new instance of Constant.

• #name ⇒ Object
• #value ⇒ Object

Constructor Details

#initialize(rdoc_constant) ⇒ Constant

Returns a new instance of Constant.

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

def initialize(rdoc_constant)
  @rdoc_constant = rdoc_constant
end

Instance Method Details

#described? ⇒ Boolean

Returns:

• (Boolean)

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

def described?
  !description.empty?
end

#description ⇒ Object

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

def description
  comment.mdoc_formatted_content
end

#name ⇒ Object

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

def name
  rdoc_constant.name
end

#value ⇒ Object

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

def value
  rdoc_constant.value
end