Type:
Class
Constants:
LIST_TOKENS : [ :BULLET, :LABEL, :LALPHA, :NOTE, :NUMBER, :UALPHA, ]

List token types

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.

tokenize

tokenize(str) Class Public methods Returns a token stream for str

2015-05-02 16:11:38
parse

parse(str) Class Public methods Parses str into a Document.

2015-05-02 16:05:55
build_verbatim

build_verbatim(margin) Instance Public methods Builds a Verbatim that is indented

2015-05-02 16:33:17
skip

skip(token_type, error = true) Instance Public methods Skips the next token

2015-05-02 16:55:18
parse 2

parse(parent, indent = 0) Instance Public methods Parses the tokens into an

2015-05-02 16:42:05
peek_token

peek_token() Instance Public methods Returns the next token on the stream without

2015-05-02 16:43:24
unget

unget() Instance Public methods Returns the current token to the token stream

2015-05-02 17:07:24
token_pos

token_pos(byte_offset) Instance Public methods Calculates the column (by character)

2015-05-02 16:56:40
build_heading

build_heading(level) Instance Public methods Builds a Heading of level

2015-05-02 16:13:04
new

new() Class Public methods Creates a new

2015-05-02 15:59:22