Ruby 1.9.3 リファレンスマニュアル > ライブラリ一覧 > rdoc/class_moduleライブラリ > RDoc::ClassModuleクラス

class RDoc::ClassModule + RDoc::Context + Comparable + RDoc::CodeObject

クラスの継承リスト: RDoc::ClassModule < RDoc::Context < Comparable < RDoc::CodeObject < RDoc::Text < Object < Kernel < BasicObject

要約

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

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

特異メソッド

new -> RDoc::Context

自身を初期化します。

new -> RDoc::CodeObject

自身を初期化します。

インスタンスメソッド

self < other -> bool

比較演算子 <=> をもとにオブジェクト同士を比較します。 <=> が負の整数を返した場合に、true を返します。 それ以外の整数を返した場合に、false を返します。

[PARAM] other:
自身と比較したいオブジェクトを指定します。
[EXCEPTION] ArgumentError:
<=> が nil を返したときに発生します。
self <= other -> bool

比較演算子 <=> をもとにオブジェクト同士を比較します。 <=> が負の整数か 0 を返した場合に、true を返します。 それ以外の整数を返した場合に、false を返します。

[PARAM] other:
自身と比較したいオブジェクトを指定します。
[EXCEPTION] ArgumentError:
<=> が nil を返したときに発生します。
self <=> other -> -1 | 0 | 1

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

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

[PARAM] other:
自身と比較したいオブジェクトを指定します。
self == other -> bool | nil

比較演算子 <=> をもとにオブジェクト同士を比較します。 <=> が 0 を返した時に、true を返します。 それ以外を返した場合は、false を返します。

[PARAM] other:
自身と比較したいオブジェクトを指定します。
self > other -> bool

比較演算子 <=> をもとにオブジェクト同士を比較します。 <=> が正の整数を返した場合に、true を返します。 それ以外の整数を返した場合に、false を返します。

[PARAM] other:
自身と比較したいオブジェクトを指定します。
[EXCEPTION] ArgumentError:
<=> が nil を返したときに発生します。
self >= other -> bool

比較演算子 <=> をもとにオブジェクト同士を比較します。 <=> が正の整数か 0 を返した場合に、true を返します。 それ以外の整数を返した場合に、false を返します。

[PARAM] other:
自身と比較したいオブジェクトを指定します。
[EXCEPTION] ArgumentError:
<=> が nil を返したときに発生します。
add_alias(an_alias) -> RDoc::Alias

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

[PARAM] an_alias:
RDoc::Alias オブジェクトを指定します。
add_attribute(an_attribute) -> ()

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

[PARAM] an_attribute:
RDoc::Attr オブジェクトを指定します。
add_class(class_type, name, superclass) -> RDoc::SingleClass | RDoc::NormalClass

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

[PARAM] class_type:
追加するクラス、モジュールを RDoc::NormalClassRDoc::SingleClassRDoc::NormalModule オ ブジェクトのいずれかで指定します。
[PARAM] name:
クラス名を文字列で指定します。
[PARAM] superclass:
追加するクラスの親クラスを RDoc::NormalClass オ ブジェクトで指定します。
add_class_or_module(collection, class_type, name, superclass = nil) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule

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

[PARAM] collection:
クラス、モジュールを追加する先を Hash オブジェ クトで指定します。
[PARAM] class_type:
追加するクラス、モジュールを RDoc::NormalClassRDoc::SingleClassRDoc::NormalModule オ ブジェクトのいずれかで指定します。
[PARAM] name:
クラス名を文字列で指定します。
[PARAM] superclass:
追加するクラスの親クラスを RDoc::NormalClass オ ブジェクトで指定します。

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

add_constant(const) -> ()

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

[PARAM] const:
RDoc::Constant オブジェクトを指定します。
add_include(an_include) -> ()

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

[PARAM] an_include:
RDoc::Include オブジェクトを指定します。
add_method(a_method) -> ()

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

[PARAM] a_method:
RDoc::AnyMethod オブジェクトかそのサブクラスのオ ブジェクトを指定します。
add_module(class_type, name) -> RDoc::NormalModule | RDoc::SingleClass | RDoc::NormalClass

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

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

[PARAM] class_type:
追加するクラス、モジュールを RDoc::NormalClassRDoc::SingleClassRDoc::NormalModule オ ブジェクトのいずれかで指定します。
[PARAM] name:
クラス名を文字列で指定します。

[SEE_ALSO] RDoc::Context#add_class

add_require(a_require) -> ()

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

[PARAM] a_require:
RDoc::Require オブジェクトを指定します。
add_to(array, thing) -> ()

array に thing を追加します。

[PARAM] array:
配列を指定します。
[PARAM] thing:
追加する要素を指定します。

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

[SEE_ALSO] RDoc::Context#add_alias, RDoc::Context#add_attribute, RDoc::Context#add_constant, RDoc::Context#add_include, RDoc::Context#add_method, RDoc::Context#add_require

aliases -> [RDoc::Alias]

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

attributes -> [RDoc::Attr]

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

between?(min, max) -> bool

比較演算子 <=> をもとに self が min と max の範囲内(min, max を含みます)にあるかを判断します。

以下のコードと同じです。

self >= min and self <= max
[PARAM] min:
範囲の下端を表すオブジェクトを指定します。
[PARAM] max:
範囲の上端を表すオブジェクトを指定します。
[EXCEPTION] ArgumentError:
self <=> min か、self <=> max が nil を返 したときに発生します。
3.between?(1, 5)               #=> true
6.between?(1, 5)               #=> false
'cat'.between?('ant', 'dog')   #=> true
'gnu'.between?('ant', 'dog')   #=> false
classes -> [RDoc::SingleClass | RDoc::NormalClass]

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

comment -> String

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

comment=(comment)

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

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

[PARAM] comment:
コメントを文字列で指定します。
constants -> [RDoc::Constant]

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

current_section -> RDoc::Context::Section

現在の section を返します。

defined_in?(file)

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

document_children -> bool

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

[SEE_ALSO] RDoc::CodeObject#document_self

document_children=(val)

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

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

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

[SEE_ALSO] RDoc::CodeObject#document_self=, RDoc::CodeObject#remove_classes_and_modules

document_self -> bool

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

[SEE_ALSO] RDoc::CodeObject#document_children

document_self=(val)

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

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

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

[SEE_ALSO] RDoc::CodeObject#document_children=, RDoc::CodeObject#remove_methods_etc

documented? -> bool

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

each_attribute {|a| ... } -> [RDoc::Attr]

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

each_classmodule {|m| ... } -> [RDoc::SingleClass | RDoc::NormalClass | RDoc::NormalModule]

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

[SEE_ALSO] RDoc::Context#classes, RDoc::Context#modules

each_constant {|c| ... } -> [RDoc::Constant]

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

each_method {|m| ... } -> [RDoc::AnyMethod]

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

find_enclosing_module_named(name) -> RDoc::NormalModule | nil

find a module at a higher scope

find_local_symbol(symbol)

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

find_module_named(name) -> RDoc::NormalModule | nil

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

[PARAM] name:
モジュールの名前を文字列で指定します。
find_symbol(symbol, method=nil)

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

in_files

Files this context is found in

includes -> [RDoc::Include]

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

initialize_classes_and_modules -> ()

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

initialize_methods_etc -> ()

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

metadata -> Hash

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

method_list -> [RDoc::AnyMethod]

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

modules -> [RDoc::NormalModule]

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

name -> String

自身の名前を返します。

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

ongoing_visibility=(vis)

Change the default visibility for new methods

parent -> RDoc::CodeObject

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

parent=(val)

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

[PARAM] val:
RDoc::CodeObject のサブクラスのオブジェクトを指定しま す。
parent_file_name -> String

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

[SEE_ALSO] RDoc::CodeObject#parent

parent_name -> String

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

[SEE_ALSO] RDoc::CodeObject#parent

record_location(toplevel)

Record the file that we happen to find it in

remove_classes_and_modules -> ()

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

remove_methods_etc -> ()

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

requires -> [RDoc::Require]

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

section -> RDoc::Context::Section

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

section=(val)

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

[PARAM] val:
RDoc::Context::Section オブジェクトを指定します。
sections -> RDoc::Context::Section

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

set_current_section(title, comment) -> ()

Handle sections

set_visibility_for(methods, visibility, singleton = false) -> ()

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

[PARAM] methods:
RDoc::AnyMethodRDoc::Attr オブジェクトの配 列を指定します。
[PARAM] visibility:
可視性を :public, :protected, :private の内のいずれか で指定します。
[PARAM] singleton:
特異メソッドの可視性を変更する場合は true、そうでない 場合は false を指定します。
start_doc -> ()

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

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

[SEE_ALSO] RDoc::CodeObject#end_doc

stop_doc -> ()

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

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

[SEE_ALSO] RDoc::CodeObject#start_doc

toplevel -> RDoc::TopLevel

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

unmatched_alias_lists -> {String => RDoc::Alias}

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

unmatched_alias_lists=(val)

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

[PARAM] val:
旧メソッド名がキー、RDoc::Alias が値の Hash を指 定します。
visibility -> :public | :protected | :private

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

定数

TYPES -> ["class", "instance"]

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

VISIBILITIES -> [:public, :protected, :private]

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

class RDoc::ClassModule