Class: Kumi::DocGenerator::Formatters::Markdown

Inherits:
Object
  • Object
show all
Defined in:
lib/kumi/doc_generator/formatters/markdown.rb

Instance Method Summary collapse

Constructor Details

#initialize(docs) ⇒ Markdown 



5
6
7
 
# File 'lib/kumi/doc_generator/formatters/markdown.rb', line 5

def initialize(docs)
  @docs = docs
end

Instance Method Details

#format ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/kumi/doc_generator/formatters/markdown.rb', line 9

def format
  lines = [
    "# Kumi Function Reference",
    "",
    "Auto-generated documentation for Kumi functions and their kernels.",
    ""
  ]

  grouped = group_by_id(@docs)

  grouped.sort.each do |id, aliases|
    entry = @docs[aliases.first]
    lines.concat(format_function(id, entry, aliases))
  end

  lines.join("\n")
end