module RDoc

要約

rdoc ドキュメントを扱うためのモジュールです。

目次

追加されるメソッド

• ATTR_MODIFIERS
• CLASS_MODIFIERS
• CONSTANT_MODIFIERS
• GENERAL_MODIFIERS
• KNOWN_CLASSES
• METHOD_MODIFIERS
• usage
• usage_no_exit

定数

• DOT_DOC_FILENAME

追加されるメソッド

ATTR_MODIFIERS -> [String][permalink][rdoc] [added by rdoc/parsers/parse_rb]

ライブラリの内部で使用します。

CLASS_MODIFIERS -> [String][permalink][rdoc] [added by rdoc/parsers/parse_rb]

ライブラリの内部で使用します。

CONSTANT_MODIFIERS -> [String][permalink][rdoc] [added by rdoc/parsers/parse_rb]

ライブラリの内部で使用します。

GENERAL_MODIFIERS -> [String][permalink][rdoc] [added by rdoc/parsers/parse_rb]

ライブラリの内部で使用します。

KNOWN_CLASSES -> {String => String}[permalink][rdoc] [added by rdoc/parsers/parse_c]

Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。

RDoc::KNOWN_CLASSES["rb_cObject"] # => "Object"

ライブラリの内部で使用します。

METHOD_MODIFIERS -> [String][permalink][rdoc] [added by rdoc/parsers/parse_rb]

ライブラリの内部で使用します。

usage(*args) -> ()[permalink][rdoc] [added by rdoc/usage]

プログラムの使い方(RDoc.usage を呼び出したソースファイルの先頭に記述されたコメント)を標準出力に表示してプログラムを終了します。

数値に変換可能なオブジェクトを args[0] に指定した場合、終了ステータスを args[0] で指定した値にします。指定しなかった場合は 0 です。

[PARAM] args:

プログラムの終了ステータスや表示するセクションの指定を配列で指定します。詳しくは rdoc/usage/使い方 をご覧ください。

usage_no_exit(*args) -> ()[permalink][rdoc] [added by rdoc/usage]

プログラムの使い方(RDoc.usage を呼び出したソースファイルの先頭に記述されたコメント)を標準出力に表示します。

[PARAM] args:

表示するセクションの指定を配列で指定します。詳しくは rdoc/usage/使い方 をご覧ください。

定数

DOT_DOC_FILENAME -> ".document"[permalink][rdoc]

rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。