Class: Brainstem::ApiDocs::Formatters::Markdown::PresenterFormatter

Inherits:
AbstractFormatter
  • Object
show all
Includes:
Helper
Defined in:
lib/brainstem/api_docs/formatters/markdown/presenter_formatter.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Helper

#md_a, #md_code, #md_h1, #md_h2, #md_h3, #md_h4, #md_h5, #md_hr, #md_inline_code, #md_li, #md_p, #md_strong, #md_ul

Methods inherited from AbstractFormatter

call

Methods included from Concerns::Optional

#valid_options

Constructor Details

#initialize(presenter, options = {}) ⇒ PresenterFormatter

Returns a new instance of PresenterFormatter.



13
14
15
16
17
 
# File 'lib/brainstem/api_docs/formatters/markdown/presenter_formatter.rb', line 13

def initialize(presenter, options = {})
  self.presenter = presenter
  self.output    = ""
  super options
end

Instance Attribute Details

#output ⇒ Object

Returns the value of attribute output.



20
21
22
 
# File 'lib/brainstem/api_docs/formatters/markdown/presenter_formatter.rb', line 20

def output
  @output
end

#presenter ⇒ Object

Returns the value of attribute presenter.



20
21
22
 
# File 'lib/brainstem/api_docs/formatters/markdown/presenter_formatter.rb', line 20

def presenter
  @presenter
end

Instance Method Details

#call ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/brainstem/api_docs/formatters/markdown/presenter_formatter.rb', line 24

def call
  return output if presenter.nodoc?

  format_title!
  format_brainstem_keys!
  format_description!
  format_fields!
  format_filters!
  format_sort_orders!
  format_associations!

  output
end