Ruby 2.3.0 リファレンスマニュアル > ライブラリ一覧 > rake/rdoctaskライブラリ > Rake::RDocTaskクラス

class Rake::RDocTask

クラス・モジュールの継承リスト: Rake::RDocTask < Rake::TaskLib < Rake::Cloneable < Object < Kernel < BasicObject

要約

特異メソッド

定義	説明
`new(name = :rdoc) {\|pkg\| ... } -> Rake::RDocTask`	自身を初期化して RDoc タスクを定義します。

インスタンスメソッド

定義	説明
`define -> self`	タスクを定義します。
`external -> bool`	この値が真の場合は外部のシェル経由で rdoc コマンドを実行します。デフォルトは偽です。
`external=(flag)`	外部のシェル経由で rdoc コマンドを実行するかどうかセットします。
`main -> String`	メインとして使用されるファイル名を返します。
`main=(filename)`	メインとして使用されるファイル名をセットします。
`name -> String`	タスクの名前を返します。デフォルトは rdoc です。
`name=(name)`	タスクの名前をセットします。
`option_list -> Array`	rdoc コマンドに渡すオプションのリストを返します。
`option_string -> String`	rdoc コマンドに渡すオプションを文字列として返します。
`options -> Array`	rdoc コマンドに渡すオプションのリストを返します。
`options=(options)`	rdoc コマンドに渡すオプションのリストをセットします。
`quote(str) -> String`	Rake::RDocTask#external が真の場合は与えられた文字列をクオートします。
`rdoc_dir -> String`	作成した HTML ファイルを保存するディレクトリ名を返します。デフォルトは html です。
`rdoc_dir=(dir)`	作成した HTML ファイルを保存するディレクトリ名をセットします。
`rdoc_files -> Rake::FileList`	RDoc の生成に使用するファイルリストを返します。デフォルトは空です。
`rdoc_files=(filelist)`	RDoc の生成に使用するファイルリストをセットします。
`template -> String`	使用するテンプレートを返します。デフォルトは RDoc のデフォルトです。
`template=(template)`	使用するテンプレートをセットします。
`title -> String`	RDoc のタイトルを返します。デフォルト値はありません。
`title=(title)`	RDoc のタイトルをセットします。

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined !~ <=> == === =~ _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? .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