検索結果

RDoc::CodeObject (72019.0)

• 2.4.0

• クラス

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

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

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

//emlist{
* RDoc::Context
* RDoc::TopLevel
* RDoc::ClassModule
* RDoc::AnonClass
* RDoc::NormalClass
* RDoc::NormalModule
* RDoc::SingleClass
* RDoc::AnyMethod
* RDoc::GhostMethod
* RDoc::MetaMethod
...

• RDoc::CodeObject

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

• 2.4.0

• インスタンスメソッド

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

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

• RDoc::CodeObject

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

• 2.4.0

• 特異メソッド

自身を初期化します。

自身を初期化します。

• RDoc::CodeObject

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

• 2.4.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::CodeObject

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

• 2.4.0

• インスタンスメソッド

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

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

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

@see RDoc::CodeObject#start_doc

• RDoc::CodeObject

絞り込み条件を変える

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

• 2.4.0

• インスタンスメソッド

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

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

• RDoc::CodeObject

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

• 2.4.0

• インスタンスメソッド

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

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

• RDoc::CodeObject

rdoc/code_object (18049.0)

• 2.4.0

• ライブラリ

RDoc::CodeObject を定義するサブライブラリです。

RDoc::CodeObject を定義するサブライブラリです。

• RDoc::CodeObject

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

• 2.4.0

• インスタンスメソッド

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

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

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

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

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

• RDoc::CodeObject

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

• 2.4.0

• インスタンスメソッド

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

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

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

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

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

• RDoc::CodeObject

絞り込み条件を変える

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

• 2.4.0

• インスタンスメソッド

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

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

@see RDoc::CodeObject#document_self

• RDoc::CodeObject

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

• 2.4.0

• インスタンスメソッド

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

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

@see RDoc::CodeObject#document_children

• RDoc::CodeObject

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

• 2.4.0

• インスタンスメソッド

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

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

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

• RDoc::CodeObject

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

• 2.4.0

• インスタンスメソッド

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

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

@see RDoc::CodeObject#parent

• RDoc::CodeObject

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

• 2.4.0

• インスタンスメソッド

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

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

@see RDoc::CodeObject#parent

• RDoc::CodeObject

絞り込み条件を変える

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

• 2.4.0

• インスタンスメソッド

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

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

• RDoc::CodeObject

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

• 2.4.0

• インスタンスメソッド

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

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

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

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

• RDoc::CodeObject

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

• 2.4.0

• インスタンスメソッド

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

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

• RDoc::CodeObject

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

• 2.4.0

• インスタンスメソッド

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

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

• RDoc::CodeObject

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

• 2.4.0

• インスタンスメソッド

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

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

• RDoc::CodeObject

絞り込み条件を変える

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

• 2.4.0

• インスタンスメソッド

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

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

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

• RDoc::CodeObject
• RDoc::Context::Section