るりまサーチ (Ruby 3.2)

最速Rubyリファレンスマニュアル検索！
192件ヒット [1-100件を表示] （0.139秒）
トップページ > クエリ:a[x] > クエリ:rdoc[x] > 種類:インスタンスメソッド[x] > バージョン:3.2[x]

別のキーワード

  1. _builtin to_a
  2. matrix to_a
  3. to_a
  4. dbm to_a
  5. argf.class to_a

ライブラリ

クラス

モジュール

キーワード

検索結果

先頭5件

  1. RDoc::Options#static_path -> [String]
  2. RDoc::Options#static_path=(vals)
  3. RDoc::Markdown#parse(markdown) -> RDoc::Markup::Document
  4. Gem::Specification#has_rdoc? -> bool
  5. Gem::Specification#has_rdoc -> bool
<< 1 2 > >>

RDoc::Options#static_path -> [String] (45604.0)

  • インスタンスメソッド

コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し ます。

コマンドライン引数の --copy-files オプションで指定したパスの一覧を返し
ます。

RDoc::Options#static_path=(vals) (45604.0)

  • インスタンスメソッド

コマンドライン引数の --copy-files オプションと同様の指定を行います。

コマンドライン引数の --copy-files オプションと同様の指定を行います。

@param vals パスを文字列の配列で指定します。

RDoc::Markdown#parse(markdown) -> RDoc::Markup::Document (37255.0)

  • インスタンスメソッド

引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。

引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。

@param markdown 解析の対象になるドキュメントを文字列で指定します。

Gem::Specification#has_rdoc? -> bool (36721.0)

  • インスタンスメソッド

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

@see Gem::Specification#has_rdoc

Gem::Specification#has_rdoc -> bool (36703.0)

  • インスタンスメソッド

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

絞り込み条件を変える

Gem::Specification#extra_rdoc_files=(paths) (36673.0)

  • インスタンスメソッド

RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。

RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。

@param paths RDoc でドキュメントを作成する際に使用する特別なファイルのリストを指定します。

Gem::DocManager#generate_rdoc (36655.0)

  • インスタンスメソッド

自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。

自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。

Gem::DocManager#install_rdoc (36655.0)

  • インスタンスメソッド

RDoc を生成してインストールします。

RDoc を生成してインストールします。

Gem::DocManager#rdoc_installed? -> bool (36655.0)

  • インスタンスメソッド

RDoc がインストール済みの場合は、真を返します。 そうでない場合は偽を返します。

RDoc がインストール済みの場合は、真を返します。
そうでない場合は偽を返します。

Gem::Specification#extra_rdoc_files -> [String] (36655.0)

  • インスタンスメソッド

RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。

RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。

絞り込み条件を変える

Gem::Specification#has_rdoc=(flag) (36655.0)

  • インスタンスメソッド

RDoc を生成するかどうかをセットします。デフォルトは偽です。

RDoc を生成するかどうかをセットします。デフォルトは偽です。

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

  • インスタンスメソッド

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

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

RDoc::Parser::Markdown#scan -> RDoc::TopLevel (36625.0)

  • インスタンスメソッド

Markdown 形式で記述されたファイルを解析します。

Markdown 形式で記述されたファイルを解析します。

@return RDoc::TopLevel オブジェクトを返します。

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

  • インスタンスメソッド

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

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

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

RDoc::Generator::JsonIndex#generate -> () (36352.0)

  • インスタンスメソッド

解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出 力します。

解析した情報を RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE に出
力します。

絞り込み条件を変える

RDoc::Parser#parse_files_matching(regexp) -> () (36340.0)

  • インスタンスメソッド

regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、 自身を登録します。

regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、
自身を登録します。

@param regexp 正規表現を指定します。

新しいパーサを作成する時に使用します。

例:

class RDoc::Parser::Xyz < RDoc::Parser
parse_files_matching /\.xyz$/
...
end

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

  • インスタンスメソッド

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

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

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

  • インスタンスメソッド

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

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

RDoc::Generator::Darkfish#generate -> () (36304.0)

  • インスタンスメソッド

解析した情報を HTML ファイルや検索用のインデックスに出力します。

解析した情報を HTML ファイルや検索用のインデックスに出力します。

RDoc::Generator::RI#generate -> () (36304.0)

  • インスタンスメソッド

解析した情報を ri コマンドから読めるようにファイルに出力します。

解析した情報を ri コマンドから読めるようにファイルに出力します。

絞り込み条件を変える

RDoc::TopLevel#find_local_symbol(name) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule | RDoc::AnyMethod | RDoc::Alias | RDoc::Attr | RDoc::Constant (30325.0)

  • インスタンスメソッド

クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。

クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。

RDoc::Context#classes -> [RDoc::SingleClass | RDoc::NormalClass] (28510.0)

  • インスタンスメソッド

追加されたクラスの配列を返します。

追加されたクラスの配列を返します。

RDoc::Context#add_class_or_module(collection, class_type, name, superclass = nil) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule (28303.0)

  • インスタンスメソッド

collection に name で指定したクラス、モジュールを追加します。

collection に name で指定したクラス、モジュールを追加します。

@param collection クラス、モジュールを追加する先を Hash オブジェ
クトで指定します。

@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

@param name クラス名を文字列で指定します。

@param su...

RDoc::TopLevel#add_class_or_module(collection, class_type, name, superclass) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule (28303.0)

  • インスタンスメソッド

collection に name で指定したクラス、モジュールを追加します。

collection に name で指定したクラス、モジュールを追加します。

@param collection クラス、モジュールを追加する先を Hash オブジェ
クトで指定します。

@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

@param name クラス名を文字列で指定します。

@param su...

RDoc::Context#add_module(class_type, name) -> RDoc::NormalModule | RDoc::SingleClass | RDoc::NormalClass (28285.0)

  • インスタンスメソッド

引数で指定したモジュールを追加します。

引数で指定したモジュールを追加します。

ただし、クラスとして既に同名のものが登録されていた場合は、何もせずにそ
のクラスを返します。

@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

@param name クラス名を文字列で指定します。

@see RDoc::Context#add_class

絞り込み条件を変える

RDoc::Text#parse(text) -> RDoc::Markup::Document | Array (28273.0)

  • インスタンスメソッド

引数から RDoc::Text#normalize_comment でスペースや改行文字などを削 除した後に解析を行います。

引数から RDoc::Text#normalize_comment でスペースや改行文字などを削
除した後に解析を行います。

@param text 文字列を指定します。

@see RDoc::Text#normalize_comment

RDoc::Context#each_classmodule {|m| ... } -> [RDoc::SingleClass | RDoc::NormalClass | RDoc::NormalModule] (28249.0)

  • インスタンスメソッド

追加されたクラス、モジュールに対してブロックを評価します。

追加されたクラス、モジュールに対してブロックを評価します。

@see RDoc::Context#classes, RDoc::Context#modules

RDoc::Context#find_enclosing_module_named(name) -> RDoc::NormalModule | nil (28003.0)

  • インスタンスメソッド

find a module at a higher scope

find a module at a higher scope

RDoc::Context#add_class(class_type, name, superclass) -> RDoc::SingleClass | RDoc::NormalClass (27982.0)

  • インスタンスメソッド

引数で指定したクラスを追加します。

引数で指定したクラスを追加します。

@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

@param name クラス名を文字列で指定します。

@param superclass 追加するクラスの親クラスを RDoc::NormalClass オ
ブジェクトで指定します。

RDoc::Context#aliases -> [RDoc::Alias] (27955.0)

  • インスタンスメソッド

追加された RDoc::Alias の配列を返します。

追加された RDoc::Alias の配列を返します。

絞り込み条件を変える

RDoc::Context#attributes -> [RDoc::Attr] (27955.0)

  • インスタンスメソッド

追加された RDoc::Attr の配列を返します。

追加された RDoc::Attr の配列を返します。

RDoc::Context#constants -> [RDoc::Constant] (27955.0)

  • インスタンスメソッド

追加された RDoc::Constant の配列を返します。

追加された RDoc::Constant の配列を返します。

RDoc::Context#find_module_named(name) -> RDoc::NormalModule | nil (27955.0)

  • インスタンスメソッド

追加された RDoc::NormalModule から引数で指定した名前のモジュール を検索します。見つからなかった場合は nil を返します。

追加された RDoc::NormalModule から引数で指定した名前のモジュール
を検索します。見つからなかった場合は nil を返します。

@param name モジュールの名前を文字列で指定します。

RDoc::Markup#attribute_manager -> RDoc::AttributeManager (27955.0)

  • インスタンスメソッド

自身の RDoc::AttributeManager オブジェクトを返します。

自身の RDoc::AttributeManager オブジェクトを返します。

RDoc::TopLevel#find_module_named(name) -> RDoc::NormalModule (27955.0)

  • インスタンスメソッド

RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。 見つからなかった場合は nil を返します。

RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。
見つからなかった場合は nil を返します。

@param name モジュール名を文字列で指定します。

絞り込み条件を変える

Gem::DocManager#run_rdoc(*args) (27691.0)

  • インスタンスメソッド

与えられた引数を使用して RDoc を実行します。

与えられた引数を使用して RDoc を実行します。

@param args RDoc に与える引数を指定します。

@raise Gem::FilePermissionError RDoc でドキュメント生成中にファイルにアクセス出来なかった場合に発生します。

RDoc::Generator::Darkfish#initialize(store, options) -> RDoc::Generator::Darkfish (27691.0)

  • インスタンスメソッド

RDoc::Generator::Darkfish オブジェクトを初期化します。

RDoc::Generator::Darkfish オブジェクトを初期化します。

@param store RDoc::Store オブジェクトを指定します。

@param options RDoc::Options オブジェクトを指定します。

RDoc::Generator::RI#initialize(store, options) -> RDoc::Generator::RI (27691.0)

  • インスタンスメソッド

RDoc::Generator::RI オブジェクトを初期化します。

RDoc::Generator::RI オブジェクトを初期化します。

@param store RDoc::Store オブジェクトを指定します。

@param options RDoc::Options オブジェクトを指定します。

RDoc::Context#add_alias(an_alias) -> RDoc::Alias (27673.0)

  • インスタンスメソッド

引数で指定した RDoc::Alias オブジェクトを追加します。

引数で指定した RDoc::Alias オブジェクトを追加します。

@param an_alias RDoc::Alias オブジェクトを指定します。

RDoc::Parser::Simple#scan -> RDoc::TopLevel (27673.0)

  • インスタンスメソッド

自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し ます。

自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し
ます。

@return RDoc::TopLevel オブジェクトを返します。

絞り込み条件を変える

RDoc::Context#each_attribute {|a| ... } -> [RDoc::Attr] (27658.0)

  • インスタンスメソッド

追加された RDoc::Attr に対してブロックを評価します。

追加された RDoc::Attr に対してブロックを評価します。

RDoc::Context#each_constant {|c| ... } -> [RDoc::Constant] (27655.0)

  • インスタンスメソッド

追加された RDoc::Constant に対してブロックを評価します。

追加された RDoc::Constant に対してブロックを評価します。

RDoc::Context#each_method {|m| ... } -> [RDoc::AnyMethod] (27655.0)

  • インスタンスメソッド

追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト) に対してブロックを評価します。

追加されたメソッド(RDoc::AnyMethod かそのサブクラスのオブジェクト)
に対してブロックを評価します。

RDoc::Context#unmatched_alias_lists -> {String => RDoc::Alias} (27655.0)

  • インスタンスメソッド

メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を返します。

メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を返します。

RDoc::Context::Section#parent -> RDoc::Context (27655.0)

  • インスタンスメソッド

自身が所属する RDoc::Context オブジェクトを返します。

自身が所属する RDoc::Context オブジェクトを返します。

絞り込み条件を変える

RDoc::Parser::C#scan -> RDoc::TopLevel (27625.0)

  • インスタンスメソッド

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析します。

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析します。

@return RDoc::TopLevel オブジェクトを返します。

RDoc::Parser::ChangeLog#scan -> RDoc::TopLevel (27625.0)

  • インスタンスメソッド

ChangeLog ファイルを解析します。

ChangeLog ファイルを解析します。

@return RDoc::TopLevel オブジェクトを返します。

RDoc::Parser::RD#scan -> RDoc::TopLevel (27625.0)

  • インスタンスメソッド

RD 形式で記述されたファイルを解析します。

RD 形式で記述されたファイルを解析します。

@return RDoc::TopLevel オブジェクトを返します。

RDoc::Parser::Ruby#scan -> RDoc::TopLevel (27625.0)

  • インスタンスメソッド

Ruby のソースコードからクラス/モジュールのドキュメントを解析します。

Ruby のソースコードからクラス/モジュールのドキュメントを解析します。

@return RDoc::TopLevel オブジェクトを返します。

RDoc::CodeObject#parent -> RDoc::CodeObject (27607.0)

  • インスタンスメソッド

自身を所有する(変数や定数などの形で保持する)オブジェクトを返します。

自身を所有する(変数や定数などの形で保持する)オブジェクトを返します。

絞り込み条件を変える

RDoc::Options#generator -> Generator (27604.0)

  • インスタンスメソッド

コマンドライン引数の --fmt オプションで指定した文字列に応じた Generator を返します。

コマンドライン引数の --fmt オプションで指定した文字列に応じた
Generator を返します。

指定しなかった場合は、HTML に対応する Generator を返します。

RDoc::Options#hyperlink_all=(val) (27604.0)

  • インスタンスメソッド

val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ ンと同様の指定を行います。

val に true を指定した場合、コマンドライン引数の --hyperlink-all オプショ
ンと同様の指定を行います。

@param val --hyperlink-all オプションと同じ指定を行う場合は true、そう
でない場合は false を指定します。

RDoc::Options#option_parser -> OptionParser | nil (27604.0)

  • インスタンスメソッド

コマンドライン引数の解析のための OptionParser オブジェクトを返し ます。

コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。

RDoc::Options#parse(argv) -> () (27604.0)

  • インスタンスメソッド

コマンドライン引数を解析します。

コマンドライン引数を解析します。

@param argv コマンドライン引数を文字列の配列で指定します。


また、以下のような指定をした場合は標準エラーに出力を行い、終了コード 1
でプログラムを終了します。

* --extension オプションに拡張子を 2 つ指定しなかった場合
* --extension オプションに new=old を指定した時に old を扱えるフォーマッ
タがない場合
* --fmt オプションに扱えない出力を指定した場合

RDoc::Options#show_all=(val) (27604.0)

  • インスタンスメソッド

val に true を指定した場合、コマンドライン引数の --all オプションと同様 の指定を行います。

val に true を指定した場合、コマンドライン引数の --all オプションと同様
の指定を行います。

@param val --all オプションと同じ指定を行う場合は true、そうでない場合
は false を指定します。

絞り込み条件を変える

RDoc::TopLevel#file_stat -> File::Stat (27604.0)

  • インスタンスメソッド

自身が管理するファイルに関する File::Stat オブジェクトを返します。

自身が管理するファイルに関する File::Stat オブジェクトを返します。

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

  • インスタンスメソッド

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

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

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

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

  • インスタンスメソッド

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

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

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

RDoc::Context#add_require(a_require) -> () (27439.0)

  • インスタンスメソッド

自身が所属する RDoc::TopLevel オブジェクトに引数で指定した RDoc::Require を追加します。

自身が所属する RDoc::TopLevel オブジェクトに引数で指定した
RDoc::Require を追加します。

@param a_require RDoc::Require オブジェクトを指定します。

RDoc::Context#add_to(array, thing) -> () (27430.0)

  • インスタンスメソッド

array に thing を追加します。

array に thing を追加します。

@param array 配列を指定します。

@param thing 追加する要素を指定します。

RDoc::Context#add_alias などで使われています。ライブラリ内部で使
用します。

@see RDoc::Context#add_alias, RDoc::Context#add_attribute,
RDoc::Context#add_constant, RDoc::Context#add_include,
RDoc::Context#add_method, RDoc::Context#add_requ...

絞り込み条件を変える

RDoc::CodeObject#start_doc -> () (27406.0)

  • インスタンスメソッド

以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまで の間、ドキュメントに含めます。

以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまで
の間、ドキュメントに含めます。

:startdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を true に設定します。

@see RDoc::CodeObject#end_doc

RDoc::Markup#add_special(pattern, name) -> () (27394.0)

  • インスタンスメソッド

pattern で指定した正規表現にマッチする文字列をフォーマットの対象にしま す。

pattern で指定した正規表現にマッチする文字列をフォーマットの対象にしま
す。

例えば WikiWord のような、SM::SimpleMarkup#add_word_pair、
SM::SimpleMarkup#add_html でフォーマットできないものに対して使用
します。

@param pattern 正規表現を指定します。

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

例:

require 'rdoc/markup/simple_markup'
require '...

RDoc::Context#add_method(a_method) -> () (27391.0)

  • インスタンスメソッド

引数で指定した RDoc::AnyMethod オブジェクトを追加します。

引数で指定した RDoc::AnyMethod オブジェクトを追加します。

@param a_method RDoc::AnyMethod オブジェクトかそのサブクラスのオ
ブジェクトを指定します。

RDoc::Text#normalize_comment(text) -> String (27376.0)

  • インスタンスメソッド

引数から行頭のスペースや改行文字などを削除します。

引数から行頭のスペースや改行文字などを削除します。

詳しくは [SEE ALSO] の各メソッドを参照してください。

@param text 文字列を指定します。

@see RDoc::Text#strip_hashes, RDoc::Text#expand_tabs,
RDoc::Text#flush_left, RDoc::Text#strip_newlines

Gem::DocManager#setup_rdoc (27373.0)

  • インスタンスメソッド

RDoc を実行するための準備を行います。

RDoc を実行するための準備を行います。

@raise Gem::FilePermissionError RDoc を保存するディレクトリにアクセスする権限がない場合に発生します。

絞り込み条件を変える

Gem::Specification#rdoc_options=(options) (27373.0)

  • インスタンスメソッド

API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。

API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。

@param options API ドキュメントを生成するときに rdoc コマンドに与えるオプションを指定します。

RDoc::Context#add_attribute(an_attribute) -> () (27370.0)

  • インスタンスメソッド

引数で指定した RDoc::Attr オブジェクトを追加します。

引数で指定した RDoc::Attr オブジェクトを追加します。

@param an_attribute RDoc::Attr オブジェクトを指定します。

RDoc::Context#add_constant(const) -> () (27370.0)

  • インスタンスメソッド

引数で指定した RDoc::Constant オブジェクトを追加します。

引数で指定した RDoc::Constant オブジェクトを追加します。

@param const RDoc::Constant オブジェクトを指定します。

RDoc::Context#add_include(an_include) -> () (27370.0)

  • インスタンスメソッド

引数で指定した RDoc::Include オブジェクトを追加します。

引数で指定した RDoc::Include オブジェクトを追加します。

@param an_include RDoc::Include オブジェクトを指定します。

RDoc::Context#unmatched_alias_lists=(val) (27370.0)

  • インスタンスメソッド

メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を設定します。

メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を設定します。

@param val 旧メソッド名がキー、RDoc::Alias が値の Hash を指
定します。

絞り込み条件を変える

RDoc::Markup::Formatter#add_tag(name, start, stop) -> () (27358.0)

  • インスタンスメソッド

name で登録された規則で取得された文字列を start と stop で囲むように指 定します。

name で登録された規則で取得された文字列を start と stop で囲むように指
定します。

@param name RDoc::Markup::ToHtml などのフォーマッタに識別させる時
の名前を Symbol で指定します。

@param start 開始の記号を文字列で指定します。

@param stop 終了の記号を文字列で指定します。

例:

require 'rdoc/markup/to_html'

# :STRIKE のフォーマットを <strike> 〜 </strike> に指定。
h = RDoc::Markup:...

Gem::Specification#rdoc_options -> [String] (27355.0)

  • インスタンスメソッド

API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。

API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。

RDoc::CodeObject#remove_classes_and_modules -> () (27352.0)

  • インスタンスメソッド

何もしません。RDoc::CodeObject#document_children= に false を指定 した時のコールバックとして呼び出されます。オーバーライドして使用します。

何もしません。RDoc::CodeObject#document_children= に false を指定
した時のコールバックとして呼び出されます。オーバーライドして使用します。

RDoc::Context#find_local_symbol(symbol) (27352.0)

  • インスタンスメソッド

Finds a method, constant, attribute, module or files named +symbol+ in this context

Finds a method, constant, attribute, module or files named +symbol+ in
this context

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

  • インスタンスメソッド

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

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

絞り込み条件を変える

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

  • インスタンスメソッド

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

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

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

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

  • インスタンスメソッド

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

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

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

  • インスタンスメソッド

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

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

RDoc::Markup#add_html(tag, name) -> () (27340.0)

  • インスタンスメソッド

tag で指定したタグをフォーマットの対象にします。

tag で指定したタグをフォーマットの対象にします。

@param tag 追加するタグ名を文字列で指定します。大文字、小文字のど
ちらを指定しても同一のものとして扱われます。

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_ht...

RDoc::Markup#add_word_pair(start, stop, name) -> () (27340.0)

  • インスタンスメソッド

start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま す。

start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま
す。

@param start 開始となる文字列を指定します。

@param stop 終了となる文字列を指定します。start と同じ文字列にする事も
可能です。

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

@raise RuntimeError start に "<" で始まる文字列を指定した場合に発生します。

例:

require 'rdoc/markup/...

絞り込み条件を変える

Gem::InstallUpdateOptions#install_update_defaults_str -> String (27322.0)

  • インスタンスメソッド

Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。

Gem コマンドの install サブコマンドに渡されるデフォルトのオプションを返します。

デフォルトのオプションは以下の通りです。
--rdoc --no-force --no-test --wrappers

RDoc::CodeObject#parent=(val) (27322.0)

  • インスタンスメソッド

自身を所有する(変数や定数などの形で保持する)オブジェクトを設定します。

自身を所有する(変数や定数などの形で保持する)オブジェクトを設定します。

@param val RDoc::CodeObject のサブクラスのオブジェクトを指定しま
す。

RDoc::CodeObject#parent_file_name -> String (27322.0)

  • インスタンスメソッド

self.parent のファイル名を返します。

self.parent のファイル名を返します。

@see RDoc::CodeObject#parent

RDoc::CodeObject#parent_name -> String (27322.0)

  • インスタンスメソッド

self.parent の名前を返します。

self.parent の名前を返します。

@see RDoc::CodeObject#parent

RDoc::Options#markup -> String (27322.0)

  • インスタンスメソッド

コマンドライン引数の --markup オプションで指定したフォーマットを返しま す。

コマンドライン引数の --markup オプションで指定したフォーマットを返しま
す。

指定されていない場合は 'rdoc' を返します。

絞り込み条件を変える

RDoc::CodeObject#metadata -> Hash (27304.0)

  • インスタンスメソッド

自身が持つメタデータ(他から任意の値を設定してもよい)を返します。

自身が持つメタデータ(他から任意の値を設定してもよい)を返します。

RDoc::Context#initialize_classes_and_modules -> () (27304.0)

  • インスタンスメソッド

追加されたクラスやモジュールをクリアします。

追加されたクラスやモジュールをクリアします。

RDoc::Context#initialize_methods_etc -> () (27304.0)

  • インスタンスメソッド

追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて いないものを含む)、require されたファイル、include されたファイル、定数 をクリアします。

追加されたメソッド、属性、alias されたメソッド(メソッド名の対応が取れて
いないものを含む)、require されたファイル、include されたファイル、定数
をクリアします。

RDoc::Context#name -> String (27304.0)

  • インスタンスメソッド

自身の名前を返します。

自身の名前を返します。

サブクラスによっては、メソッド名やクラス名を意味します。

RDoc::Context#record_location(toplevel) (27304.0)

  • インスタンスメソッド

Record the file that we happen to find it in

Record the file that we happen to find it in

絞り込み条件を変える

RDoc::Markdown#break_on_newline -> bool (27304.0)

  • インスタンスメソッド

改行を保持した状態で出力するかどうかを返します。

改行を保持した状態で出力するかどうかを返します。

デフォルトでは false を返します。

RDoc::Markdown#break_on_newline=(val) (27304.0)

  • インスタンスメソッド

改行を保持した状態で出力するかどうかを設定します。

改行を保持した状態で出力するかどうかを設定します。

RDoc::Options#all_one_file -> bool (27304.0)

  • インスタンスメソッド

コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ ションに xml 指定した場合に true を返します。そうでない場合は false を 返します。

コマンドライン引数の --one-file を指定していた場合、もしくは --fmt オプ
ションに xml 指定した場合に true を返します。そうでない場合は false を
返します。

RDoc::Options#charset -> String (27304.0)

  • インスタンスメソッド

コマンドライン引数の --charset オプションで指定した文字コードを文字列で 返します。

コマンドライン引数の --charset オプションで指定した文字コードを文字列で
返します。

指定しなかった場合は、$KCODE に応じた値になります。

RDoc::Options#coverage_report -> Integer | false (27304.0)

  • インスタンスメソッド

コマンドライン引数の --coverage-report オプションを指定していた場合、指 定した数値を返します。

コマンドライン引数の --coverage-report オプションを指定していた場合、指
定した数値を返します。

指定しなかった場合は false を返します。

絞り込み条件を変える

RDoc::Options#coverage_report=(val) (27304.0)

  • インスタンスメソッド

コマンドライン引数の --coverage-report オプションと同様の指定を行います。

コマンドライン引数の --coverage-report オプションと同様の指定を行います。

@param val 数値オブジェクトか false を指定します。

RDoc::Options#diagram -> bool (27304.0)

  • インスタンスメソッド

コマンドライン引数の --diagram オプションを指定していた場合、true を返 します。そうでない場合は false を返します。

コマンドライン引数の --diagram オプションを指定していた場合、true を返
します。そうでない場合は false を返します。

RDoc::Options#extra_accessor_flags -> {String => String} (27304.0)

  • インスタンスメソッド

コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア クセサの種類が値のハッシュを返します。

コマンドライン引数の --accessor オプションで指定したアクセサがキー、ア
クセサの種類が値のハッシュを返します。

値は r、w、rw のいずれかです。それぞれ attr_reader、attr_writer、
attr_accessor に対応します。

RDoc::Options#extra_accessors -> Regexp | nil (27304.0)

  • インスタンスメソッド

コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ てにマッチする正規表現オブジェクトを返します。

コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ
てにマッチする正規表現オブジェクトを返します。

指定しなかった場合は nil を返します。

RDoc::Options#finish_page_dir (27304.0)

  • インスタンスメソッド

ライブラリ内部で使用します。

ライブラリ内部で使用します。

絞り込み条件を変える

<< 1 2 > >>

検索対象のドキュメントは るりまプロジェクト の成果物です。

検索エンジンは Groonga 14.1.2 を使っています。

Groongaは Rroonga 12.1.0 経由で利用しています。

Powered by Ruby 3.1.2.

るりまサーチのリポジトリ は GitHub 上にあります。