Type:
Class

A parser for TomDoc based on TomDoc 1.0.0-rc1 (02adef9b5a)

The TomDoc specification can be found at:

tomdoc.org

The latest version of the TomDoc specification can be found at:

github.com/mojombo/tomdoc/blob/master/tomdoc.md

To choose TomDoc as your only default format see Saved Options at RDoc::Options for instructions on setting up a .rdoc_options file to store your project default.

There are a few differences between this parser and the specification. A best-effort was made to follow the specification as closely as possible but some choices to deviate were made.

A future version of RDoc will warn when a MUST or MUST NOT is violated and may warn when a SHOULD or SHOULD NOT is violated. RDoc will always try to emit documentation even if given invalid TomDoc.

Here are some implementation choices this parser currently makes:

This parser allows rdoc-style inline markup but you should not depended on it.

This parser allows a space between the comment and the method body.

This parser does not require the default value to be described for an optional argument.

This parser does not examine the order of sections. An Examples section may precede the Arguments section.

This class is documented in TomDoc format. Since this is a subclass of the RDoc markup parser there isn't much to see here, unfortunately.

build_paragraph

build_paragraph(margin) Instance Public methods Builds a paragraph from the

2015-05-04 22:10:28
build_heading

build_heading(level) Instance Public methods Builds a heading from the token

2015-05-04 22:08:31
tokenize

tokenize(text) Instance Public methods Turns text into an Array of tokens

2015-05-04 22:18:49
parse

parse(text) Class Public methods Parses

2015-05-04 22:02:52
signature

signature(comment) Class Public methods Extracts the Signature section's method

2015-05-04 22:05:29
new

new() Class Public methods Creates a new

2015-05-04 22:01:27
build_verbatim

build_verbatim(margin) Instance Public methods Builds a verbatim from the token

2015-05-04 22:16:31