要約
RDoc のコードツリーを表現するクラスの基本クラスです。
以下は RDoc::CodeObject のサブクラスのツリーです。
* RDoc::Context * RDoc::TopLevel * RDoc::ClassModule * RDoc::AnonClass * RDoc::NormalClass * RDoc::NormalModule * RDoc::SingleClass * RDoc::AnyMethod * RDoc::GhostMethod * RDoc::MetaMethod * RDoc::Alias * RDoc::Attr * RDoc::Constant * RDoc::Require * RDoc::Include
目次
- 特異メソッド
- インスタンスメソッド
継承しているメソッド
- RDoc::Textから継承しているメソッド
特異メソッド
new -> RDoc::CodeObject
[permalink][rdoc][edit]-
自身を初期化します。
インスタンスメソッド
comment -> String
[permalink][rdoc][edit]-
自身のコメントを返します。
comment=(comment)
[permalink][rdoc][edit]-
自身のコメントを comment に設定します。
ただし、comment が空文字列だった場合は何もしません。
- [PARAM] comment:
- コメントを文字列で指定します。
document_children -> bool
[permalink][rdoc][edit]-
自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるかどうかを返します。
[SEE_ALSO] RDoc::CodeObject#document_self
document_children=(val)
[permalink][rdoc][edit]-
自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるかどうかを設定します。
:nodoc:、:stopdoc: を指定した時に false が設定されます。
- [PARAM] val:
- true を指定した場合、上記をドキュメントに含めます。
[SEE_ALSO] RDoc::CodeObject#document_self=, RDoc::CodeObject#remove_classes_and_modules
document_self -> bool
[permalink][rdoc][edit]-
自身をドキュメントに含めるかどうかを返します。
[SEE_ALSO] RDoc::CodeObject#document_children
document_self=(val)
[permalink][rdoc][edit]-
自身をドキュメントに含めるかどうかを設定します。
:doc: を指定した時に true が設定されます。 :nodoc:、:stopdoc: を指定した時に false が設定されます。
- [PARAM] val:
- true を指定した場合、自身をドキュメントに含めます。
[SEE_ALSO] RDoc::CodeObject#document_children=, RDoc::CodeObject#remove_methods_etc
documented? -> bool
[permalink][rdoc][edit]-
出力すべきドキュメントがあるかどうかを返します。
metadata -> Hash
[permalink][rdoc][edit]-
自身が持つメタデータ(他から任意の値を設定してもよい)を返します。
parent -> RDoc::CodeObject
[permalink][rdoc][edit]-
自身を所有する(変数や定数などの形で保持する)オブジェクトを返します。
parent=(val)
[permalink][rdoc][edit]-
自身を所有する(変数や定数などの形で保持する)オブジェクトを設定します。
- [PARAM] val:
- RDoc::CodeObject のサブクラスのオブジェクトを指定します。
parent_file_name -> String
[permalink][rdoc][edit]-
self.parent のファイル名を返します。
[SEE_ALSO] RDoc::CodeObject#parent
parent_name -> String
[permalink][rdoc][edit]-
self.parent の名前を返します。
[SEE_ALSO] RDoc::CodeObject#parent
remove_classes_and_modules -> ()
[permalink][rdoc][edit]-
何もしません。RDoc::CodeObject#document_children= に false を指定した時のコールバックとして呼び出されます。オーバーライドして使用します。
remove_methods_etc -> ()
[permalink][rdoc][edit]-
何もしません。RDoc::CodeObject#document_self= に false を指定した時のコールバックとして呼び出されます。オーバーライドして使用します。
section -> RDoc::Context::Section
[permalink][rdoc][edit]-
所属している section を返します。
section=(val)
[permalink][rdoc][edit]-
所属する section を設定します。
- [PARAM] val:
- RDoc::Context::Section オブジェクトを指定します。
start_doc -> ()
[permalink][rdoc][edit]-
以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまでの間、ドキュメントに含めます。
:startdoc: を見つけた時に呼び出されます。 RDoc::CodeObject#document_self と RDoc::CodeObject#document_children を true に設定します。
[SEE_ALSO] RDoc::CodeObject#end_doc
stop_doc -> ()
[permalink][rdoc][edit]-
以降に解析したコメントを RDoc::CodeObject#start_doc を呼び出すまでの間、ドキュメントに含めません。
:stopdoc: を見つけた時に呼び出されます。 RDoc::CodeObject#document_self と RDoc::CodeObject#document_children を false に設定します。
[SEE_ALSO] RDoc::CodeObject#start_doc