RDoc::RDoc

Type:

Class

Constants:

GENERATORS : {}

This is the list of supported output generators

This is the driver for generating RDoc output. It handles file parsing and generation of output.

To use this class to generate RDoc output via the API, the recommended way is:

rdoc = RDoc::RDoc.new
options = rdoc.load_options # returns an RDoc::Options instance
# set extra options
rdoc.document options

You can also generate output like the rdoc executable:

rdoc = RDoc::RDoc.new
rdoc.document argv

Where argv is an array of strings, each corresponding to an argument you'd give rdoc on the command line. See <tt>rdoc –help<tt> for details.

current=(rdoc) Class Public methods Sets the active

document(options) Instance Public methods Generates documentation or a coverage

list_files_in_directory(dir) Instance Public methods Return a list of the files

load_options() Instance Public methods Loads options from .rdoc_options if the

store=(store) Instance Public methods Sets the current documentation tree to

current() Class Public methods Active

update_output_dir(op_dir, time, last = {}) Instance Public methods Update the

generate() Instance Public methods Generates documentation for file_info

add_generator(klass) Class Public methods Add klass that can generate

output_flag_file(op_dir) Instance Public methods Return the path name of the