るりまサーチ

最速Rubyリファレンスマニュアル検索!
60件ヒット [1-60件を表示] (0.074秒)
トップページ > クエリ:>[x] > クエリ:rdoc_options[x]

別のキーワード

  1. rdoc version
  2. rdoc/context new
  3. rdoc attr_modifiers
  4. rdoc/markdown parse
  5. rdoc class_modifiers

ライブラリ

クラス

キーワード

検索結果

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

API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。

API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。

rdoc (180.0)

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

...
処理されます。

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

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

$ rdoc <options> [name...]

ファイルをパースし、そこに含まれている情報を集め、出力します。こうして
全ファイルに渡るクロ...
...します。デフォルトでは --ri を指定すると
~/.rdoc に出力されますが、--ri-site で $datadir/ri/<ver>/site
に、--ri-system で $datadir/ri/<ver>/system に出力されます。これらす
べてはうしろに指定した --op を上書きします。デフォルト...
...しま
す。
このオプションは複数回指定する事ができます。

: --write-options

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


: --verbose

プログラムの解析時に詳細な情報を表示...

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

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

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

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

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

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

rdoc/markdown (24.0)

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

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

=== 拡張

以降の Markdown の拡張は RDoc のパーサ独自にサポートされている...
...含める事はできま
せん。この拡張はデフォルトでは無効になっています。

例:

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

==== 定義リスト

RDoc::Markdown#definition_lists を設定する事で定義リストを出力す
る事ができます。詳...
...た場合にそのまま
出力する事ができます。この拡張はデフォルトで有効になっています。

例:

<table>
...
</table>

==== Notes

RDoc::Markdown#notes を設定する事で脚注を出力する事ができます。こ
の拡張はデフォルトで有効...

絞り込み条件を変える