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:
1 2 3 4 | rdoc = RDoc::RDoc.newoptions = rdoc.load_options # returns an RDoc::Options instance# set extra optionsrdoc.document options |
You can also generate output like the rdoc executable:
1 2 | rdoc = RDoc::RDoc.newrdoc.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.