Ruby 1.9.2 リファレンスマニュアル > ライブラリ一覧 > 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__ _dump class clone dclone display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_eval instance_exec instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? marshal_dump marshal_load method method_missing methods must_be must_be_close_to must_be_empty must_be_instance_of must_be_kind_of must_be_nil must_be_same_as must_be_within_epsilon must_equal must_include must_match must_raise must_respond_to must_send must_throw nil? pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods public_methods remove_instance_variable respond_to? respond_to_missing? singleton_class singleton_method_added singleton_method_removed singleton_method_undefined singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str to_yaml to_yaml_properties to_yaml_style trust untaint untrust untrusted? wont_be wont_be_close_to wont_be_empty wont_be_instance_of wont_be_kind_of wont_be_nil wont_be_same_as wont_be_within_epsilon wont_equal wont_include wont_match wont_respond_to