Type:
Class

Handle common directives that can occur in a block of text:

:include: filename

Directives can be escaped by preceding them with a backslash.

RDoc plugin authors can register additional directives to be handled by using ::register.

Any directive that is not built-in to RDoc (including those registered via plugins) will be stored in the metadata hash on the CodeObject the comment is attached to. See Directives at RDoc::Markup for the list of built-in directives.

handle

handle(text, code_object = nil, &block) Instance Public methods Look for

2015-05-02 17:56:05
register

register(directive, &block) Class Public methods Registers directive

2015-05-02 17:41:42
reset

reset() Class Public methods Clears all registered directives and post-processors

2015-05-02 17:47:05
include_file

include_file(name, indent, encoding) Instance Public methods Handles the :include:

2015-05-02 18:04:06
handle_directive

handle_directive(prefix, directive, param, code_object = nil, encoding = nil) Instance Public methods

2015-05-02 17:59:35
post_process

post_process(&block) Class Public methods Adds a post-process handler for

2015-05-02 17:32:18
registered

registered() Class Public methods Registered directives

2015-05-02 17:45:44
new

new(input_file_name, include_path) Class Public methods Creates a new pre-processor

2015-05-02 17:27:24
post_processors

post_processors() Class Public methods Registered post-processors

2015-05-02 17:35:46
find_include_file

find_include_file(name) Instance Public methods Look for the given file in the

2015-05-02 17:53:05