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.

new() Class Public methods Creates a new

parse_dot_doc_file(in_dir, filename) Instance Public methods The .document file

handle_pipe() Instance Public methods Turns

setup_output_dir(dir, force) Instance Public methods Create an output dir if

error(msg) Instance Public methods Report an error message and exit

remove_unparseable(files) Instance Public methods Removes file extensions known

parse_files(files) Instance Public methods Parse each file on the command line

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

current=(rdoc) Class Public methods Sets the active

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