クエリ:- > クエリ:on > クエリ:rdoc_options

...tions] カスタムオプション

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

Object::ARGV に --format が含まれていた場合、RDoc はジェネ
レータ独自のオプションを解析するために setup_options...

...場合は --format オプションは必ず指定
する必要があります。rdoc --help を実行すると追加したオプションの一覧が
確認できます。

例:

class RDoc::Generator::Spellcheck
RDoc::RDoc.add_generator 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 = dictionary
end
end
end...

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

定数

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

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

rdoc (294.0)

ライブラリ

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

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

$ rdoc [options] [names...]

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

$ rdoc

このコマンドでカレントディレ...

...とができます。
例えば、Rdoc そのもののドキュメントを生成する場合は、以下のようにタイプ
します。

$ rdoc --main rdoc/rdoc.rb

RDoc が生成するドキュメントのコメント部で使える様々なマークアップの方法
は以下の markup の...

...。

: --write-options

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

: --verbose

プログラムの解析時に詳細な情報を表示します。

: --version

RDocのバージョンを表示する。

: --webcvs...

絞り込み条件を変える

rdoc/markdown (54.0)

ライブラリ

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

...ts/markdown/syntax

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

=== 拡張

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

...emphasizes in-word underscores, neither the
Markdown syntax nor MarkdownTest mention this behavior.)

また URL を記述すると HTML を出力する際に自動でリンクを作成します。URL
はそのまま表示されます。

==== Break on Newline

RDoc::Markdown#break_on_newline を...

...。この拡張はデフォルトでは無効になっています。

例:

<style type="text/css">
h1 { font-size: 3em }
</style>

==== 定義リスト

RDoc::Markdown#definition_lists を設定する事で定義リストを出力す
る事ができます。詳しくは以下を参照して...

別のキーワード

種類

ライブラリ

クラス

キーワード

検索結果

先頭5件

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

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

RDoc::Options (6030.0)

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

rdoc (294.0)

rdoc/markdown (54.0)