クエリ:options > クエリ:rdoc_options

...のオプションの詳細に関しては、lib:rdoc#usage を参照してくだ
さい。

===[a:custom_options] カスタムオプション

RDoc のジェネレータでは、RDoc::Options をフックして独自の
オプションを指定できます。

Object::ARGV に --format が含ま...

...self

def self.setup_options rdoc_options
op = rdoc_options.option_parser

op.on('--spell-dictionary DICTIONARY',
RDoc::Options::Path) do |dictionary|
# RDoc::Options に spell_dictionary アクセサの定義が必要
rdoc_options.spell_dictionary = dicti...

RDoc::Options::SPECIAL -> [String] (3048.0)

定数

--write-options を指定した際に .rdoc_options ファイルに保存されないオプションの一覧を返します。

...--write-options を指定した際に .rdoc_options ファイルに保存されないオプ
ションの一覧を返します。...

絞り込み条件を変える

rdoc (96.0)

ライブラリ

RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc というドキュメント生成のためのコマンドも含んでいます。

...要

インストールすれば、'rdoc' コマンドでドキュメントが生成できます。
(Windows では 'rdoc.bat' です)

$ rdoc [options] [names...]

"rdoc --help" と打てば、最新のオプションに関する情報が得られます。

$ rdoc

このコマンドでカレ...

...みが
処理されます。

===[a:usage] 使いかた

RDoc はコマンドラインから以下のようにして起動します。

$ rdoc <options> [name...]

ファイルをパースし、そこに含まれている情報を集め、出力します。こうして
全ファイルに渡るク...

...内容全てをコピーしま
す。
このオプションは複数回指定する事ができます。

: --write-options

カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形
式で保存します。

: --verbose

プログラムの解析時に...

rdoc/markdown (18.0)

ライブラリ

Markdown 形式で記述されたドキュメントを rdoc 上で解析するためのサブライブラリです。

...ects/markdown/syntax

Markdown 形式をデフォルトのフォーマットにする場合は、
lib:rdoc#saved_options を参考にプロジェクトのデフォルトを
.rdoc_options ファイルで設定してください。

=== 拡張

以降の Markdown の拡張は RDoc のパーサ独自...

別のキーワード

種類

ライブラリ

クラス

キーワード

検索結果

先頭5件

Gem::Specification#rdoc_options -> [String] (24202.0)

Gem::Specification#rdoc_options=(options) (12309.0)

RDoc::Options#write_options -> object (9133.0)

RDoc::Options (6072.0)

RDoc::Options::SPECIAL -> [String] (3048.0)

rdoc (96.0)

rdoc/markdown (18.0)