Class: Konfa::AutoDoc::Formatter

Inherits:
Object
  • Object
show all
Defined in:
lib/konfa/autodoc/formatter.rb

Direct Known Subclasses

Markdown

Defined Under Namespace

Classes: ImplementationMissing

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(const, version = nil) ⇒ Formatter

Returns a new instance of Formatter.



7
8
9
10
 
# File 'lib/konfa/autodoc/formatter.rb', line 7

def initialize(const, version=nil)
  @konfa_class = const
  @version = version
end

Instance Attribute Details

#konfa_class ⇒ Object (readonly)

Returns the value of attribute konfa_class.



4
5
6
 
# File 'lib/konfa/autodoc/formatter.rb', line 4

def konfa_class
  @konfa_class
end

#version ⇒ Object

Returns the value of attribute version.



5
6
7
 
# File 'lib/konfa/autodoc/formatter.rb', line 5

def version
  @version
end

Instance Method Details

#format(variables) ⇒ Object

Raises:



17
18
19
 
# File 'lib/konfa/autodoc/formatter.rb', line 17

def format(variables)
  raise ImplementationMissing.new
end

#generate ⇒ Object 



12
13
14
15
 
# File 'lib/konfa/autodoc/formatter.rb', line 12

def generate
  autodoc = Konfa::AutoDoc::Parser.new(@konfa_class)
  format(autodoc.parse)
end