Encapsulate the production of rdoc documentation. Basically you can use
this as you would invoke rdoc from the command line:
rdoc = RDoc::RDoc.new
rdoc.document(args)
where args is an array of strings, each corresponding to an
argument you’d give rdoc on the command line. See rdoc/rdoc.rb for
details.
| Public Methods |
| document |
Format up one or more files according to the given arguments. For
simplicity, argv is an array of strings, equivalent to the strings
that would be passed on the command line. (This isn’t a coincidence,
as we do pass in ARGV when running interactively). For a list of
options, see rdoc/rdoc.rb. By default, output will be stored in a directory
called doc below the current directory, so make sure you’re
somewhere writable before invoking.
|
| Private Methods |
| error |
Report an error message and exit
|
| list_files_in_directory |
Return a list of the files to be processed in a directory. We know that
this directory doesn’t have a .document file, so we’re looking
for real files. However we may well contain subdirectories which must be
tested for .document files
|
| normalized_file_list |
Given a list of files and directories, create a list of all the Ruby files
they contain.
|
| output_flag_file |
Return the path name of the flag file in an output directory.
|
| parse_dot_doc_file |
The .document file contains a list of file and directory name patterns,
representing candidates for documentation. It may also contain comments
(starting with ’#’)
|
| parse_files |
Parse each file on the command line, recursively entering directories
|
| setup_output_dir |
Create an output dir if it doesn’t exist. If it does exist, but
doesn’t contain the flag file created.rid then we refuse to
use it, as we may clobber some manually generated documentation
|
| update_output_dir |
Update the flag file in an output directory.
|
<code/>and<pre/>for code samples.