RDoc options are used like this:
Files are parsed, and the information they contain collected, before any output is produced. This allows cross-references between all files to be resolved. If a name on the command line is a directory, it is traversed. If no names are specified on the command line, all Ruby files in the current directory (and subdirectories) are processed.
Comma-separated list of additional class methods that should be treated like
attr_reader and friends. Option may be repeated.
accessorname may have
=text appended, in which case that text appears where the
r/w/rw appears for normal accessors.
Include all methods (not just public) in the output.
Specify HTML character-set.
Display lots on internal stuff.
Generate diagrams showing modules and classes. You need dot
v1.8.6 or later to use the
correctly. Dot is available from http://www.research.att.com/sw/tools/graphviz.
Do not process files or directories matching
pattern. Files given explicitly on the command line will never be
Treat files ending with .new as if they ended
with .old. Using
cgi=rb' will cause xxx.cgi to be
parsed as a Ruby file.
Classes are put in boxes, which represents files, where these classes reside. Classes shared among more than one file are shown with a list of files ...