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.

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

parse_file(filename) Instance Public methods Parses filename and

gather_files(files) Instance Public methods Gathers a set of parseable files

current() Class Public methods Active

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

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

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

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

generate() Instance Public methods Generates documentation for file_info

install_siginfo_handler() Instance Public methods Installs a siginfo handler