Class: Konfa::AutoDoc::Markdown

Inherits:
Formatter show all
Defined in:
lib/konfa/autodoc/markdown.rb

Instance Attribute Summary

Attributes inherited from Formatter

#konfa_class, #version

Instance Method Summary collapse

Methods inherited from Formatter

#generate, #initialize

Constructor Details

This class inherits a constructor from Konfa::AutoDoc::Formatter

Instance Method Details

#format(variables) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
15
 
# File 'lib/konfa/autodoc/markdown.rb', line 4

def format(variables)
  md_lines  = [header(konfa_class.name)]
  md_lines << "*Version: #{version}*" unless version.nil?

  variables.each do |variable|
    md_lines << header(variable.name, 2)
    md_lines << "Default: *#{variable.default}*"
    md_lines << variable.comment unless variable.comment.nil?
  end

  md_lines.join("\n\n")
end