registered

registered() Class Public methods Registered directives

reset

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

find_include_file

find_include_file(name) Instance Public methods Look for the given file in the directory containing the current file, and then in each of the directories specified in the RDOC_INCLUDE path

handle

handle(text, code_object = nil, &block) Instance Public methods Look for directives in the given text. 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_ob

handle_directive

handle_directive(prefix, directive, param, code_object = nil, encoding = nil) Instance Public methods Performs the actions described by directive and its parameter param. code_object is used for directives that operate on a class or module. prefix is used to ensure the replacement for handled directives is correct. encoding is used for the include directive. For a list of directives in RDoc see RDoc::Markup.

include_file

include_file(name, indent, encoding) Instance Public methods Handles the :include: filename directive. If the first line of the included file starts with '#', and contains an encoding information in the form 'coding:' or 'coding=', it is removed. If all lines in the included file start with a '#', this leading '#' is removed before inclusion. The included content is indented like the :include: directive.

new

new(*parts) Class Public methods Creates a new Raw containing parts

<<

<<(text) Instance Public methods Appends text

accept

accept(visitor) Instance Public methods Calls accept_raw+ on visitor

merge

merge(other) Instance Public methods Appends other's parts