るりまサーチ

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

別のキーワード

  1. irb/help print_usage
  2. command usage
  3. net/imap usage
  4. irb print_usage
  5. rubygems/command usage

ライブラリ

クラス

検索結果

RDoc::RDoc#document(argv) -> nil (18107.0)

argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ レクトリに出力します。

...::Error ドキュメントの処理中にエラーがあった場合に発生します。

指定できるオプションについては、lib:rdoc#usage を参照してくださ
い。出力ディレクトリが指定されなかった場合はカレントディレクトリ の
doc 以下に出力...

rdoc (18.0)

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

...ディレクト
リを再帰的に走査します。ただしこの場合 Ruby と C のソースファイルのみが
処理されます。

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

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

$ rdoc <options> [name...]

ファイルをパー...
...markdown、rd、rdoc、tomdoc のいずれかから選択できます。

: --root root

Root of the source tree documentation will be generated for. Set this
when building documentation outside the source directory. Default is
the current directory.

: --page-dir dir

Directory where guid...
...ます。=begin/=end を使う場合は、
以下のように =begin の行に 'rdoc' タグを付ける必要があります。

=begin rdoc
Document
ation to
be processed by RDoc.
=end

パラグラフは左のインデントを揃えたテキストのかたまりで構成されます。そ...