class RDoc::Options

要約

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
• charset
• coverage_report
• coverage_report=
• css
• diagram
• dry_run
• dry_run=
• encoding
• encoding=
• exclude
• exclude=
• extra_accessor_flags
• extra_accessors
• fileboxes
• files
• finish_page_dir
• force_output
• force_output=
• force_update
• formatter
• formatter=
• generator
• generator=
• hyperlink_all
• hyperlink_all=
• image_format
• include_line_numbers
• inline_source
• line_numbers
• line_numbers=
• main_page
• main_page=
• markup
• markup=
• merge
• op_dir
• op_dir=
• op_name
• option_parser
• option_parser=
• page_dir
• page_dir=
• parse
• pipe
• pipe=
• promiscuous
• quiet
• rdoc_include
• root
• root=
• sanitize_path
• show_all
• show_all=
• show_hash
• static_path
• static_path=
• tab_width
• template
• template_dir
• template_dir=
• title
• title=
• verbosity
• verbosity=
• visibility
• visibility=
• warn
• webcvs
• write_options

定数

• DEPRECATED
• SPECIAL

インスタンスメソッド

all_one_file -> bool[permalink][rdoc][edit]

コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプションに xml 指定した場合に true を返します。そうでない場合は false を返します。

charset -> String[permalink][rdoc][edit]

コマンドライン引数の --charset オプションで指定した文字コードを文字列で返します。

指定しなかった場合は、$KCODE に応じた値になります。

coverage_report -> Integer | false[permalink][rdoc][edit]

コマンドライン引数の --coverage-report オプションを指定していた場合、指定した数値を返します。

指定しなかった場合は false を返します。

coverage_report=(val)[permalink][rdoc][edit]

コマンドライン引数の --coverage-report オプションと同様の指定を行います。

[PARAM] val:

数値オブジェクトか false を指定します。

css -> String[permalink][rdoc][edit]

コマンドライン引数の --style オプションで指定した URL を文字列で返します。

diagram -> bool[permalink][rdoc][edit]

コマンドライン引数の --diagram オプションを指定していた場合、true を返します。そうでない場合は false を返します。

dry_run -> bool[permalink][rdoc][edit]

コマンドライン引数の --dry-run オプションを指定していた場合、true を返します。--no-dry-run オプションを指定していた場合、false を返します。

どちらも指定しなかった場合は false を返します。

dry_run=(val)[permalink][rdoc][edit]

val に true を指定した場合、コマンドライン引数の --dry-run オプションと同様の指定を行います。

[PARAM] val:

--dry-run オプションと同じ指定を行う場合は true、そうでない場合は false を指定します。

encoding -> Encoding[permalink][rdoc][edit]

コマンドライン引数の --encoding オプションを指定していた場合、指定したエンコーディングに対応する Encoding オブジェクトを返します。

指定しなかった場合は Encoding.default_external の値を返します。

encoding=(val)[permalink][rdoc][edit]

コマンドライン引数の --encoding オプションと同様の指定を行います。

[PARAM] val:

設定する Encoding オブジェクトを指定します。

exclude -> Regexp[permalink][rdoc][edit]

コマンドライン引数の --exclude オプションで指定した正規表現を返します。複数指定していた場合は、1 つの Regexp オブジェクトにまとめられたものを返します。

exclude=(val)[permalink][rdoc][edit]

コマンドライン引数の --exclude オプションと同様の指定を行います。

[PARAM] val:

設定するパターンを Regexp オブジェクトで指定します。

extra_accessor_flags -> {String => String}[permalink][rdoc][edit]

コマンドライン引数の --accessor オプションで指定したアクセサがキー、アクセサの種類が値のハッシュを返します。

値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、 attr_accessor に対応します。

extra_accessors -> Regexp | nil[permalink][rdoc][edit]

コマンドライン引数の --accessor オプションで指定したアクセサの名前すべてにマッチする正規表現オブジェクトを返します。

指定しなかった場合は nil を返します。

fileboxes -> bool[permalink][rdoc][edit]

コマンドライン引数の --diagram オプション、--fileboxes オプションを指定していた場合、true を返します。そうでない場合は false を返します。

files -> [String][permalink][rdoc][edit]

解析するファイルの一覧を文字列の配列で返します。

finish_page_dir[permalink][rdoc][edit]

ライブラリ内部で使用します。

force_output -> bool[permalink][rdoc][edit]

コマンドライン引数の --force_output オプションを指定していた場合、true を返します。--no-force_output オプションを指定していた場合、false を返します。

どちらも指定しなかった場合は true を返します。

force_output=(val)[permalink][rdoc][edit]

val に true を指定した場合、コマンドライン引数の --force_output オプションと同様の指定を行います。

[PARAM] val:

--force_output オプションと同じ指定を行う場合は true、そうでない場合は false を指定します。

force_update -> bool[permalink][rdoc][edit]

コマンドライン引数の --force_update を指定していた場合に true を返します。そうでない場合は false を返します。

formatter -> nil[permalink][rdoc][edit]

使用されていません。常に nil を返します。

formatter=(val)[permalink][rdoc][edit]

使用されていません。

generator -> Generator[permalink][rdoc][edit]

コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。

指定しなかった場合は、HTML に対応する Generator を返します。

generator=(val)[permalink][rdoc][edit]

コマンドライン引数の --fmt オプションと同様の指定を行います。

[PARAM] val:

設定する Generator を指定します。

hyperlink_all -> bool[permalink][rdoc][edit]

コマンドライン引数の --hyperlink-all オプションを指定していた場合、 true を返します。

指定しなかった場合は false を返します。

hyperlink_all=(val)[permalink][rdoc][edit]

val に true を指定した場合、コマンドライン引数の --hyperlink-all オプションと同様の指定を行います。

[PARAM] val:

--hyperlink-all オプションと同じ指定を行う場合は true、そうでない場合は false を指定します。

image_format -> String[permalink][rdoc][edit]

コマンドライン引数の --image-format オプションで指定した名前を文字列の配列で返します。

指定しなかった場合は 'png' を返します。

include_line_numbers -> bool[permalink][rdoc][edit]

コマンドライン引数の --include-line-numbers を指定していた場合に true を返します。そうでない場合は false を返します。

inline_source -> bool[permalink][rdoc][edit]

コマンドライン引数の --inline-source オプションか --one-file を指定していた場合、もしくは --fmt オプションに xml 指定した場合に true を返します。そうでない場合は false を返します。

line_numbers -> bool[permalink][rdoc][edit]

コマンドライン引数の --line-numbers オプションを指定していた場合、true を返します。--no-line-numbers オプションを指定していた場合、false を返します。

どちらも指定しなかった場合は false を返します。

line_numbers=(val)[permalink][rdoc][edit]

val に true を指定した場合、コマンドライン引数の --line-numbers オプションと同様の指定を行います。

[PARAM] val:

--line-numbers オプションと同じ指定を行う場合は true、そうでない場合は false を指定します。

main_page -> String | nil[permalink][rdoc][edit]

コマンドライン引数の --main オプションで指定したファイル名、クラス/モジュール名を返します。

指定しなかった場合は nil を返します。

main_page=(val)[permalink][rdoc][edit]

コマンドライン引数の --main オプションと同様の指定を行います。

[PARAM] val:

設定するファイル名、クラス/モジュール名を文字列で指定します。

markup -> String[permalink][rdoc][edit]

コマンドライン引数の --markup オプションで指定したフォーマットを返します。

指定されていない場合は 'rdoc' を返します。

markup=(val)[permalink][rdoc][edit]

コマンドライン引数の --markup オプションと同様の指定を行います。

[PARAM] val:

フォーマットを文字列で指定します。

merge -> true | nil[permalink][rdoc][edit]

コマンドライン引数の --merge オプションを指定していた場合、true を返します。そうでない場合は nil を返します。

op_dir -> String[permalink][rdoc][edit]

コマンドライン引数の --op オプションで指定したディレクトリを返します。

--ri、--ri-site、--ri-system オプションにも影響される事に注意してください。

[RETURN]

設定されたディレクトリを文字列で返します。

op_dir=(val)[permalink][rdoc][edit]

コマンドライン引数の --op オプションと同様の指定を行います。

[PARAM] val:

設定するディレクトリを文字列で指定します。

op_name -> String[permalink][rdoc][edit]

コマンドライン引数の --opname オプションで指定した名前を文字列で返します。

option_parser -> OptionParser | nil[permalink][rdoc][edit]

コマンドライン引数の解析のための OptionParser オブジェクトを返します。

option_parser=(val)[permalink][rdoc][edit]

コマンドライン引数の解析のための OptionParser オブジェクトを設定します。

[PARAM] val:

OptionParser オブジェクトを指定します。

page_dir -> Pathname | nil[permalink][rdoc][edit]

コマンドライン引数の --page-dir オプションで指定したディレクトリを返します。

指定されていない場合は nil を返します。

page_dir=(val)[permalink][rdoc][edit]

コマンドライン引数の --page-dir オプションと同様の指定を行います。

[PARAM] val:

パスを文字列で指定します。

parse(argv) -> ()[permalink][rdoc][edit]

コマンドライン引数を解析します。

[PARAM] argv:

コマンドライン引数を文字列の配列で指定します。

また、以下のような指定をした場合は標準エラーに出力を行い、終了コード 1 でプログラムを終了します。

• --extension オプションに拡張子を 2 つ指定しなかった場合
• --extension オプションに new=old を指定した時に old を扱えるフォーマッ タがない場合
• --fmt オプションに扱えない出力を指定した場合

pipe -> bool[permalink][rdoc][edit]

コマンドライン引数の --pipe オプションを指定していた場合、true を返します。そうでない場合は false を返します。

pipe=(val)[permalink][rdoc][edit]

val に true を指定した場合、コマンドライン引数の --pipe オプションと同様の指定を行います。

[PARAM] val:

--pipe オプションと同じ指定を行う場合は true、そうでない場合は false を指定します。

promiscuous[permalink][rdoc][edit]

コマンドライン引数の --promiscuous を指定していた場合に true を返します。そうでない場合は false を返します。

quiet -> bool[permalink][rdoc][edit]

コマンドライン引数の --quiet オプションを指定していた場合、true を返します。そうでない場合は nil を返します。

rdoc_include -> [String][permalink][rdoc][edit]

コマンドライン引数の --include オプションで指定したディレクトリを文字列の配列で返します。

指定しなかった場合は ['.'] を返します。

root -> Pathname[permalink][rdoc][edit]

コマンドライン引数の --root オプションで指定したディレクトリを返します。

指定されていない場合はカレントディレクトリを返します。

root=(val)[permalink][rdoc][edit]

コマンドライン引数の --root オプションと同様の指定を行います。

[PARAM] val:

パスを文字列で指定します。

sanitize_path(path)[permalink][rdoc][edit]

ライブラリ内部で使用します。

show_all -> bool[permalink][rdoc][edit]

コマンドライン引数の --all オプションを指定していた場合、true を返します。そうでない場合は false を返します。

show_all=(val)[permalink][rdoc][edit]

val に true を指定した場合、コマンドライン引数の --all オプションと同様の指定を行います。

[PARAM] val:

--all オプションと同じ指定を行う場合は true、そうでない場合は false を指定します。

show_hash -> bool[permalink][rdoc][edit]

コマンドライン引数の --show-hash オプションを指定していた場合、true を返します。そうでない場合は false を返します。

static_path -> [String][permalink][rdoc][edit]

コマンドライン引数の --copy-files オプションで指定したパスの一覧を返します。

static_path=(vals)[permalink][rdoc][edit]

コマンドライン引数の --copy-files オプションと同様の指定を行います。

[PARAM] vals:

パスを文字列の配列で指定します。

tab_width -> Integer[permalink][rdoc][edit]

コマンドライン引数の --tab-width オプションで指定した数値を返します。

template -> String[permalink][rdoc][edit]

コマンドライン引数の --template オプションで指定した名前を文字列の配列で返します。

指定しなかった場合は 'html' を返します。

template_dir -> String | nil[permalink][rdoc][edit]

コマンドライン引数の --template オプションで指定したテンプレートに対応するディレクトリを返します。

オプションの解析前は nil を返します。

template_dir=(val)[permalink][rdoc][edit]

コマンドライン引数の --template オプションで指定したテンプレートに対応するディレクトリを設定します。

[PARAM] val:

パスを文字列で指定します。

title -> String | nil[permalink][rdoc][edit]

ドキュメントのタイトルを返します。指定されていない場合は nil を返します。

title=(string)[permalink][rdoc][edit]

ドキュメントのタイトルがまだ設定されていない場合に string で指定した文字列に設定します。

コマンドライン引数で既に --title オプションが指定されていた場合には、そちらを優先します。

[PARAM] string:

設定するタイトルを文字列で指定します。

verbosity -> 0 | 1 | 2[permalink][rdoc][edit]

プログラムの解析時に表示する情報の詳細さを数値で返します。

以下の値を指定する事ができます。

0(--quiet オプションを指定した場合)

情報を表示しません。

1

通常の表示を行います。

2(--verbose オプションを指定した場合)

詳細な情報を表示します。

verbosity=(val)[permalink][rdoc][edit]

プログラムの解析時に表示する情報の詳細さを数値で指定します。

[PARAM] val:

何も表示しない場合は 0、通常の表示を行う場合は 1、詳細な表示を行う場合は 2 を指定します。

[SEE_ALSO] RDoc::Options#verbosity

visibility -> :public | :protected | :private[permalink][rdoc][edit]

コマンドライン引数の --visibility で指定したオプションを Symbol で返します。

visibility=(val)[permalink][rdoc][edit]

コマンドライン引数の --visibility オプションと同様の指定を行います。

[PARAM] val:

:public、:protected、:private のいずれかを指定します。

warn(message) -> nil[permalink][rdoc][edit]

--verbose オプションを指定していた場合に message を 標準エラー出力 $stderr に出力します。

webcvs -> String | nil[permalink][rdoc][edit]

コマンドライン引数の --webcvs オプションで指定した URL を文字列で返します。

指定しなかった場合は nil を返します。

write_options -> object[permalink][rdoc][edit]

カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式で保存します。

定数

DEPRECATED -> {String -> String}[permalink][rdoc][edit]

非推奨のオプションの一覧を返します。

SPECIAL -> [String][permalink][rdoc][edit]

--write-options を指定した際に .rdoc_options ファイルに保存されないオプションの一覧を返します。