O'Reilly logo

Learning Ruby by Michael Fitzgerald

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

RDoc Options

RDoc options are used like this:

rdoc [options] [names...]

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.

Options include:

--accessor, -A accessorname[,..]

Comma-separated list of additional class methods that should be treated like attr_reader and friends. Option may be repeated. Each accessorname may have =text appended, in which case that text appears where the r/w/rw appears for normal accessors.

--all, -a

Include all methods (not just public) in the output.

--charset, -c charset

Specify HTML character-set.

--debug, -D

Display lots on internal stuff.

--diagram, -d

Generate diagrams showing modules and classes. You need dot v1.8.6 or later to use the --diagram option correctly. Dot is available from http://www.research.att.com/sw/tools/graphviz.

--exclude, -x pattern

Do not process files or directories matching pattern. Files given explicitly on the command line will never be excluded.

--extension, -E new=old

Treat files ending with .new as if they ended with .old. Using '-E cgi=rb' will cause xxx.cgi to be parsed as a Ruby file.

--fileboxes, -F

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 ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required