Class: RDoc::Parser::Markdown

Inherits:

RDoc::Parser

• Object
• RDoc::Parser
• RDoc::Parser::Markdown

Includes:

Text

Defined in:

lib/rdoc/parser/markdown.rb

Overview

Parse a Markdown format file. The parsed RDoc::Markup::Document is attached as a file comment.

Instance Attribute Summary

Attributes inherited from RDoc::Parser

#file_name

Instance Method Summary

• #scan ⇒ Object

  Creates an Markdown-format TopLevel for the given file.

Methods inherited from RDoc::Parser

alias_extension, binary?, can_parse, can_parse_by_name, check_modeline, for, #handle_tab_width, #initialize, parse_files_matching, remove_modeline, use_markup, zip?

Constructor Details

This class inherits a constructor from RDoc::Parser

Instance Method Details

#scan ⇒ Object

Creates an Markdown-format TopLevel for the given file.

# File 'lib/rdoc/parser/markdown.rb', line 15

def scan
  comment = RDoc::Comment.new @content, @top_level
  comment.format = 'markdown'

  @top_level.comment = comment
end