るりまサーチ (Ruby 3.1)

最速Rubyリファレンスマニュアル検索!
302件ヒット [1-100件を表示] (0.023秒)
トップページ > バージョン:3.1[x] > ライブラリ:rdoc[x]

モジュール

キーワード

検索結果

<< 1 2 3 ... > >>

RDoc (7.0)

rdoc ドキュメントを扱うためのモジュールです。

...rdoc ドキュメントを扱うためのモジュールです。...

RDoc::ATTR_MODIFIERS -> [String] (7.0)

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

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

RDoc::CLASS_MODIFIERS -> [String] (7.0)

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

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

RDoc::CONSTANT_MODIFIERS -> [String] (7.0)

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

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

RDoc::DOT_DOC_FILENAME -> ".document" (7.0)

rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。

...
rdoc
コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。...

絞り込み条件を変える

RDoc::Error (7.0)

ドキュメントの処理中にエラーがあった場合に発生します。

ドキュメントの処理中にエラーがあった場合に発生します。

RDoc::GENERAL_MODIFIERS -> [String] (7.0)

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

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

RDoc::METHOD_MODIFIERS -> [String] (7.0)

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

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

RDoc::VERSION -> String (7.0)

RDoc のバージョンを表す文字列を返します。

...
RDoc
のバージョンを表す文字列を返します。...

RDoc::Alias (4.0)

aliasされたメソッドを表現するクラスです。

aliasされたメソッドを表現するクラスです。


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

絞り込み条件を変える

RDoc::AnonClass (4.0)

匿名クラスを表現するクラスです。

匿名クラスを表現するクラスです。

現在は使用されていません。

RDoc::AnyMethod (4.0)

メソッドを表現するクラスの基本クラスです。

メソッドを表現するクラスの基本クラスです。

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

RDoc::Attr (4.0)

属性を表現するクラスです。

属性を表現するクラスです。

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

RDoc::ClassModule (4.0)

クラスやモジュールを表現するための基本クラスです。

クラスやモジュールを表現するための基本クラスです。

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

RDoc::CodeObject (4.0)

RDoc のコードツリーを表現するクラスの基本クラスです。

...RDoc のコードツリーを表現するクラスの基本クラスです。

以下は RDoc::CodeObject のサブクラスのツリーです。

//emlist{
* RDoc::Context
* RDoc::TopLevel
* RDoc::ClassModule
* RDoc::AnonClass
* RDoc::NormalClass
* RDoc::NormalModule
* RD...
...oc::SingleClass
* RDoc::AnyMethod
* RDoc::GhostMethod
* RDoc::MetaMethod
* RDoc::Alias
* RDoc::Attr
* RDoc::Constant
* RDoc::Require
* RDoc::Include
//}...

絞り込み条件を変える

RDoc::CodeObject#comment -> String (4.0)

自身のコメントを返します。

自身のコメントを返します。

RDoc::CodeObject#comment=(comment) (4.0)

自身のコメントを comment に設定します。

自身のコメントを comment に設定します。

ただし、comment が空文字列だった場合は何もしません。

@param comment コメントを文字列で指定します。

RDoc::CodeObject#document_children -> bool (4.0)

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを返します。

...自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか
どうかを返します。

@see RDoc::CodeObject#document_self...

RDoc::CodeObject#document_children=(val) (4.0)

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを設定します。

...トに含めるか
どうかを設定します。

:nodoc:、:stopdoc: を指定した時に false が設定されます。

@param val true を指定した場合、上記をドキュメントに含めます。

@see RDoc::CodeObject#document_self=,
RDoc
::CodeObject#remove_classes_and_modules...

RDoc::CodeObject#document_self -> bool (4.0)

自身をドキュメントに含めるかどうかを返します。

...自身をドキュメントに含めるかどうかを返します。

@see RDoc::CodeObject#document_children...

絞り込み条件を変える

RDoc::CodeObject#document_self=(val) (4.0)

自身をドキュメントに含めるかどうかを設定します。

...c: を指定した時に true が設定されます。
:nodoc:、:stopdoc: を指定した時に false が設定されます。

@param val true を指定した場合、自身をドキュメントに含めます。

@see RDoc::CodeObject#document_children=,
RDoc
::CodeObject#remove_methods_etc...

RDoc::CodeObject#documented? -> bool (4.0)

出力すべきドキュメントがあるかどうかを返します。

出力すべきドキュメントがあるかどうかを返します。

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

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

@see RDoc::CodeObject#parent...

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

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

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

@see RDoc::CodeObject#parent...

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

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

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

RDoc::CodeObject#remove_methods_etc -> () (4.0)

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

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

RDoc::CodeObject#section -> RDoc::Context::Section (4.0)

所属している section を返します。

所属している section を返します。

絞り込み条件を変える

RDoc::CodeObject#section=(val) (4.0)

所属する section を設定します。

...所属する section を設定します。

@param val RDoc::Context::Section オブジェクトを指定します。...

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

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

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

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

@see RDoc::CodeObject#end_d...

RDoc::CodeObject#stop_doc -> () (4.0)

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

...コメントを RDoc::CodeObject#start_doc を呼び出すま
での間、ドキュメントに含めません。

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

@see RDoc::CodeObject#star...

RDoc::CodeObject.new -> RDoc::CodeObject (4.0)

自身を初期化します。

自身を初期化します。

RDoc::Constant (4.0)

定数を表現するクラスです。

定数を表現するクラスです。

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

絞り込み条件を変える

RDoc::Context (4.0)

モジュール、クラス、メソッドなどの、rdoc/code_objects が定義す るクラスを管理するクラスです。

...モジュール、クラス、メソッドなどの、rdoc/code_objects が定義す
るクラスを管理するクラスです。...

RDoc::Context#<=>(other) -> -1 | 0 | 1 (4.0)

自身と other の full_name を比較した結果を返します。

自身と other の full_name を比較した結果を返します。

ソートのために使われます。

@param other 自身と比較したいオブジェクトを指定します。

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

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

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

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

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

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

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

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

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

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

...ュールを RDoc::NormalClass、
RDoc
::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

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

@param superclass 追加するクラスの親クラスを RDoc::NormalClass...

絞り込み条件を変える

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

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

...ュールを RDoc::NormalClass、
RDoc
::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

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

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

既に登録済みであった場合は、引数で指定した情報で内容を更新します。ただ
し、RDoc::CodeObject#done_documenting が true を返す場合、何も行
われません。...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@see RDoc::Context#add_class...

絞り込み条件を変える

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

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

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

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

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

array に 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_require...

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

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

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

RDoc::Context#current_section -> RDoc::Context::Section (4.0)

現在の section を返します。

現在の section を返します。

RDoc::Context#defined_in?(file) (4.0)

Return true if at least part of this thing was defined in file

Return true if at least part of this thing was defined in file

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

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

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

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

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

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

find a module at a higher scope

find a module at a higher scope

RDoc::Context#find_local_symbol(symbol) (4.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

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

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

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

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

絞り込み条件を変える

RDoc::Context#find_symbol(symbol, method=nil) (4.0)

Look up the given symbol. If method is non-nil, then we assume the symbol references a module that contains that method

Look up the given symbol. If method is non-nil, then we assume
the symbol references a module that contains that method

RDoc::Context#in_files (4.0)

Files this context is found in

Files this context is found in

RDoc::Context#includes -> [RDoc::Include] (4.0)

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

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

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

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

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

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

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

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

絞り込み条件を変える

RDoc::Context#method_list -> [RDoc::AnyMethod] (4.0)

追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列 を返します。

...追加された(RDoc::AnyMethod かそのサブクラスのオブジェクト)の配列
を返します。...

RDoc::Context#modules -> [RDoc::NormalModule] (4.0)

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

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

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

自身の名前を返します。

自身の名前を返します。

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

RDoc::Context#ongoing_visibility=(vis) (4.0)

Change the default visibility for new methods

Change the default visibility for new methods

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

Record the file that we happen to find it in

Record the file that we happen to find it in

絞り込み条件を変える

RDoc::Context#requires -> [RDoc::Require] (4.0)

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

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

RDoc::Context#sections -> RDoc::Context::Section (4.0)

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

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

RDoc::Context#set_current_section(title, comment) -> () (4.0)

Handle sections

Handle sections

RDoc::Context#set_visibility_for(methods, visibility, singleton = false) -> () (4.0)

methods で指定した RDoc::AnyMethod、RDoc::Attr の内、 singleton で指定した条件と一致するメソッドすべての可視性を visibility に設定します。

...methods で指定した RDoc::AnyMethod、RDoc::Attr の内、
singleton で指定した条件と一致するメソッドすべての可視性を visibility
に設定します。

@param methods RDoc::AnyMethod、RDoc::Attr オブジェクトの配
列を指定します。

@param vi...

RDoc::Context#toplevel -> RDoc::TopLevel (4.0)

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

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

絞り込み条件を変える

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

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

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

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

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

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

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

RDoc::Context#visibility -> :public | :protected | :private (4.0)

自身の可視性を Symbol で返します。

自身の可視性を Symbol で返します。

RDoc::Context.new -> RDoc::Context (4.0)

自身を初期化します。

自身を初期化します。

RDoc::Context::Section (4.0)

section に関する情報を保持するクラスです。

section に関する情報を保持するクラスです。

ドキュメント中で以下のように記述した情報を保持しています。

# :section: The title
# The body

絞り込み条件を変える

RDoc::Context::Section#==(other) -> bool (4.0)

自身と other のシーケンス番号を比較した結果を返します。

...自身と other のシーケンス番号を比較した結果を返します。

@param other RDoc::Context::Section オブジェクトを指定します。...

RDoc::Context::Section#comment -> String | nil (4.0)

section のコメントを返します。

section のコメントを返します。

RDoc::Context::Section#inspect -> String (4.0)

自身の情報を人間に読みやすい文字列にして返します。

自身の情報を人間に読みやすい文字列にして返します。

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

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

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

RDoc::Context::Section#sequence -> String (4.0)

section のシーケンス番号を文字列で返します。

section のシーケンス番号を文字列で返します。

リンクを作成する時に使われます。

絞り込み条件を変える

RDoc::Context::Section#set_comment(comment) -> () (4.0)

自身にコメントを設定します。

自身にコメントを設定します。

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

comment の最初の行に :section: を含んでいた場合、その行以降の文字列をコ
メントとして設定します。そうでない場合は comment すべてをコメントとして
設定します。

# ---------------------
# :section: The title
# The body
# ---------------------

RDoc::Context::Section#title -> String | nil (4.0)

section のタイトルを返します。

section のタイトルを返します。

RDoc::Context::Section.new(parent, title, comment) -> RDoc::Context::Section (4.0)

自身を初期化します。

...自身を初期化します。

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

@param title section のタイトルを文字列で指定します。

@param comment section のコメントを文字列で指定します。

また、section のシーケンス番号を新しく...

RDoc::Context::TYPES -> ["class", "instance"] (4.0)

メソッドの種類を文字列の配列で返します。

メソッドの種類を文字列の配列で返します。

RDoc::Context::VISIBILITIES -> [:public, :protected, :private] (4.0)

メソッドの可視性を Symbol の配列で返します。

メソッドの可視性を Symbol の配列で返します。

絞り込み条件を変える

RDoc::Generator (4.0)

RDoc が解析したソースコードを RDoc::CodeObject のツリーから その他の形式に出力するためのクラスです。

...RDoc が解析したソースコードを RDoc::CodeObject のツリーから
その他の形式に出力するためのクラスです。...

RDoc::Generator::Darkfish (4.0)

HTML を生成するためのクラスです。

HTML を生成するためのクラスです。

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

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

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

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

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

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

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

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

RDoc::Generator::Darkfish::GENERATOR_DIR -> String (4.0)

このファイルの親ディレクトリへのパスを表す文字列です。

このファイルの親ディレクトリへのパスを表す文字列です。

テンプレートなどのリソースを検索するのに内部で使用します。

絞り込み条件を変える

RDoc::Generator::Darkfish::VERSION -> &#39;3&#39; (4.0)

darkfish のバージョンです。

darkfish のバージョンです。

RDoc::Generator::JsonIndex (4.0)

他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ クスを生成するクラスです。

他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ
クスを生成するクラスです。

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

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

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

RDoc::Generator::JsonIndex.new(parent_generator, options) -> RDoc::Generator::JsonIndex (4.0)

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

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

@param parent_generator 親となるジェネレータオブジェクトを指定します。
RDoc
::Generator::JsonIndex#class_dir や
#file_dir を決めるのに使用します...
...
他のジェネレータとは異なり、RDoc::Store
オブジェクトではない点に注意してください。

@param options RDoc::Options オブジェクトを指定します。
parent_generator に渡されたものと同...

RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE -> String (4.0)

検索インデックスのパスを表す文字列です。

検索インデックスのパスを表す文字列です。

絞り込み条件を変える

<< 1 2 3 ... > >>