検索結果

Rake::RDocTask (69001.0)

• 2.3.0

• クラス

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

• 2.3.0

• 特異メソッド

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

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

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

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

• Rake::RDocTask

Rake::RDocTask#quote(str) -> String (63049.0)

• 2.3.0

• インスタンスメソッド

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

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

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

• Rake::RDocTask

Rake::RDocTask#define -> self (63001.0)

• 2.3.0

• インスタンスメソッド

タスクを定義します。

タスクを定義します。

• Rake::RDocTask

Rake::RDocTask#external -> bool (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

• Rake::RDocTask

絞り込み条件を変える

Rake::RDocTask#external=(flag) (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

@param flag 真または偽を指定します。

• Rake::RDocTask

Rake::RDocTask#main -> String (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

• Rake::RDocTask

Rake::RDocTask#main=(filename) (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

• Rake::RDocTask

Rake::RDocTask#name -> String (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

• Rake::RDocTask

Rake::RDocTask#name=(name) (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

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

• Rake::RDocTask

絞り込み条件を変える

Rake::RDocTask#option_list -> Array (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

• Rake::RDocTask

Rake::RDocTask#option_string -> String (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

• Rake::RDocTask

Rake::RDocTask#options -> Array (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

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

• Rake::RDocTask

Rake::RDocTask#options=(options) (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

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

• Rake::RDocTask

Rake::RDocTask#rdoc_dir -> String (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

• Rake::RDocTask

絞り込み条件を変える

Rake::RDocTask#rdoc_dir=(dir) (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

• Rake::RDocTask

Rake::RDocTask#rdoc_files -> Rake::FileList (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

• Rake::RDocTask

Rake::RDocTask#rdoc_files=(filelist) (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

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

• Rake::RDocTask

Rake::RDocTask#template -> String (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

• Rake::RDocTask

Rake::RDocTask#template=(template) (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

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

• Rake::RDocTask

絞り込み条件を変える

Rake::RDocTask#title -> String (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

• Rake::RDocTask

Rake::RDocTask#title=(title) (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

@param title タイトルを指定します。

• Rake::RDocTask

rake/rdoctask (37.0)

• 2.3.0

• ライブラリ

ドキュメントを作成するためのタスクを定義します。

ドキュメントを作成するためのタスクを定義します。

以下のタスクを定義します。

: rdoc
RDoc を作成します。
: clobber_rdoc
生成された RDoc のファイルを削除します。
このタスクは clobber タスクにも追加されます。
: rerdoc
既に存在する RDoc が古くなくても RDoc を作成します。


例:
Rake::RDocTask.new do |rd|
rd.main = "README.rdoc"
rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
...

• Rake::RDocTask
• rake
• rake/tasklib