Ruby 2.5.0 リファレンスマニュアル > ライブラリ一覧 > rdoc/optionsライブラリ > RDoc::Optionsクラス

class RDoc::Options

クラス・モジュールの継承リスト: RDoc::Options < Object < Kernel < BasicObject

要約

rdoc コマンドのオプションを解析するためのクラスです。

それぞれのオプションの詳細に関しては、rdoc/使いかたを参照してください。

カスタムオプション

RDoc のジェネレータでは、RDoc::Options をフックして独自のオプションを指定できます。

Object::ARGV に --format が含まれていた場合、RDoc はジェネレータ独自のオプションを解析するために setup_options メソッドを呼び出します。カスタムオプションを指定する場合は --format オプションは必ず指定する必要があります。rdoc --help を実行すると追加したオプションの一覧が確認できます。

例:

class RDoc::Generator::Spellcheck
  RDoc::RDoc.add_generator self

  def self.setup_options rdoc_options
    op = rdoc_options.option_parser

    op.on('--spell-dictionary DICTIONARY',
          RDoc::Options::Path) do |dictionary|
      # RDoc::Options に spell_dictionary アクセサの定義が必要
      rdoc_options.spell_dictionary = dictionary
    end
  end
end

インスタンスメソッド

定義	説明
`all_one_file -> bool`	コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプションに xml 指定した場合に true を返します。そうでない場合は false を返します。
`charset -> String`	コマンドライン引数の --charset オプションで指定した文字コードを文字列で返します。
`coverage_report -> Integer \| false`	コマンドライン引数の --coverage-report オプションを指定していた場合、指定した数値を返します。
`coverage_report=(val)`	コマンドライン引数の --coverage-report オプションと同様の指定を行います。
`css -> String`	コマンドライン引数の --style オプションで指定した URL を文字列で返します。
`diagram -> bool`	コマンドライン引数の --diagram オプションを指定していた場合、true を返します。そうでない場合は false を返します。
`dry_run -> bool`	コマンドライン引数の --dry-run オプションを指定していた場合、true を返します。--no-dry-run オプションを指定していた場合、false を返します。
`dry_run=(val)`	val に true を指定した場合、コマンドライン引数の --dry-run オプションと同様の指定を行います。
`encoding -> Encoding`	コマンドライン引数の --encoding オプションを指定していた場合、指定したエンコーディングに対応する Encoding オブジェクトを返します。
`encoding=(val)`	コマンドライン引数の --encoding オプションと同様の指定を行います。
`exclude -> Regexp`	コマンドライン引数の --exclude オプションで指定した正規表現を返します。複数指定していた場合は、1 つの Regexp オブジェクトにまとめられたものを返します。
`exclude=(val)`	コマンドライン引数の --exclude オプションと同様の指定を行います。
`extra_accessor_flags -> {String => String}`	コマンドライン引数の --accessor オプションで指定したアクセサがキー、アクセサの種類が値のハッシュを返します。
`extra_accessors -> Regexp \| nil`	コマンドライン引数の --accessor オプションで指定したアクセサの名前すべてにマッチする正規表現オブジェクトを返します。
`fileboxes -> bool`	コマンドライン引数の --diagram オプション、--fileboxes オプションを指定していた場合、true を返します。そうでない場合は false を返します。
`files -> [String]`	解析するファイルの一覧を文字列の配列で返します。
`finish_page_dir`	ライブラリ内部で使用します。
`force_output -> bool`	コマンドライン引数の --force_output オプションを指定していた場合、true を返します。--no-force_output オプションを指定していた場合、false を返します。
`force_output=(val)`	val に true を指定した場合、コマンドライン引数の --force_output オプションと同様の指定を行います。
`force_update -> bool`	コマンドライン引数の --force_update を指定していた場合に true を返します。そうでない場合は false を返します。
`formatter -> nil`	使用されていません。常に nil を返します。
`formatter=(val)`	使用されていません。
`generator -> Generator`	コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。
`generator=(val)`	コマンドライン引数の --fmt オプションと同様の指定を行います。
`hyperlink_all -> bool`	コマンドライン引数の --hyperlink-all オプションを指定していた場合、 true を返します。
`hyperlink_all=(val)`	val に true を指定した場合、コマンドライン引数の --hyperlink-all オプションと同様の指定を行います。
`image_format -> String`	コマンドライン引数の --image-format オプションで指定した名前を文字列の配列で返します。
`include_line_numbers -> bool`	コマンドライン引数の --include-line-numbers を指定していた場合に true を返します。そうでない場合は false を返します。
`inline_source -> bool`	コマンドライン引数の --inline-source オプションか --one-file を指定していた場合、もしくは --fmt オプションに xml 指定した場合に true を返します。そうでない場合は false を返します。
`line_numbers -> bool`	コマンドライン引数の --line-numbers オプションを指定していた場合、true を返します。--no-line-numbers オプションを指定していた場合、false を返します。
`line_numbers=(val)`	val に true を指定した場合、コマンドライン引数の --line-numbers オプションと同様の指定を行います。
`main_page -> String \| nil`	コマンドライン引数の --main オプションで指定したファイル名、クラス/モジュール名を返します。
`main_page=(val)`	コマンドライン引数の --main オプションと同様の指定を行います。
`markup -> String`	コマンドライン引数の --markup オプションで指定したフォーマットを返します。
`markup=(val)`	コマンドライン引数の --markup オプションと同様の指定を行います。
`merge -> true \| nil`	コマンドライン引数の --merge オプションを指定していた場合、true を返します。そうでない場合は nil を返します。
`op_dir -> String`	コマンドライン引数の --op オプションで指定したディレクトリを返します。
`op_dir=(val)`	コマンドライン引数の --op オプションと同様の指定を行います。
`op_name -> String`	コマンドライン引数の --opname オプションで指定した名前を文字列で返します。
`option_parser -> OptionParser \| nil`	コマンドライン引数の解析のための OptionParser オブジェクトを返します。
`option_parser=(val)`	コマンドライン引数の解析のための OptionParser オブジェクトを設定します。
`page_dir -> Pathname \| nil`	コマンドライン引数の --page-dir オプションで指定したディレクトリを返します。
`page_dir=(val)`	コマンドライン引数の --page-dir オプションと同様の指定を行います。
`parse(argv) -> ()`	コマンドライン引数を解析します。
`pipe -> bool`	コマンドライン引数の --pipe オプションを指定していた場合、true を返します。そうでない場合は false を返します。
`pipe=(val)`	val に true を指定した場合、コマンドライン引数の --pipe オプションと同様の指定を行います。
`promiscuous`	コマンドライン引数の --promiscuous を指定していた場合に true を返します。そうでない場合は false を返します。
`quiet -> bool`	コマンドライン引数の --quiet オプションを指定していた場合、true を返します。そうでない場合は nil を返します。
`rdoc_include -> [String]`	コマンドライン引数の --include オプションで指定したディレクトリを文字列の配列で返します。
`root -> Pathname`	コマンドライン引数の --root オプションで指定したディレクトリを返します。
`root=(val)`	コマンドライン引数の --root オプションと同様の指定を行います。
`sanitize_path(path)`	ライブラリ内部で使用します。
`show_all -> bool`	コマンドライン引数の --all オプションを指定していた場合、true を返します。そうでない場合は false を返します。
`show_all=(val)`	val に true を指定した場合、コマンドライン引数の --all オプションと同様の指定を行います。
`show_hash -> bool`	コマンドライン引数の --show-hash オプションを指定していた場合、true を返します。そうでない場合は false を返します。
`static_path -> [String]`	コマンドライン引数の --copy-files オプションで指定したパスの一覧を返します。
`static_path=(vals)`	コマンドライン引数の --copy-files オプションと同様の指定を行います。
`tab_width -> Integer`	コマンドライン引数の --tab-width オプションで指定した数値を返します。
`template -> String`	コマンドライン引数の --template オプションで指定した名前を文字列の配列で返します。
`template_dir -> String \| nil`	コマンドライン引数の --template オプションで指定したテンプレートに対応するディレクトリを返します。
`template_dir=(val)`	コマンドライン引数の --template オプションで指定したテンプレートに対応するディレクトリを設定します。
`title -> String \| nil`	ドキュメントのタイトルを返します。指定されていない場合は nil を返します。
`title=(string)`	ドキュメントのタイトルがまだ設定されていない場合に string で指定した文字列に設定します。
`verbosity -> 0 \| 1 \| 2`	プログラムの解析時に表示する情報の詳細さを数値で返します。
`verbosity=(val)`	プログラムの解析時に表示する情報の詳細さを数値で指定します。
`visibility -> :public \| :protected \| :private`	コマンドライン引数の --visibility で指定したオプションを Symbol で返します。
`visibility=(val)`	コマンドライン引数の --visibility オプションと同様の指定を行います。
`warn(message) -> nil`	--verbose オプションを指定していた場合に message を標準エラー出力 $stderr に出力します。
`webcvs -> String \| nil`	コマンドライン引数の --webcvs オプションで指定した URL を文字列で返します。
`write_options -> object`	カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式で保存します。

定数

定義	説明
`DEPRECATED -> {String -> String}`	非推奨のオプションの一覧を返します。
`SPECIAL -> [String]`	--write-options を指定した際に .rdoc_options ファイルに保存されないオプションの一覧を返します。

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined !~ <=> == === =~ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str trust untaint untrust untrusted? yield_self .new .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE