RDoc::Markup::PreProcess

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.

Attributes

options[RW]

An RDoc::Options instance that will be filled
in with overrides from directives

Public Class Methods

new(input_file_name, include_path)click to toggle source

Creates a new pre-processor for input_file_name that will look
for included files in include_path

Options that we don’t handle are yielded. If the block returns false the
directive is restored to the text. If the block returns nil or no block
was given the directive is handled according to the registered directives.
If a String was returned the directive is replaced with the string.

If no matching directive was registered the directive is restored to the
text.

If code_object is given and the directive is unknown then the
directive’s parameter is set as metadata on the code_object.
See RDoc::CodeObject#metadata
for details.