:RDoc::RDoc![[x]](/images/drop-condition-icon.png "条件を削除"){kind=icon}
種類
- クラス (24)
- ライブラリ (24)
- 特異メソッド (12)
- インスタンスメソッド (12)
ライブラリ
-
rdoc
/ rdoc (36)
クラス
-
RDoc
:: RDoc (24)
キーワード
- Options (12)
- RDoc (12)
-
add
_ generator (12) - document (12)
- rdoc (12)
-
rdoc
/ generator (12)
検索結果
先頭5件
-
RDoc
:: RDoc (23006.0) -
rdoc ドキュメントの作成を行うクラスです。
...ラスです。
以下のようにして、rdoc コマンドを実行するのと同様に実行します。
require 'rdoc/rdoc'
rdoc = RDoc::RDoc.new
rdoc.document(args)
args には rdoc コマンドに渡すのと同様の引数を文字列の配列で指定します。
rdoc コマン... -
RDoc
:: RDoc # document(argv) -> nil (21000.0) -
argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ レクトリに出力します。
argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ
レクトリに出力します。
@param argv コマンドラインで rdoc コマンドに指定するのと同じ引数を文字
列の配列で指定します。
@raise RDoc::Error ドキュメントの処理中にエラーがあった場合に発生します。
指定できるオプションについては、lib:rdoc#usage を参照してくださ
い。出力ディレクトリが指定されなかった場合はカレントディレクトリ の
doc 以下に出力します。 -
RDoc
:: RDoc . add _ generator(klass) -> klass (21000.0) -
引数 klass で指定したクラスをジェネレータとして登録します。
引数 klass で指定したクラスをジェネレータとして登録します。
@param klass 登録するクラスを指定します。
@see c:RDoc::Options#custom_options -
rdoc (18.0)
-
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。
...クアップについて知りたければ、rdoc/markup を参照してください。
* RDoc をライブラリとして使いたければ、RDoc::RDoc を参照してください。
* テキスト部を HTML に変換する部分をライブラリとして使いたければ、RDoc::Markup を......変換されます。
//emlist{
{ruby-lang.org}[www.ruby-lang.org]
//}
: クラスやメソッド
\RDoc::RDoc#document は以下のように変換されます。
//emlist{
RDoc::RDoc#document
//}
: タグ内のエスケープ無視(S クラスは定義済み)
<tt>\S</tt> は以下の... -
rdoc
/ generator (12.0) -
RDoc が解析したソースコードを RDoc::CodeObject のツリーから その他の形式に出力するためのサブライブラリです。
...RDoc::Generator::RI が付属しています。
=== ジェネレータの登録
RDoc::RDoc.add_generator を呼び出す事でジェネレータの登録が行えます。
class My::Awesome::Generator
RDoc::RDoc.add_generator self
end
=== rdoc のオプションの追加
rdoc ではオ... -
RDoc
:: Options (6.0) -
rdoc コマンドのオプションを解析するためのクラスです。
...ます。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...