:![[x]](/images/drop-condition-icon.png "条件を削除"){kind=icon}
:種類
- インスタンスメソッド (70)
- 定数 (2)
- クラス (1)
- ライブラリ (1)
ライブラリ
クラス
-
RDoc
:: Options (72)
キーワード
- DEPRECATED (1)
- Options (1)
- SPECIAL (1)
-
all
_ one _ file (1) - charset (1)
-
coverage
_ report (1) -
coverage
_ report= (1) - css (1)
- diagram (1)
-
dry
_ run (1) -
dry
_ run= (1) - encoding (1)
- encoding= (1)
- exclude (1)
- exclude= (1)
-
extra
_ accessor _ flags (1) -
extra
_ accessors (1) - fileboxes (1)
- files (1)
-
finish
_ page _ dir (1) -
force
_ output (1) -
force
_ output= (1) -
force
_ update (1) - formatter (1)
- formatter= (1)
- generator (1)
- generator= (1)
-
hyperlink
_ all (1) -
hyperlink
_ all= (1) -
image
_ format (1) -
include
_ line _ numbers (1) -
inline
_ source (1) -
line
_ numbers (1) -
line
_ numbers= (1) -
main
_ page (1) -
main
_ page= (1) - markup (1)
- markup= (1)
- merge (1)
-
op
_ dir (1) -
op
_ dir= (1) -
op
_ name (1) -
option
_ parser (1) -
option
_ parser= (1) -
page
_ dir (1) -
page
_ dir= (1) - parse (1)
- pipe (1)
- pipe= (1)
- promiscuous (1)
- quiet (1)
-
rdoc
_ include (1) - root (1)
- root= (1)
-
sanitize
_ path (1) -
show
_ all (1) -
show
_ all= (1) -
show
_ hash (1) -
static
_ path (1) -
static
_ path= (1) -
tab
_ width (1) - template (1)
-
template
_ dir (1) -
template
_ dir= (1) - title (1)
- title= (1)
- verbosity (1)
- verbosity= (1)
- visibility (1)
- visibility= (1)
- warn (1)
- webcvs (1)
検索結果
先頭5件
-
rdoc
/ options (132001.0) -
rdoc コマンドのオプションを解析するためのサブライブラリです。
rdoc コマンドのオプションを解析するためのサブライブラリです。 -
RDoc
:: Options # option _ parser -> OptionParser | nil (51601.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを返し ます。
コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。 -
RDoc
:: Options # option _ parser=(val) (51301.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを設定 します。
コマンドライン引数の解析のための OptionParser オブジェクトを設定
します。
@param val OptionParser オブジェクトを指定します。 -
RDoc
:: Options # write _ options -> object (51301.0) -
カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式 で保存します。
カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式
で保存します。 -
RDoc
:: Options (42001.0) -
rdoc コマンドのオプションを解析するためのクラスです。
rdoc コマンドのオプションを解析するためのクラスです。
それぞれのオプションの詳細に関しては、lib:rdoc#usage を参照してくだ
さい。
===[a:custom_options] カスタムオプション
RDoc のジェネレータでは、RDoc::Options をフックして独自の
オプションを指定できます。
Object::ARGV に --format が含まれていた場合、RDoc はジェネ
レータ独自のオプションを解析するために setup_options メソッドを呼び出し
ます。カスタムオプションを指定する場合は --format オプションは必ず指定
する必要が... -
RDoc
:: Options # all _ one _ file -> bool (33001.0) -
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ ションに xml 指定した場合に true を返します。そうでない場合は false を 返します。
コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ
ションに xml 指定した場合に true を返します。そうでない場合は false を
返します。 -
RDoc
:: Options # charset -> String (33001.0) -
コマンドライン引数の --charset オプションで指定した文字コードを文字列で 返します。
コマンドライン引数の --charset オプションで指定した文字コードを文字列で
返します。
指定しなかった場合は、$KCODE に応じた値になります。 -
RDoc
:: Options # coverage _ report -> Integer | false (33001.0) -
コマンドライン引数の --coverage-report オプションを指定していた場合、指 定した数値を返します。
コマンドライン引数の --coverage-report オプションを指定していた場合、指
定した数値を返します。
指定しなかった場合は false を返します。 -
RDoc
:: Options # coverage _ report=(val) (33001.0) -
コマンドライン引数の --coverage-report オプションと同様の指定を行います。
コマンドライン引数の --coverage-report オプションと同様の指定を行います。
@param val 数値オブジェクトか false を指定します。 -
RDoc
:: Options # css -> String (33001.0) -
コマンドライン引数の --style オプションで指定した URL を文字列で返しま す。
コマンドライン引数の --style オプションで指定した URL を文字列で返しま
す。 -
RDoc
:: Options # diagram -> bool (33001.0) -
コマンドライン引数の --diagram オプションを指定していた場合、true を返 します。そうでない場合は false を返します。
コマンドライン引数の --diagram オプションを指定していた場合、true を返
します。そうでない場合は false を返します。 -
RDoc
:: Options # dry _ run -> bool (33001.0) -
コマンドライン引数の --dry-run オプションを指定していた場合、true を返 します。--no-dry-run オプションを指定していた場合、false を返します。
コマンドライン引数の --dry-run オプションを指定していた場合、true を返
します。--no-dry-run オプションを指定していた場合、false を返します。
どちらも指定しなかった場合は false を返します。 -
RDoc
:: Options # dry _ run=(val) (33001.0) -
val に true を指定した場合、コマンドライン引数の --dry-run オプションと 同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --dry-run オプションと
同様の指定を行います。
@param val --dry-run オプションと同じ指定を行う場合は true、そうでない
場合は false を指定します。 -
RDoc
:: Options # encoding -> Encoding (33001.0) -
コマンドライン引数の --encoding オプションを指定していた場合、指定した エンコーディングに対応する Encoding オブジェクトを返します。
コマンドライン引数の --encoding オプションを指定していた場合、指定した
エンコーディングに対応する Encoding オブジェクトを返します。
指定しなかった場合は Encoding.default_external の値を返します。 -
RDoc
:: Options # encoding=(val) (33001.0) -
コマンドライン引数の --encoding オプションと同様の指定を行います。
コマンドライン引数の --encoding オプションと同様の指定を行います。
@param val 設定する Encoding オブジェクトを指定します。 -
RDoc
:: Options # exclude -> Regexp (33001.0) -
コマンドライン引数の --exclude オプションで指定した正規表現を返します。 複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた ものを返します。
コマンドライン引数の --exclude オプションで指定した正規表現を返します。
複数指定していた場合は、1 つの Regexp オブジェクトにまとめられた
ものを返します。 -
RDoc
:: Options # exclude=(val) (33001.0) -
コマンドライン引数の --exclude オプションと同様の指定を行います。
コマンドライン引数の --exclude オプションと同様の指定を行います。
@param val 設定するパターンを Regexp オブジェクトで指定します。 -
RDoc
:: Options # extra _ accessor _ flags -> {String => String} (33001.0) -
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア クセサの種類が値のハッシュを返します。
コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア
クセサの種類が値のハッシュを返します。
値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、
attr_accessor に対応します。 -
RDoc
:: Options # extra _ accessors -> Regexp | nil (33001.0) -
コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ てにマッチする正規表現オブジェクトを返します。
コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ
てにマッチする正規表現オブジェクトを返します。
指定しなかった場合は nil を返します。 -
RDoc
:: Options # fileboxes -> bool (33001.0) -
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定 していた場合、true を返します。そうでない場合は false を返します。
コマンドライン引数の --diagram オプション、--fileboxes オプションを指定
していた場合、true を返します。そうでない場合は false を返します。 -
RDoc
:: Options # files -> [String] (33001.0) -
解析するファイルの一覧を文字列の配列で返します。
解析するファイルの一覧を文字列の配列で返します。 -
RDoc
:: Options # finish _ page _ dir (33001.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
RDoc
:: Options # force _ output -> bool (33001.0) -
コマンドライン引数の --force_output オプションを指定していた場合、true を返します。--no-force_output オプションを指定していた場合、false を返 します。
コマンドライン引数の --force_output オプションを指定していた場合、true
を返します。--no-force_output オプションを指定していた場合、false を返
します。
どちらも指定しなかった場合は true を返します。 -
RDoc
:: Options # force _ output=(val) (33001.0) -
val に true を指定した場合、コマンドライン引数の --force_output オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --force_output オプショ
ンと同様の指定を行います。
@param val --force_output オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。 -
RDoc
:: Options # force _ update -> bool (33001.0) -
コマンドライン引数の --force_update を指定していた場合に true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --force_update を指定していた場合に true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # formatter -> nil (33001.0) -
使用されていません。常に nil を返します。
使用されていません。常に nil を返します。 -
RDoc
:: Options # formatter=(val) (33001.0) -
使用されていません。
使用されていません。 -
RDoc
:: Options # generator -> Generator (33001.0) -
コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。
コマンドライン引数の --fmt オプションで指定した文字列に応じた
Generator を返します。
指定しなかった場合は、HTML に対応する Generator を返します。 -
RDoc
:: Options # generator=(val) (33001.0) -
コマンドライン引数の --fmt オプションと同様の指定を行います。
コマンドライン引数の --fmt オプションと同様の指定を行います。
@param val 設定する Generator を指定します。 -
RDoc
:: Options # hyperlink _ all -> bool (33001.0) -
コマンドライン引数の --hyperlink-all オプションを指定していた場合、 true を返します。
コマンドライン引数の --hyperlink-all オプションを指定していた場合、
true を返します。
指定しなかった場合は false を返します。 -
RDoc
:: Options # hyperlink _ all=(val) (33001.0) -
val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ
ンと同様の指定を行います。
@param val --hyperlink-all オプションと同じ指定を行う場合は true、そう
でない場合は false を指定します。 -
RDoc
:: Options # image _ format -> String (33001.0) -
コマンドライン引数の --image-format オプションで指定した名前を文字列の 配列で返します。
コマンドライン引数の --image-format オプションで指定した名前を文字列の
配列で返します。
指定しなかった場合は 'png' を返します。 -
RDoc
:: Options # include _ line _ numbers -> bool (33001.0) -
コマンドライン引数の --include-line-numbers を指定していた場合に true を返します。そうでない場合は false を返します。
コマンドライン引数の --include-line-numbers を指定していた場合に true
を返します。そうでない場合は false を返します。 -
RDoc
:: Options # inline _ source -> bool (33001.0) -
コマンドライン引数の --inline-source オプションか --one-file を指定して いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --inline-source オプションか --one-file を指定して
いた場合、もしくは --fmt オプションに xml 指定した場合に true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # line _ numbers -> bool (33001.0) -
コマンドライン引数の --line-numbers オプションを指定していた場合、true を返します。--no-line-numbers オプションを指定していた場合、false を返 します。
コマンドライン引数の --line-numbers オプションを指定していた場合、true
を返します。--no-line-numbers オプションを指定していた場合、false を返
します。
どちらも指定しなかった場合は false を返します。 -
RDoc
:: Options # line _ numbers=(val) (33001.0) -
val に true を指定した場合、コマンドライン引数の --line-numbers オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --line-numbers オプショ
ンと同様の指定を行います。
@param val --line-numbers オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。 -
RDoc
:: Options # main _ page -> String | nil (33001.0) -
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ ジュール名を返します。
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ
ジュール名を返します。
指定しなかった場合は nil を返します。 -
RDoc
:: Options # main _ page=(val) (33001.0) -
コマンドライン引数の --main オプションと同様の指定を行います。
コマンドライン引数の --main オプションと同様の指定を行います。
@param val 設定するファイル名、クラス/モジュール名を文字列で指定します。 -
RDoc
:: Options # markup -> String (33001.0) -
コマンドライン引数の --markup オプションで指定したフォーマットを返しま す。
コマンドライン引数の --markup オプションで指定したフォーマットを返しま
す。
指定されていない場合は 'rdoc' を返します。 -
RDoc
:: Options # markup=(val) (33001.0) -
コマンドライン引数の --markup オプションと同様の指定を行います。
コマンドライン引数の --markup オプションと同様の指定を行います。
@param val フォーマットを文字列で指定します。 -
RDoc
:: Options # merge -> true | nil (33001.0) -
コマンドライン引数の --merge オプションを指定していた場合、true を返し ます。そうでない場合は nil を返します。
コマンドライン引数の --merge オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。 -
RDoc
:: Options # op _ dir -> String (33001.0) -
コマンドライン引数の --op オプションで指定したディレクトリを返します。
コマンドライン引数の --op オプションで指定したディレクトリを返します。
--ri、--ri-site、--ri-system オプションにも影響される事に注意してください。
@return 設定されたディレクトリを文字列で返します。 -
RDoc
:: Options # op _ dir=(val) (33001.0) -
コマンドライン引数の --op オプションと同様の指定を行います。
コマンドライン引数の --op オプションと同様の指定を行います。
@param val 設定するディレクトリを文字列で指定します。 -
RDoc
:: Options # op _ name -> String (33001.0) -
コマンドライン引数の --opname オプションで指定した名前を文字列で返しま す。
コマンドライン引数の --opname オプションで指定した名前を文字列で返しま
す。 -
RDoc
:: Options # page _ dir -> Pathname | nil (33001.0) -
コマンドライン引数の --page-dir オプションで指定したディレクトリを返し ます。
コマンドライン引数の --page-dir オプションで指定したディレクトリを返し
ます。
指定されていない場合は nil を返します。 -
RDoc
:: Options # page _ dir=(val) (33001.0) -
コマンドライン引数の --page-dir オプションと同様の指定を行います。
コマンドライン引数の --page-dir オプションと同様の指定を行います。
@param val パスを文字列で指定します。 -
RDoc
:: Options # parse(argv) -> () (33001.0) -
コマンドライン引数を解析します。
コマンドライン引数を解析します。
@param argv コマンドライン引数を文字列の配列で指定します。
また、以下のような指定をした場合は標準エラーに出力を行い、終了コード 1
でプログラムを終了します。
* --extension オプションに拡張子を 2 つ指定しなかった場合
* --extension オプションに new=old を指定した時に old を扱えるフォーマッ
タがない場合
* --fmt オプションに扱えない出力を指定した場合 -
RDoc
:: Options # pipe -> bool (33001.0) -
コマンドライン引数の --pipe オプションを指定していた場合、true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --pipe オプションを指定していた場合、true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # pipe=(val) (33001.0) -
val に true を指定した場合、コマンドライン引数の --pipe オプションと同 様の指定を行います。
val に true を指定した場合、コマンドライン引数の --pipe オプションと同
様の指定を行います。
@param val --pipe オプションと同じ指定を行う場合は true、そうでない場合
は false を指定します。 -
RDoc
:: Options # promiscuous (33001.0) -
コマンドライン引数の --promiscuous を指定していた場合に true を返します。 そうでない場合は false を返します。
コマンドライン引数の --promiscuous を指定していた場合に true を返します。
そうでない場合は false を返します。 -
RDoc
:: Options # quiet -> bool (33001.0) -
コマンドライン引数の --quiet オプションを指定していた場合、true を返し ます。そうでない場合は nil を返します。
コマンドライン引数の --quiet オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。 -
RDoc
:: Options # rdoc _ include -> [String] (33001.0) -
コマンドライン引数の --include オプションで指定したディレクトリを文字列 の配列で返します。
コマンドライン引数の --include オプションで指定したディレクトリを文字列
の配列で返します。
指定しなかった場合は ['.'] を返します。 -
RDoc
:: Options # root -> Pathname (33001.0) -
コマンドライン引数の --root オプションで指定したディレクトリを返します。
コマンドライン引数の --root オプションで指定したディレクトリを返します。
指定されていない場合はカレントディレクトリを返します。 -
RDoc
:: Options # root=(val) (33001.0) -
コマンドライン引数の --root オプションと同様の指定を行います。
コマンドライン引数の --root オプションと同様の指定を行います。
@param val パスを文字列で指定します。 -
RDoc
:: Options # sanitize _ path(path) (33001.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
RDoc
:: Options # show _ all -> bool (33001.0) -
コマンドライン引数の --all オプションを指定していた場合、true を返しま す。そうでない場合は false を返します。
コマンドライン引数の --all オプションを指定していた場合、true を返しま
す。そうでない場合は false を返します。 -
RDoc
:: Options # show _ all=(val) (33001.0) -
val に true を指定した場合、コマンドライン引数の --all オプションと同様 の指定を行います。
val に true を指定した場合、コマンドライン引数の --all オプションと同様
の指定を行います。
@param val --all オプションと同じ指定を行う場合は true、そうでない場合
は false を指定します。 -
RDoc
:: Options # show _ hash -> bool (33001.0) -
コマンドライン引数の --show-hash オプションを指定していた場合、true を 返します。そうでない場合は false を返します。
コマンドライン引数の --show-hash オプションを指定していた場合、true を
返します。そうでない場合は false を返します。 -
RDoc
:: Options # static _ path -> [String] (33001.0) -
コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し ます。
コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し
ます。 -
RDoc
:: Options # static _ path=(vals) (33001.0) -
コマンドライン引数の --copy-files オプションと同様の指定を行います。
コマンドライン引数の --copy-files オプションと同様の指定を行います。
@param vals パスを文字列の配列で指定します。 -
RDoc
:: Options # tab _ width -> Integer (33001.0) -
コマンドライン引数の --tab-width オプションで指定した数値を返します。
コマンドライン引数の --tab-width オプションで指定した数値を返します。 -
RDoc
:: Options # template -> String (33001.0) -
コマンドライン引数の --template オプションで指定した名前を文字列の配列 で返します。
コマンドライン引数の --template オプションで指定した名前を文字列の配列
で返します。
指定しなかった場合は 'html' を返します。 -
RDoc
:: Options # template _ dir -> String | nil (33001.0) -
コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを返します。
コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを返します。
オプションの解析前は nil を返します。 -
RDoc
:: Options # template _ dir=(val) (33001.0) -
コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを設定します。
コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを設定します。
@param val パスを文字列で指定します。 -
RDoc
:: Options # title -> String | nil (33001.0) -
ドキュメントのタイトルを返します。指定されていない場合は nil を返します。
ドキュメントのタイトルを返します。指定されていない場合は nil を返します。 -
RDoc
:: Options # title=(string) (33001.0) -
ドキュメントのタイトルがまだ設定されていない場合に string で指定した文 字列に設定します。
ドキュメントのタイトルがまだ設定されていない場合に string で指定した文
字列に設定します。
コマンドライン引数で既に --title オプションが指定されていた場合には、そ
ちらを優先します。
@param string 設定するタイトルを文字列で指定します。 -
RDoc
:: Options # verbosity -> 0 | 1 | 2 (33001.0) -
プログラムの解析時に表示する情報の詳細さを数値で返します。
プログラムの解析時に表示する情報の詳細さを数値で返します。
以下の値を指定する事ができます。
: 0(--quiet オプションを指定した場合)
情報を表示しません。
: 1
通常の表示を行います。
: 2(--verbose オプションを指定した場合)
詳細な情報を表示します。 -
RDoc
:: Options # verbosity=(val) (33001.0) -
プログラムの解析時に表示する情報の詳細さを数値で指定します。
プログラムの解析時に表示する情報の詳細さを数値で指定します。
@param val 何も表示しない場合は 0、通常の表示を行う場合は 1、詳細な表示
を行う場合は 2 を指定します。
@see RDoc::Options#verbosity -
RDoc
:: Options # visibility -> :public | :protected | :private (33001.0) -
コマンドライン引数の --visibility で指定したオプションを Symbol で返します。
コマンドライン引数の --visibility で指定したオプションを Symbol
で返します。 -
RDoc
:: Options # visibility=(val) (33001.0) -
コマンドライン引数の --visibility オプションと同様の指定を行います。
コマンドライン引数の --visibility オプションと同様の指定を行います。
@param val :public、:protected、:private のいずれかを指定します。 -
RDoc
:: Options # warn(message) -> nil (33001.0) -
--verbose オプションを指定していた場合に message を 標準エラー出力 $stderr に出力します。
--verbose オプションを指定していた場合に message を 標準エラー出力
$stderr に出力します。 -
RDoc
:: Options # webcvs -> String | nil (33001.0) -
コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま す。
コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま
す。
指定しなかった場合は nil を返します。 -
RDoc
:: Options :: DEPRECATED -> {String -> String} (33001.0) -
非推奨のオプションの一覧を返します。
非推奨のオプションの一覧を返します。 -
RDoc
:: Options :: SPECIAL -> [String] (33001.0) -
--write-options を指定した際に .rdoc_options ファイルに保存されないオプ ションの一覧を返します。
--write-options を指定した際に .rdoc_options ファイルに保存されないオプ
ションの一覧を返します。