MENU
Type:
Class

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

1
: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
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::PreProcess

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

2025-01-10 15:47:30
register
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::PreProcess

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

2025-01-10 15:47:30
reset
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::PreProcess

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

2025-01-10 15:47:30
include_file
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::PreProcess

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

2025-01-10 15:47:30
post_process
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::PreProcess

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

2025-01-10 15:47:30
handle_directive
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::PreProcess

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

2025-01-10 15:47:30
registered
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::PreProcess

registered() Class Public methods Registered directives

2025-01-10 15:47:30
post_processors
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::PreProcess

post_processors() Class Public methods Registered post-processors

2025-01-10 15:47:30
find_include_file
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::PreProcess

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

2025-01-10 15:47:30
new
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::PreProcess

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

2025-01-10 15:47:30