検索結果

RDoc::Options#visibility -> :public | :protected | :private (18607.0)

• 2.1.0

• インスタンスメソッド

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

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

• Symbol

RDoc::Options#all_one_file -> bool (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

RDoc::Options#exclude -> Regexp (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

• Regexp

RDoc::Options#exclude=(val) (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

• Regexp

RDoc::Options#extra_accessor_flags -> {String => String} (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

絞り込み条件を変える

RDoc::Options#fileboxes -> bool (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

RDoc::Options#files -> [String] (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

RDoc::Options#hyperlink_all -> bool (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#hyperlink_all=(val) (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#include_line_numbers -> bool (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

絞り込み条件を変える

RDoc::Options#inline_source -> bool (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

RDoc::Options#line_numbers -> bool (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#line_numbers=(val) (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#rdoc_include -> [String] (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#show_all -> bool (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

絞り込み条件を変える

RDoc::Options#show_all=(val) (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#template -> String (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#template_dir -> String | nil (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#template_dir=(val) (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#title -> String | nil (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

絞り込み条件を変える

RDoc::Options#title=(string) (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

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

RDoc::Options#visibility=(val) (18307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#coverage_report -> Integer | false (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#coverage_report=(val) (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#diagram -> bool (307.0)

• 2.1.0

• インスタンスメソッド

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

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

絞り込み条件を変える

RDoc::Options#dry_run -> bool (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#dry_run=(val) (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#encoding=(val) (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

• Encoding

RDoc::Options#extra_accessors -> Regexp | nil (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#force_output -> bool (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

絞り込み条件を変える

RDoc::Options#force_output=(val) (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#force_update -> bool (307.0)

• 2.1.0

• インスタンスメソッド

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

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

RDoc::Options#formatter -> nil (307.0)

• 2.1.0

• インスタンスメソッド

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

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

RDoc::Options#formatter=(val) (307.0)

• 2.1.0

• インスタンスメソッド

使用されていません。

使用されていません。

RDoc::Options#generator=(val) (307.0)

• 2.1.0

• インスタンスメソッド

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

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

@param val 設定する Generator を指定します。

絞り込み条件を変える

RDoc::Options#main_page -> String | nil (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#main_page=(val) (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#markup=(val) (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#merge -> true | nil (307.0)

• 2.1.0

• インスタンスメソッド

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

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

RDoc::Options#op_dir=(val) (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

絞り込み条件を変える

RDoc::Options#option_parser -> OptionParser | nil (307.0)

• 2.1.0

• インスタンスメソッド

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

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

• OptionParser

RDoc::Options#option_parser=(val) (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

• OptionParser

RDoc::Options#page_dir -> Pathname | nil (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#page_dir=(val) (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#pipe -> bool (307.0)

• 2.1.0

• インスタンスメソッド

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

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

絞り込み条件を変える

RDoc::Options#pipe=(val) (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#quiet -> bool (307.0)

• 2.1.0

• インスタンスメソッド

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

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

RDoc::Options#root=(val) (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

RDoc::Options#show_hash -> bool (307.0)

• 2.1.0

• インスタンスメソッド

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

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

RDoc::Options#static_path=(vals) (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

絞り込み条件を変える

RDoc::Options#verbosity=(val) (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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

@see RDoc::Options#verbosity...

RDoc::Options#warn(message) -> nil (307.0)

• 2.1.0

• インスタンスメソッド

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

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

RDoc::Options#webcvs -> String | nil (307.0)

• 2.1.0

• インスタンスメソッド

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

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

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