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

class Rake::RDocTask

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

Abstract

特異メソッド

new(name = :rdoc) {|pkg| ... }

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

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

[PARAM] name:

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

インスタンスメソッド

define -> self

タスクを定義します。

external -> bool

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

external=(flag)

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

[PARAM] flag:

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

main -> String

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

main=(filename)

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

name -> String

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

name=(name)

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

[PARAM] name:

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

option_list -> Array

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

option_string -> String

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

options -> Array

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

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

options=(options)

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

[PARAM] options:

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

quote(str) -> String

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

[PARAM] str:

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

rdoc_dir -> String

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

rdoc_dir=(dir)

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

rdoc_files -> Rake::FileList

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

rdoc_files=(filelist)

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

[PARAM] filelist:

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

template -> String

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

template=(template)

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

[PARAM] template:

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

title -> String

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

title=(title)

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

[PARAM] title:

タイトルを指定します。