class Gem::DocManager + Gem::UserInteraction + Gem::DefaultUserInteraction
クラスの継承リスト: Gem::DocManager < Gem::UserInteraction < Gem::DefaultUserInteraction < Object < Kernel < BasicObject
要約
Gem パッケージの RDoc, RI を生成するためのクラスです。
特異メソッド
configured_args -> Array-
RDoc に渡す引数を返します。
configured_args=(args)-
RDoc に渡す引数をセットします。
- [PARAM] args:
- 文字列の配列か空白区切りの文字列を指定します。
load_rdoc-
Gem の RDoc が使用可能な場合は使用します。 そうでない場合は、標準添付の RDoc を使用します。
- [EXCEPTION] Gem::DocumentError:
- RDoc が使用できない場合に発生します。
new(spec, rdoc_args = "") -> Gem::DocManager-
自身を初期化します。
- [PARAM] spec:
- ドキュメントを生成する対象の Gem::Specification のインスタンスを指定します。
- [PARAM] rdoc_args:
- RDoc に渡すオプションを指定します。
ui -> Gem::ConsoleUI-
デフォルトの UI を返します。
ui=(new_ui)-
デフォルトの UI を新しくセットします。
デフォルトの UI を明確にセットしたことがなければ、シンプルなコンソールベースの Gem::UserInteraction を自動的に使用します。
- [PARAM] new_ui:
- 新しい UI を指定します。
update_ri_cache-
RDoc 2 がインストールされている場合は RI のキャッシュを更新します。 そうでない場合は何もしません。
use_ui(new_ui) { ... }-
与えられたブロックを評価している間だけ UI として new_ui を使用します。
- [PARAM] new_ui:
- 新しい UI を指定します。
インスタンスメソッド
alert(*args) -> ()-
INFO レベルのアラートを出力します。
- [PARAM] args:
- 委譲先のメソッドに与える引数です。
alert_error(*args) -> ()-
ERROR レベルのアラートを出力します。
- [PARAM] args:
- 委譲先のメソッドに与える引数です。
alert_warning(*args) -> ()-
WARNING レベルのアラートを出力します。
- [PARAM] args:
- 委譲先のメソッドに与える引数です。
ask(*args) -> String-
質問をして、ユーザの入力を待ち受けて回答を返します。
- [PARAM] args:
- 委譲先のメソッドに与える引数です。
ask_yes_no(*args) -> bool-
イエス、ノーで答える質問をします。
- [PARAM] args:
- 委譲先のメソッドに与える引数です。
- [RETURN]
- ユーザの回答がイエスの場合は真を、ノーの場合は偽を返します。
choose_from_list(*args) -> Array-
リストから回答を選択する質問をします。
- [PARAM] args:
- 委譲先のメソッドに与える引数です。
- [RETURN]
- 選択肢の名称と選択肢のインデックスを要素とする配列を返します。
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 でドキュメント生成中にファイルにアクセス出来なかった場合に発生します。
say(*args) -> ()-
与えられた文字列を表示します。
- [PARAM] args:
- 委譲先のメソッドに与える引数です。
setup_rdoc-
RDoc を実行するための準備を行います。
- [EXCEPTION] Gem::FilePermissionError:
- RDoc を保存するディレクトリにアクセスする権限がない場合に発生します。
terminate_interaction(*args) -> ()-
アプリケーションを終了します。
- [PARAM] args:
- 委譲先のメソッドに与える引数です。
ui -> Gem::ConsoleUI-
デフォルトの UI を返します。
[SEE_ALSO] Gem::DefaultUserInteraction.ui
ui=(new_ui)-
デフォルトの UI を新しくセットします。
- [PARAM] new_ui:
- 新しい UI を指定します。
[SEE_ALSO] Gem::DefaultUserInteraction.ui=
uninstall_doc-
RDoc と RI 用のデータを削除します。
use_ui(new_ui) { ... }-
与えられたブロックを評価している間だけ UI として new_ui を使用します。
- [PARAM] new_ui:
- 新しい UI を指定します。
[SEE_ALSO] Gem::DefaultUserInteraction.use_ui
