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

class Gem::DocManager

クラス・モジュールの継承リスト: Gem::DocManager < Gem::UserInteraction < Gem::DefaultUserInteraction < Object < Kernel < BasicObject

要約

Gem パッケージの RDoc, RI を生成するためのクラスです。

特異メソッド

定義 説明
configured_args -> Array

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

configured_args=(args)

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

load_rdoc

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

new(spec, rdoc_args = "") -> Gem::DocManager

自身を初期化します。

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 を実行します。

setup_rdoc

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

uninstall_doc

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

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined alert alert_error alert_warning ask ask_yes_no choose_from_list say terminate_interaction !~ <=> == === =~ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str trust untaint untrust untrusted? yield_self .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE