U:RDoc::NormalClass[iI" Options:ETI"RDoc::Options;TI" Object;To:RDoc::Markup::Document: @parts[o;;[ o: RDoc::Markup::Paragraph;[I"=RDoc::Options handles the parsing and storage of options;To: RDoc::Markup::BlankLine S:RDoc::Markup::Heading:
leveli: textI"Saved Options;T@o; ;[I"=You can save some options like the markup format in the ;TI"M.rdoc_options file in your gem. The easiest way to do this is:;T@o:RDoc::Markup::Verbatim;[I"*rdoc --markup tomdoc --write-options
;T: @format0o; ;[I"OWhich will automatically create the file and fill it with the options you ;TI"specified.;T@o; ;[I"RThe following options will not be saved since they interfere with the user's ;TI"6preferences or with the normal operation of RDoc:;T@o:RDoc::Markup::List:
@type: BULLET: @items[o:RDoc::Markup::ListItem: @label0;[o; ;[I"+--coverage-report+;To;;0;[o; ;[I"+--dry-run+;To;;0;[o; ;[I"+--encoding+;To;;0;[o; ;[I"+--force-update+;To;;0;[o; ;[I"+--format+;To;;0;[o; ;[I"
+--pipe+;To;;0;[o; ;[I"+--quiet+;To;;0;[o; ;[I"+--template+;To;;0;[o; ;[I"+--verbose+;T@S; ; i;
I"Custom Options;T@o; ;[I"NGenerators can hook into RDoc::Options to add generator-specific command ;TI"line options.;T@o; ;[ I"RWhen --format is encountered in ARGV, RDoc calls ::setup_options on ;TI"Qthe generator class to add extra options to the option parser. Options for ;TI"Qcustom generators must occur after --format. rdoc --help ;TI"4will list options for all installed generators.;T@o; ;[I"
Example:;T@o;;[I"'class RDoc::Generator::Spellcheck
;TI"% RDoc::RDoc.add_generator self
;TI"
;TI"+ def self.setup_options rdoc_options
;TI") op = rdoc_options.option_parser
;TI"
;TI"0 op.on('--spell-dictionary DICTIONARY',
;TI"4 RDoc::Options::Path) do |dictionary|
;TI"6 rdoc_options.spell_dictionary = dictionary
;TI"
end
;TI" end
;TI" end
;T;0o; ;[I"POf course, RDoc::Options does not respond to +spell_dictionary+ by default ;TI" so you will need to add it:;T@o;;[
I"class RDoc::Options
;TI"
;TI"
##
;TI"A # The spell dictionary used by the spell-checking plugin.
;TI"
;TI"' attr_accessor :spell_dictionary
;TI"
;TI" end
;T;0S; ; i;
I"Option Validators;T@o; ;[ I"KOptionParser validators will validate and cast user input values. In ;TI"Naddition to the validators that ship with OptionParser (String, Integer, ;TI"JFloat, TrueClass, FalseClass, Array, Regexp, Date, Time, URI, etc.), ;TI"5RDoc::Options adds Path, PathArray and Template.;T:
@fileI"lib/rdoc/options.rb;T:0@omit_headings_from_table_of_contents_below0;0;0[([
I" charset;TI"RW;T: publicFI"lib/rdoc/options.rb;T[
I"coverage_report;TI"RW;T;F@…[
I" dry_run;TI"RW;T;F@…[
I"
encoding;TI"RW;T;F@…[
I" exclude;TI"RW;T;F@…[
I"
files;TI"RW;T;F@…[
I"force_output;TI"RW;T;F@…[
I"force_update;TI"RW;T;F@…[
I"formatter;TI"RW;T;F@…[
I"generator;TI"RW;T;F@…[
I"generator_options;TI"RW;T;F@…[
I"hyperlink_all;TI"RW;T;F@…[
I"line_numbers;TI"RW;T;F@…[
I" locale;TI"RW;T;F@…[
I"locale_dir;TI"RW;T;F@…[
I"main_page;TI"RW;T;F@…[
I" markup;TI"RW;T;F@…[
I" op_dir;TI"RW;T;F@…[
I"option_parser;TI"RW;T;F@…[
I"output_decoration;TI"RW;T;F@…[
I"
page_dir;TI"RW;T;F@…[
I" pipe;TI"RW;T;F@…[
I"rdoc_include;TI"RW;T;F@…[
I" root;TI"RW;T;F@…[
I"show_hash;TI"RW;T;F@…[
I"static_path;TI"RW;T;F@…[
I"tab_width;TI"RW;T;F@…[
I"
template;TI"RW;T;F@…[
I"template_dir;TI"RW;T;F@…[
I"template_stylesheets;TI"RW;T;F@…[
I"
title;TI"RW;T;F@…[
I"update_output_dir;TI"RW;T;F@…[
I"verbosity;TI"RW;T;F@…[
I"visibility;TI"R;T;F@…[
I" webcvs;TI"RW;T;F@…[ U:RDoc::Constant[i I"DEPRECATED;FI" RDoc::Options::DEPRECATED;T00o;;[o; ;[I" The deprecated options.;T;@€;0@€@cRDoc::NormalClass0U;[i I" SPECIAL;FI"RDoc::Options::SPECIAL;T00o;;[o; ;[I"CRDoc options ignored (or handled specially) by --write-options;T;@€;0@€@@ö0U;[i I"Directory;FI" RDoc::Options::Directory;T00o;;[o; ;[I"OOption validator for OptionParser that matches a directory that exists on ;TI"the filesystem.;T;@€;0@€@@ö0U;[i I" Path;FI"RDoc::Options::Path;T00o;;[o; ;[I"MOption validator for OptionParser that matches a file or directory that ;TI" exists on the filesystem.;T;@€;0@€@@ö0U;[i I"PathArray;FI" RDoc::Options::PathArray;T00o;;[o; ;[I"NOption validator for OptionParser that matches a comma-separated list of ;TI"7files or directories that exist on the filesystem.;T;@€;0@€@@ö0U;[i I"
Template;FI" RDoc::Options::Template;T00o;;[o; ;[I"POption validator for OptionParser that matches a template directory for an ;TI"'installed generator that lives in ;TI"8"rdoc/generator/template/#{template_name}";T;@€;0@€@@ö0[ [[I"
class;T[[;[ [:protected[ [: private[ [I"
instance;T[[;[[I"check_files;F@…[I"check_generator;F@…[I"default_title=;F@…[I" finish;F@…[I"finish_page_dir;F@…[I"generator_descriptions;F@…[I"
parse;F@…[I"
quiet;F@…[I" quiet=;F@…[I"sanitize_path;F@…[I"setup_generator;F@…[I"template_dir_for;F@…[I"visibility=;F@…[I" warn;F@…[I"write_options;F@…[;[ [;[ [ [U:RDoc::Context::Section[i 0o;;[ ;0;0[@€@€cRDoc::TopLevel