class RDoc::Options
クラスの継承リスト: RDoc::Options < Object < Kernel < BasicObject
要約
rdoc コマンドのオプションを解析するためのクラスです。
それぞれのオプションの詳細に関しては、rdoc/使いかた を参照してくだ さい。
インスタンスメソッド
all_one_file -> bool
-
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ ションに xml 指定した場合に true を返します。そうでない場合は false を 返します。
charset -> String
-
コマンドライン引数の --charset オプションで指定した文字コードを文字列で 返します。
指定しなかった場合は、$KCODE に応じた値になります。
coverage_report -> Integer | false
-
コマンドライン引数の --coverage-report オプションを指定していた場合、指 定した数値を返します。
指定しなかった場合は false を返します。
coverage_report=(val)
-
コマンドライン引数の --coverage-report オプションと同様の指定を行います。
- [PARAM] val:
- 数値オブジェクトか false を指定します。
css -> String
-
コマンドライン引数の --style オプションで指定した URL を文字列で返しま す。
diagram -> bool
-
コマンドライン引数の --diagram オプションを指定していた場合、true を返 します。そうでない場合は false を返します。
dry_run -> bool
-
コマンドライン引数の --dry-run オプションを指定していた場合、true を返 します。--no-dry-run オプションを指定していた場合、false を返します。
どちらも指定しなかった場合は false を返します。
dry_run=(val)
-
val に true を指定した場合、コマンドライン引数の --dry-run オプションと 同様の指定を行います。
- [PARAM] val:
- --dry-run オプションと同じ指定を行う場合は true、そうでない 場合は false を指定します。
encoding -> Encoding
-
コマンドライン引数の --encoding オプションを指定していた場合、指定した エンコーディングに対応する Encoding オブジェクトを返します。
指定しなかった場合は Encoding.default_external の値を返します。
encoding=(val)
-
コマンドライン引数の --encoding オプションと同様の指定を行います。
- [PARAM] val:
- 設定する Encoding オブジェクトを指定します。
exclude -> Regexp
-
コマンドライン引数の --exclude オプションで指定した正規表現を返します。 複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた ものを返します。
exclude=(val)
-
コマンドライン引数の --exclude オプションと同様の指定を行います。
- [PARAM] val:
- 設定するパターンを Regexp オブジェクトで指定します。
extra_accessor_flags -> {String => String}
-
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア クセサの種類が値のハッシュを返します。
値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、 attr_accessor に対応します。
extra_accessors -> Regexp | nil
-
コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ てにマッチする正規表現オブジェクトを返します。
指定しなかった場合は nil を返します。
fileboxes -> bool
-
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定 していた場合、true を返します。そうでない場合は false を返します。
files -> [String]
-
解析するファイルの一覧を文字列の配列で返します。
force_output -> bool
-
コマンドライン引数の --force_output オプションを指定していた場合、true を返します。--no-force_output オプションを指定していた場合、false を返 します。
どちらも指定しなかった場合は true を返します。
force_output=(val)
-
val に true を指定した場合、コマンドライン引数の --force_output オプショ ンと同様の指定を行います。
- [PARAM] val:
- --force_output オプションと同じ指定を行う場合は true、そうで ない場合は false を指定します。
force_update -> bool
-
コマンドライン引数の --force_update を指定していた場合に true を返しま す。そうでない場合は false を返します。
formatter -> nil
-
使用されていません。常に nil を返します。
formatter=(val)
-
使用されていません。
generator -> Generator
-
コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。
指定しなかった場合は、HTML に対応する Generator を返します。
generator=(val)
-
コマンドライン引数の --fmt オプションと同様の指定を行います。
- [PARAM] val:
- 設定する Generator を指定します。
hyperlink_all -> bool
-
コマンドライン引数の --hyperlink-all オプションを指定していた場合、 true を返します。
指定しなかった場合は false を返します。
hyperlink_all=(val)
-
val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ ンと同様の指定を行います。
- [PARAM] val:
- --hyperlink-all オプションと同じ指定を行う場合は true、そう でない場合は false を指定します。
image_format -> String
-
コマンドライン引数の --image-format オプションで指定した名前を文字列の 配列で返します。
指定しなかった場合は 'png' を返します。
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 を返 します。
どちらも指定しなかった場合は false を返します。
line_numbers=(val)
-
val に true を指定した場合、コマンドライン引数の --line-numbers オプショ ンと同様の指定を行います。
- [PARAM] val:
- --line-numbers オプションと同じ指定を行う場合は true、そうで ない場合は false を指定します。
main_page -> String | nil
-
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ ジュール名を返します。
指定しなかった場合は nil を返します。
main_page=(val)
-
コマンドライン引数の --main オプションと同様の指定を行います。
- [PARAM] val:
- 設定するファイル名、クラス/モジュール名を文字列で指定します。
merge -> true | nil
-
コマンドライン引数の --merge オプションを指定していた場合、true を返し ます。そうでない場合は nil を返します。
op_dir -> String
-
コマンドライン引数の --op オプションで指定したディレクトリを返します。
--ri、--ri-site、--ri-system オプションにも影響される事に注意してください。
- [RETURN]
- 設定されたディレクトリを文字列で返します。
op_dir=(val)
-
コマンドライン引数の --op オプションと同様の指定を行います。
- [PARAM] val:
- 設定するディレクトリを文字列で指定します。
op_name -> String
-
コマンドライン引数の --opname オプションで指定した名前を文字列で返しま す。
parse(argv) -> ()
-
コマンドライン引数を解析します。
- [PARAM] argv:
- コマンドライン引数を文字列の配列で指定します。
また、以下のような指定をした場合は標準エラーに出力を行い、終了コード 1 でプログラムを終了します。
- --extension オプションに拡張子を 2 つ指定しなかった場合
- --extension オプションに new=old を指定した時に old を扱えるフォーマッ タがない場合
- --fmt オプションに扱えない出力を指定した場合
pipe -> bool
-
コマンドライン引数の --pipe オプションを指定していた場合、true を返しま す。そうでない場合は false を返します。
pipe=(val)
-
val に true を指定した場合、コマンドライン引数の --pipe オプションと同 様の指定を行います。
- [PARAM] val:
- --pipe オプションと同じ指定を行う場合は true、そうでない場合 は false を指定します。
promiscuous
-
コマンドライン引数の --promiscuous を指定していた場合に true を返します。 そうでない場合は false を返します。
quiet -> bool
-
コマンドライン引数の --quiet オプションを指定していた場合、true を返し ます。そうでない場合は nil を返します。
rdoc_include -> [String]
-
コマンドライン引数の --include オプションで指定したディレクトリを文字列 の配列で返します。
指定しなかった場合は ['.'] を返します。
show_all -> bool
-
コマンドライン引数の --all オプションを指定していた場合、true を返しま す。そうでない場合は false を返します。
show_all=(val)
-
val に true を指定した場合、コマンドライン引数の --all オプションと同様 の指定を行います。
- [PARAM] val:
- --all オプションと同じ指定を行う場合は true、そうでない場合 は false を指定します。
show_hash -> bool
-
コマンドライン引数の --show-hash オプションを指定していた場合、true を 返します。そうでない場合は false を返します。
tab_width -> Integer
-
コマンドライン引数の --tab-width オプションで指定した数値を返します。
template -> String
-
コマンドライン引数の --template オプションで指定した名前を文字列の配列 で返します。
指定しなかった場合は 'html' を返します。
template_dir -> String | nil
-
コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを返します。
オプションの解析前は nil を返します。
template_dir=(val)
-
コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを設定します。
- [PARAM] val:
- パスを文字列で指定します。
title -> String | nil
-
ドキュメントのタイトルを返します。指定されていない場合は nil を返します。
title=(string)
-
ドキュメントのタイトルがまだ設定されていない場合に string で指定した文 字列に設定します。
コマンドライン引数で既に --title オプションが指定されていた場合には、そ ちらを優先します。
- [PARAM] string:
- 設定するタイトルを文字列で指定します。
verbosity -> 0 | 1 | 2
-
プログラムの解析時に表示する情報の詳細さを数値で返します。
以下の値を指定する事ができます。
- 0(--quiet オプションを指定した場合)
-
情報を表示しません。
- 1
-
通常の表示を行います。
- 2(--verbose オプションを指定した場合)
-
詳細な情報を表示します。
verbosity=(val)
-
プログラムの解析時に表示する情報の詳細さを数値で指定します。
- [PARAM] val:
- 何も表示しない場合は 0、通常の表示を行う場合は 1、詳細な表示 を行う場合は 2 を指定します。
[SEE_ALSO] RDoc::Options#verbosity
visibility -> :public | :protected | :private
-
コマンドライン引数の --visibility で指定したオプションを Symbol で返します。
visibility=(val)
-
コマンドライン引数の --visibility オプションと同様の指定を行います。
- [PARAM] val:
- :public、:protected、:private のいずれかを指定します。
webcvs -> String | nil
-
コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま す。
指定しなかった場合は nil を返します。