Ruby 2.3.0 リファレンスマニュアル > ライブラリ一覧 > rdoc/code_objectライブラリ > RDoc::CodeObjectクラス
クラス・モジュールの継承リスト: RDoc::CodeObject < RDoc::Text < Object < Kernel < BasicObject
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
定義 | 説明 | |
---|---|---|
new -> RDoc::CodeObject
|
自身を初期化します。 |
定義 | 説明 | |
---|---|---|
comment -> String
|
自身のコメントを返します。 |
|
comment=(comment)
|
自身のコメントを comment に設定します。 |
|
document_children -> bool
|
自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるかどうかを返します。 |
|
document_children=(val)
|
自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるかどうかを設定します。 |
|
document_self -> bool
|
自身をドキュメントに含めるかどうかを返します。 |
|
document_self=(val)
|
自身をドキュメントに含めるかどうかを設定します。 |
|
documented? -> bool
|
出力すべきドキュメントがあるかどうかを返します。 |
|
metadata -> Hash
|
自身が持つメタデータ(他から任意の値を設定してもよい)を返します。 |
|
parent -> RDoc::CodeObject
|
自身を所有する(変数や定数などの形で保持する)オブジェクトを返します。 |
|
parent=(val)
|
自身を所有する(変数や定数などの形で保持する)オブジェクトを設定します。 |
|
parent_file_name -> String
|
self.parent のファイル名を返します。 |
|
parent_name -> String
|
self.parent の名前を返します。 |
|
remove_classes_and_modules -> ()
|
何もしません。RDoc::CodeObject#document_children= に false を指定した時のコールバックとして呼び出されます。オーバーライドして使用します。 |
|
remove_methods_etc -> ()
|
何もしません。RDoc::CodeObject#document_self= に false を指定した時のコールバックとして呼び出されます。オーバーライドして使用します。 |
|
section -> RDoc::Context::Section
|
所属している section を返します。 |
|
section=(val)
|
所属する section を設定します。 |
|
start_doc -> ()
|
以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまでの間、ドキュメントに含めます。 |
|
stop_doc -> ()
|
以降に解析したコメントを RDoc::CodeObject#start_doc を呼び出すまでの間、ドキュメントに含めません。 |
!
!=
__id__
__send__
instance_eval
instance_exec
method_missing
singleton_method_added
singleton_method_removed
singleton_method_undefined
!~
<=>
==
===
=~
_dump
class
clone
define_singleton_method
display
enum_for
eql?
equal?
extend
freeze
frozen?
hash
initialize
initialize_copy
inspect
instance_of?
instance_variable_defined?
instance_variable_get
instance_variable_set
instance_variables
is_a?
itself
marshal_dump
marshal_load
method
methods
nil?
object_id
pretty_inspect
pretty_print
pretty_print_cycle
pretty_print_inspect
pretty_print_instance_variables
private_methods
protected_methods
psych_to_yaml
public_method
public_methods
public_send
remove_instance_variable
respond_to?
respond_to_missing?
send
singleton_class
singleton_method
singleton_methods
taint
tainted?
tap
to_a
to_ary
to_hash
to_int
to_io
to_proc
to_regexp
to_s
to_str
trust
untaint
untrust
untrusted?
.yaml_tag
::ARGF
::ARGV
::DATA
::ENV
::FALSE
::NIL
::RUBY_COPYRIGHT
::RUBY_DESCRIPTION
::RUBY_ENGINE
::RUBY_ENGINE_VERSION
::RUBY_PATCHLEVEL
::RUBY_PLATFORM
::RUBY_RELEASE_DATE
::RUBY_REVISION
::RUBY_VERSION
::SCRIPT_LINES__
::STDERR
::STDIN
::STDOUT
::TOPLEVEL_BINDING
::TRUE
expand_tabs
flush_left
markup
normalize_comment
parse
strip_hashes
strip_newlines
strip_stars