ライブラリ
キーワード
-
coverage
_ report= (1) -
dry
_ run= (1) - encoding= (1)
- exclude= (1)
-
force
_ output= (1) - generator= (1)
-
hyperlink
_ all= (1) -
line
_ numbers= (1) -
main
_ page= (1) - markup= (1)
-
op
_ dir (1) -
op
_ dir= (1) -
option
_ parser= (1) -
page
_ dir= (1) - parse (1)
- pipe= (1)
- root= (1)
-
show
_ all= (1) -
static
_ path= (1) -
template
_ dir= (1) - title= (1)
- verbosity= (1)
- visibility= (1)
検索結果
先頭5件
-
RDoc
:: Options # verbosity=(val) (43.0) -
プログラムの解析時に表示する情報の詳細さを数値で指定します。
...プログラムの解析時に表示する情報の詳細さを数値で指定します。
@param val 何も表示しない場合は 0、通常の表示を行う場合は 1、詳細な表示
を行う場合は 2 を指定します。
@see RDoc::Options#verbosity... -
RDoc
:: Options # coverage _ report=(val) (25.0) -
コマンドライン引数の --coverage-report オプションと同様の指定を行います。
コマンドライン引数の --coverage-report オプションと同様の指定を行います。
@param val 数値オブジェクトか false を指定します。 -
RDoc
:: Options # dry _ run=(val) (25.0) -
val に true を指定した場合、コマンドライン引数の --dry-run オプションと 同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --dry-run オプションと
同様の指定を行います。
@param val --dry-run オプションと同じ指定を行う場合は true、そうでない
場合は false を指定します。 -
RDoc
:: Options # encoding=(val) (25.0) -
コマンドライン引数の --encoding オプションと同様の指定を行います。
コマンドライン引数の --encoding オプションと同様の指定を行います。
@param val 設定する Encoding オブジェクトを指定します。 -
RDoc
:: Options # exclude=(val) (25.0) -
コマンドライン引数の --exclude オプションと同様の指定を行います。
コマンドライン引数の --exclude オプションと同様の指定を行います。
@param val 設定するパターンを Regexp オブジェクトで指定します。 -
RDoc
:: Options # force _ output=(val) (25.0) -
val に true を指定した場合、コマンドライン引数の --force_output オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --force_output オプショ
ンと同様の指定を行います。
@param val --force_output オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。 -
RDoc
:: Options # generator=(val) (25.0) -
コマンドライン引数の --fmt オプションと同様の指定を行います。
コマンドライン引数の --fmt オプションと同様の指定を行います。
@param val 設定する Generator を指定します。 -
RDoc
:: Options # hyperlink _ all=(val) (25.0) -
val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ
ンと同様の指定を行います。
@param val --hyperlink-all オプションと同じ指定を行う場合は true、そう
でない場合は false を指定します。 -
RDoc
:: Options # line _ numbers=(val) (25.0) -
val に true を指定した場合、コマンドライン引数の --line-numbers オプショ ンと同様の指定を行います。
val に true を指定した場合、コマンドライン引数の --line-numbers オプショ
ンと同様の指定を行います。
@param val --line-numbers オプションと同じ指定を行う場合は true、そうで
ない場合は false を指定します。 -
RDoc
:: Options # main _ page=(val) (25.0) -
コマンドライン引数の --main オプションと同様の指定を行います。
コマンドライン引数の --main オプションと同様の指定を行います。
@param val 設定するファイル名、クラス/モジュール名を文字列で指定します。 -
RDoc
:: Options # markup=(val) (25.0) -
コマンドライン引数の --markup オプションと同様の指定を行います。
コマンドライン引数の --markup オプションと同様の指定を行います。
@param val フォーマットを文字列で指定します。 -
RDoc
:: Options # op _ dir -> String (25.0) -
コマンドライン引数の --op オプションで指定したディレクトリを返します。
コマンドライン引数の --op オプションで指定したディレクトリを返します。
--ri、--ri-site、--ri-system オプションにも影響される事に注意してください。
@return 設定されたディレクトリを文字列で返します。 -
RDoc
:: Options # op _ dir=(val) (25.0) -
コマンドライン引数の --op オプションと同様の指定を行います。
コマンドライン引数の --op オプションと同様の指定を行います。
@param val 設定するディレクトリを文字列で指定します。 -
RDoc
:: Options # option _ parser=(val) (25.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを設定 します。
コマンドライン引数の解析のための OptionParser オブジェクトを設定
します。
@param val OptionParser オブジェクトを指定します。 -
RDoc
:: Options # page _ dir=(val) (25.0) -
コマンドライン引数の --page-dir オプションと同様の指定を行います。
コマンドライン引数の --page-dir オプションと同様の指定を行います。
@param val パスを文字列で指定します。 -
RDoc
:: Options # parse(argv) -> () (25.0) -
コマンドライン引数を解析します。
コマンドライン引数を解析します。
@param argv コマンドライン引数を文字列の配列で指定します。
また、以下のような指定をした場合は標準エラーに出力を行い、終了コード 1
でプログラムを終了します。
* --extension オプションに拡張子を 2 つ指定しなかった場合
* --extension オプションに new=old を指定した時に old を扱えるフォーマッ
タがない場合
* --fmt オプションに扱えない出力を指定した場合 -
RDoc
:: Options # pipe=(val) (25.0) -
val に true を指定した場合、コマンドライン引数の --pipe オプションと同 様の指定を行います。
val に true を指定した場合、コマンドライン引数の --pipe オプションと同
様の指定を行います。
@param val --pipe オプションと同じ指定を行う場合は true、そうでない場合
は false を指定します。 -
RDoc
:: Options # root=(val) (25.0) -
コマンドライン引数の --root オプションと同様の指定を行います。
コマンドライン引数の --root オプションと同様の指定を行います。
@param val パスを文字列で指定します。 -
RDoc
:: Options # show _ all=(val) (25.0) -
val に true を指定した場合、コマンドライン引数の --all オプションと同様 の指定を行います。
val に true を指定した場合、コマンドライン引数の --all オプションと同様
の指定を行います。
@param val --all オプションと同じ指定を行う場合は true、そうでない場合
は false を指定します。 -
RDoc
:: Options # static _ path=(vals) (25.0) -
コマンドライン引数の --copy-files オプションと同様の指定を行います。
コマンドライン引数の --copy-files オプションと同様の指定を行います。
@param vals パスを文字列の配列で指定します。 -
RDoc
:: Options # template _ dir=(val) (25.0) -
コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを設定します。
コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを設定します。
@param val パスを文字列で指定します。 -
RDoc
:: Options # title=(string) (25.0) -
ドキュメントのタイトルがまだ設定されていない場合に string で指定した文 字列に設定します。
ドキュメントのタイトルがまだ設定されていない場合に string で指定した文
字列に設定します。
コマンドライン引数で既に --title オプションが指定されていた場合には、そ
ちらを優先します。
@param string 設定するタイトルを文字列で指定します。 -
RDoc
:: Options # visibility=(val) (25.0) -
コマンドライン引数の --visibility オプションと同様の指定を行います。
コマンドライン引数の --visibility オプションと同様の指定を行います。
@param val :public、:protected、:private のいずれかを指定します。