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

class Rake::RDocTask

クラスの継承リスト: Rake::RDocTask < Rake::TaskLib < Rake::Cloneable < Object < Kernel < BasicObject

要約

目次

特異メソッド

new

インスタンスメソッド

define external external= main main= name name= option_list option_string options options= quote rdoc_dir rdoc_dir= rdoc_files rdoc_files= template template= title title=

特異メソッド

new(name = :rdoc) {|pkg| ... } -> Rake::RDocTask[permalink][rdoc]

自身を初期化して RDoc タスクを定義します。

ブロックが与えられた場合は、自身をブロックパラメータとして ブロックを評価します。

[PARAM] name:

タスクの名前を指定します。

インスタンスメソッド

define -> self[permalink][rdoc]

タスクを定義します。

external -> bool[permalink][rdoc]

この値が真の場合は外部のシェル経由で rdoc コマンドを実行します。 デフォルトは偽です。

external=(flag)[permalink][rdoc]

外部のシェル経由で rdoc コマンドを実行するかどうかセットします。

[PARAM] flag:

真または偽を指定します。

main -> String[permalink][rdoc]

メインとして使用されるファイル名を返します。

main=(filename)[permalink][rdoc]

メインとして使用されるファイル名をセットします。

name -> String[permalink][rdoc]

タスクの名前を返します。デフォルトは rdoc です。

name=(name)[permalink][rdoc]

タスクの名前をセットします。

[PARAM] name:

タスクの名前を指定します。

option_list -> Array[permalink][rdoc]

rdoc コマンドに渡すオプションのリストを返します。

option_string -> String[permalink][rdoc]

rdoc コマンドに渡すオプションを文字列として返します。

options -> Array[permalink][rdoc]

rdoc コマンドに渡すオプションのリストを返します。

指定できるオプションは -o, --main, --title, -T 以外です。

options=(options)[permalink][rdoc]

rdoc コマンドに渡すオプションのリストをセットします。

[PARAM] options:

rdoc コマンドに渡されるオプションを指定します。

quote(str) -> String[permalink][rdoc]

Rake::RDocTask#external が真の場合は与えられた文字列をクオートします。

[PARAM] str:

クオートする文字列を指定します。

rdoc_dir -> String[permalink][rdoc]

作成した HTML ファイルを保存するディレクトリ名を返します。 デフォルトは html です。

rdoc_dir=(dir)[permalink][rdoc]

作成した HTML ファイルを保存するディレクトリ名をセットします。

rdoc_files -> Rake::FileList[permalink][rdoc]

RDoc の生成に使用するファイルリストを返します。 デフォルトは空です。

rdoc_files=(filelist)[permalink][rdoc]

RDoc の生成に使用するファイルリストをセットします。

[PARAM] filelist:

ファイルリストを指定します。

template -> String[permalink][rdoc]

使用するテンプレートを返します。 デフォルトは RDoc のデフォルトです。

template=(template)[permalink][rdoc]

使用するテンプレートをセットします。

[PARAM] template:

使用するテンプレートを指定します。

title -> String[permalink][rdoc]

RDoc のタイトルを返します。 デフォルト値はありません。

title=(title)[permalink][rdoc]

RDoc のタイトルをセットします。

[PARAM] title:

タイトルを指定します。