Class RDoc::Options
In: lib/rdoc/options.rb
Parent: Object

Methods

parse   title=  

Attributes

all_one_file  [R]  Should the output be placed into a single file
charset  [R]  Character-set
css  [R]  URL of stylesheet
diagram  [R]  Should diagrams be drawn
exclude  [RW]  Files matching this pattern will be excluded
extra_accessor_flags  [R]  Additional attr_… style method flags
extra_accessors  [R]  Pattern for additional attr_… style methods
fileboxes  [R]  Should we draw fileboxes in diagrams
files  [RW]  The list of files to be processed
force_update  [R]  Scan newer sources than the flag file if true.
generator  [RW]  Description of the output generator (set with the -fmt option)
image_format  [R]  image format for diagrams
include_line_numbers  [R]  Include line numbers in the source listings
inline_source  [RW]  Should source code be included inline, or displayed in a popup
main_page  [RW]  Name of the file, class or module to display in the initial index page (if not specified the first file we encounter is used)
merge  [R]  Merge into classes of the same name when generating ri
op_dir  [RW]  The name of the output directory
op_name  [R]  The name to use for the output
promiscuous  [R]  Are we promiscuous about showing module contents across multiple files
quiet  [R]  Don‘t display progress as we process the files
rdoc_include  [R]  Array of directories to search for files to satisfy an :include:
show_all  [RW]  Include private and protected methods in the output
show_hash  [R]  Include the ’#’ at the front of hyperlinked instance method names
tab_width  [R]  The number of columns in a tab
template  [R]  template to be used when generating output
title  [R]  Documentation title
webcvs  [R]  URL of web cvs frontend

Public Instance methods

parse(argv)

Parse command line options.

title=(string)

Set the title, but only if not already set. This means that a title set from the command line trumps one set in a source file

[Validate]

ruby-doc.org is a community service provided by James Britt and Happy Camper Studios, a Phoenix, Arizona, Ruby application development company.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.