Ruby 1.9.2 リファレンスマニュアル > ライブラリ一覧 > rubygems/doc_managerライブラリ > Gem::DocManagerクラス

class Gem::DocManager

クラスの継承リスト: Gem::DocManager < Gem::UserInteraction < Gem::DefaultUserInteraction < Object < Kernel < BasicObject

Abstract

特異メソッド

configured_args -> Array

RDoc に渡す引数を返します。

configured_args=(args)

RDoc に渡す引数をセットします。

[PARAM] args:

文字列の配列か空白区切りの文字列を指定します。

load_rdoc

Gem の RDoc が使用可能な場合は使用します。 そうでない場合は、標準添付の RDoc を使用します。

[EXCEPTION] Gem::DocumentError:

RDoc が使用できない場合に発生します。

new(spec, rdoc_args = "")

自身を初期化します。

[PARAM] spec:

ドキュメントを生成する対象の Gem::Specification のインスタンスを指定します。

[UNKNOWN_META_INFO] @oaram:

rdoc_args RDoc に渡すオプションを指定します。

update_ri_cache

RDoc 2 がインストールされている場合は RI のキャッシュを更新します。 そうでない場合は何もしません。

インスタンスメソッド

generate_rdoc

自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。

generate_ri

自身にセットされている Gem::Specification の情報をもとに RI 用のデータを生成します。

install_rdoc

RDoc を生成してインストールします。

install_ri

RI のデータを生成してインストールします。

rdoc_installed? -> bool

RDoc がインストール済みの場合は、真を返します。 そうでない場合は偽を返します。

run_rdoc(*args)

与えられた引数を使用して RDoc を実行します。

[PARAM] args:

RDoc に与える引数を指定します。

[EXCEPTION] Gem::FilePermissionError:

RDoc でドキュメント生成中にファイルにアクセス出来なかった場合に発生します。

setup_rdoc

RDoc を実行するための準備を行います。

[EXCEPTION] Gem::FilePermissionError:

RDoc を保存するディレクトリにアクセスする権限がない場合に発生します。

uninstall_doc

RDoc と RI 用のデータを削除します。