/ Ruby
/
class

RDoc::Markup::Parser

ruby latest stable - Superclass: Object

Class deprecated or moved

This class is deprecated or moved on the latest stable version. The last existing version (v2_2_9) is shown here.

A recursive-descent parser for RDoc markup.

The parser tokenizes an input string then parses the tokens into a Document. Documents can be converted into output formats by writing a visitor like RDoc::Markup::ToHTML.

The parser only handles the block-level constructs Paragraph, List, ListItem, Heading, Verbatim, BlankLine and Rule. Inline markup such as +blah+ is handled separately by RDoc::Markup::AttributeManager.

To see what markup the Parser implements read RDoc. To see how to use RDoc markup to format text in your program read RDoc::Markup.

Included modules

  • RDoc::Text

Constants

LIST_TOKENS = [\n:BULLET,\n:LABEL,\n:LALPHA,\n:NOTE,\n:NUMBER,\n:UALPHA,\n]

Attributes

[RW]debug
[R]tokens

Files

  • lib/rdoc/markup/parser.rb