このマニュアルは既にメンテナンスが終了したバージョンの Ruby を対象としています。 最新版のマニュアルへ

Ruby 3.2 リファレンスマニュアル

class Rake::RDocTask

[edit]

要約

目次

特異メソッド
インスタンスメソッド

継承しているメソッド

Rake::Cloneableから継承しているメソッド

特異メソッド

new(name = :rdoc) {|pkg| ... } -> Rake::RDocTaskRuby 1.9.3 から[permalink][rdoc][edit]

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

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

[PARAM] name:
タスクの名前を指定します。

インスタンスメソッド

define -> selfRuby 1.9.3 から[permalink][rdoc][edit]

タスクを定義します。

external -> boolRuby 1.9.3 から[permalink][rdoc][edit]

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

external=(flag)Ruby 1.9.3 から[permalink][rdoc][edit]

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

[PARAM] flag:
真または偽を指定します。
main -> StringRuby 1.9.3 から[permalink][rdoc][edit]

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

main=(filename)Ruby 1.9.3 から[permalink][rdoc][edit]

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

name -> StringRuby 1.9.3 から[permalink][rdoc][edit]

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

name=(name)Ruby 1.9.3 から[permalink][rdoc][edit]

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

[PARAM] name:
タスクの名前を指定します。
option_list -> ArrayRuby 1.9.3 から[permalink][rdoc][edit]

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

option_string -> StringRuby 1.9.3 から[permalink][rdoc][edit]

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

options -> ArrayRuby 1.9.3 から[permalink][rdoc][edit]

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

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

options=(options)Ruby 1.9.3 から[permalink][rdoc][edit]

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

[PARAM] options:
rdoc コマンドに渡されるオプションを指定します。
quote(str) -> StringRuby 1.9.3 から[permalink][rdoc][edit]

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

[PARAM] str:
クオートする文字列を指定します。
rdoc_dir -> StringRuby 1.9.3 から[permalink][rdoc][edit]

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

rdoc_dir=(dir)Ruby 1.9.3 から[permalink][rdoc][edit]

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

rdoc_files -> Rake::FileListRuby 1.9.3 から[permalink][rdoc][edit]

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

rdoc_files=(filelist)Ruby 1.9.3 から[permalink][rdoc][edit]

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

[PARAM] filelist:
ファイルリストを指定します。
template -> StringRuby 1.9.3 から[permalink][rdoc][edit]

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

template=(template)Ruby 1.9.3 から[permalink][rdoc][edit]

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

[PARAM] template:
使用するテンプレートを指定します。
title -> StringRuby 1.9.3 から[permalink][rdoc][edit]

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

title=(title)Ruby 1.9.3 から[permalink][rdoc][edit]

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

[PARAM] title:
タイトルを指定します。