Type:
Module

RDoc uses generators to turn parsed source code in the form of an RDoc::CodeObject tree into some form of output. RDoc comes with the HTML generator RDoc::Generator::Darkfish and an ri data generator RDoc::Generator::RI.

Registering a Generator

Generators are registered by calling RDoc::RDoc.add_generator with the class of the generator:

1
2
3
class My::Awesome::Generator
  RDoc::RDoc.add_generator self
end

Adding Options to rdoc

Before option processing in rdoc, RDoc::Options will call ::setup_options on the generator class with an RDoc::Options instance. The generator can use RDoc::Options#option_parser to add command-line options to the rdoc tool. See Custom Options at RDoc::Options for an example and see OptionParser for details on how to add options.

You can extend the RDoc::Options instance with additional accessors for your generator.

Generator Instantiation

After parsing, RDoc::RDoc will instantiate a generator by calling initialize with an RDoc::Store instance and an RDoc::Options instance.

The RDoc::Store instance holds documentation for parsed source code. In RDoc 3 and earlier the RDoc::TopLevel class held this data. When upgrading a generator from RDoc 3 and earlier you should only need to replace RDoc::TopLevel with the store instance.

RDoc will then call generate on the generator instance. You can use the various methods on RDoc::Store and in the RDoc::CodeObject tree to create your desired output format.

gen_sub_directories
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::Darkfish

gen_sub_directories() Instance Public methods Create the directories the generated

2025-01-10 15:47:30
generate_page
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::Darkfish

generate_page(file) Instance Public methods Generate a page file for file

2025-01-10 15:47:30
file_dir
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::Darkfish

file_dir() Instance Public methods Directory where generated class HTML files

2025-01-10 15:47:30
copy_static
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::Darkfish

copy_static() Instance Public methods Copies static files from the static_path

2025-01-10 15:47:30
class_dir
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::Darkfish

class_dir() Instance Public methods Directory where generated class HTML files

2025-01-10 15:47:30
render_template
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::Darkfish

render_template(template_file, out_file = nil) Instance Public methods Load

2025-01-10 15:47:30
class_dir
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Generator/RDoc::Generator::JsonIndex

class_dir() Instance Public methods The directory classes are written to

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

as_href(from_path) Instance Public methods Generates a relative URL from

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

new(store, options) Class Public methods Initialize a few instance variables

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

new(parent_generator, options) Class Public methods Creates a new generator

2025-01-10 15:47:30