Flowdock
document(options) public

Generates documentation or a coverage report depending upon the settings in options.

options can be either an RDoc::Options instance or an array of strings equivalent to the strings that would be passed on the command line like %w[-q -o doc -t My\ Doc\ Title]. #document will automatically call RDoc::Options#finish if an options instance was given.

For a list of options, see either RDoc::Options or rdoc --help.

By default, output will be stored in a directory called “doc” below the current directory, so make sure you’re somewhere writable before invoking.

Show source
Register or log in to add new notes.