Class: RspecApiDocumentation::Writers::MarkdownWriter

Inherits:
GeneralMarkupWriter show all
Defined in:
lib/rspec_api_documentation/writers/markdown_writer.rb

Direct Known Subclasses

SlateWriter

Constant Summary collapse

EXTENSION = 
'md'

Constants inherited from GeneralMarkupWriter

GeneralMarkupWriter::INDEX_FILE_NAME

Instance Attribute Summary

Attributes inherited from Writer

#configuration, #index

Instance Method Summary collapse

Methods inherited from GeneralMarkupWriter

#index_file_name, #write

Methods inherited from Writer

clear_docs, #initialize, write

Constructor Details

This class inherits a constructor from RspecApiDocumentation::Writers::Writer

Instance Method Details

#extension ⇒ Object 



14
15
16
 
# File 'lib/rspec_api_documentation/writers/markdown_writer.rb', line 14

def extension
  EXTENSION
end

#markup_example_class ⇒ Object 



10
11
12
 
# File 'lib/rspec_api_documentation/writers/markdown_writer.rb', line 10

def markup_example_class
  RspecApiDocumentation::Views::MarkdownExample
end

#markup_index_class ⇒ Object 



6
7
8
 
# File 'lib/rspec_api_documentation/writers/markdown_writer.rb', line 6

def markup_index_class
  RspecApiDocumentation::Views::MarkdownIndex
end