class Options

要約

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

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

[注意] クラス名は RDoc::Option ではない事に注意してください。(1.9 系では RDoc::Option クラスとして使用できます。)

目次

インスタンスメソッド

• all_one_file
• charset
• css
• diagram
• exclude
• exclude=
• extra_accessor_flags
• extra_accessors
• fileboxes
• files
• force_update
• generator
• generator=
• image_format
• include_line_numbers
• inline_source
• main_page
• main_page=
• merge
• op_dir
• op_dir=
• op_name
• option_parser
• option_parser=
• parse
• promiscuous
• quiet
• rdoc_include
• show_all
• show_all=
• show_hash
• tab_width
• template
• title
• title=
• webcvs

継承しているメソッド

インスタンスメソッド

all_one_file -> bool[permalink][rdoc]

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

charset -> String[permalink][rdoc]

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

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

css -> String[permalink][rdoc]

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

diagram -> bool[permalink][rdoc]

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

exclude -> Regexp[permalink][rdoc]

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

exclude=(val)[permalink][rdoc]

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

[PARAM] val:

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

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

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

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

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

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

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

fileboxes -> bool[permalink][rdoc]

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

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

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

force_update -> bool[permalink][rdoc]

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

generator -> Generator[permalink][rdoc]

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

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

generator=(val)[permalink][rdoc]

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

[PARAM] val:

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

image_format -> String[permalink][rdoc]

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

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

include_line_numbers -> bool[permalink][rdoc]

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

inline_source -> bool[permalink][rdoc]

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

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

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

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

main_page=(val)[permalink][rdoc]

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

[PARAM] val:

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

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

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

op_dir -> String[permalink][rdoc]

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

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

[RETURN]

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

op_dir=(val)[permalink][rdoc]

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

[PARAM] val:

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

op_name -> String[permalink][rdoc]

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

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

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

option_parser=(val)[permalink][rdoc]

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

[PARAM] val:

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

parse(argv, generators) -> ()[permalink][rdoc]

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

[PARAM] argv:

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

[PARAM] generators:

Generator の配列を指定します。

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

• --extension オプションに拡張子を 2 つ指定しなかった場合
• --extension オプションに new=old を指定した時に old を扱えるフォーマッ タがない場合
• --fmt オプションに扱えない出力を指定した場合
• --image-format オプションを指定した時に、指定したフォーマットが png、 gif、jpeg、jpg のいずれでもなかった場合
• --tab-width オプションに数値以外を指定した場合

promiscuous[permalink][rdoc]

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

quiet -> bool[permalink][rdoc]

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

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

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

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

show_all -> bool[permalink][rdoc]

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

show_all=(val)[permalink][rdoc]

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

[PARAM] val:

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

show_hash -> bool[permalink][rdoc]

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

tab_width -> Integer[permalink][rdoc]

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

template -> String[permalink][rdoc]

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

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

title -> String | "RDoc Documentation"[permalink][rdoc]

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

title=(string)[permalink][rdoc]

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

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

[PARAM] string:

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

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

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

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