class RDoc::TopLevel
クラスの継承リスト: RDoc::TopLevel < RDoc::Context < Comparable < RDoc::CodeObject < RDoc::Text < Object < Kernel < BasicObject
要約
最上位のコンテキスト(ソースファイル)を表現するクラスです。
特異メソッド
all_classes_and_modules -> [RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule]
-
RDoc が収集したクラス、モジュールを配列で返します。
find_class_named(name) -> RDoc::NormalClass | RDoc::SingleClass | nil
-
RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ からなかった場合は nil を返します。
- [PARAM] name:
- クラス名を文字列で指定します。
new(file_name) -> RDoc::TopLevel
-
自身を初期化します。
- [PARAM] file_name:
- ファイル名を文字列で指定します。
reset -> ()
-
RDoc が収集した RDoc::TopLevel の情報(クラス、モジュール、ファイ ル)をクリアします。
インスタンスメソッド
add_class_or_module(collection, class_type, name, superclass) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule
-
collection に name で指定したクラス、モジュールを追加します。
- [PARAM] collection:
- クラス、モジュールを追加する先を Hash オブジェ クトで指定します。
- [PARAM] class_type:
- 追加するクラス、モジュールを RDoc::NormalClass、 RDoc::SingleClass、RDoc::NormalModule オ ブジェクトのいずれかで指定します。
- [PARAM] name:
- クラス名を文字列で指定します。
- [PARAM] superclass:
- 追加するクラスの親クラスを RDoc::NormalClass オ ブジェクトで指定します。
既に登録済みであった場合は、引数で指定した情報で内容を更新します。ただ し、RDoc::CodeObject#done_documenting が true を返す場合、何も行 われません。
file_absolute_name -> String
-
自身が管理するファイルに関する絶対パスを文字列で返します。
file_absolute_name=(val)
-
自身が管理するファイルに関する絶対パスを文字列で設定します。
- [PARAM] val:
- パスを文字列で指定します。
file_relative_name -> String
-
自身が管理するファイルに関する相対パスを文字列で返します。
file_relative_name=(val)
-
自身が管理するファイルに関する相対パスを文字列で設定します。
- [PARAM] val:
- パスを文字列で指定します。
file_stat -> File::Stat
-
自身が管理するファイルに関する File::Stat オブジェクトを返します。
file_stat=(val)
-
自身が管理するファイルに関する File::Stat オブジェクトを設定しま す。
- [PARAM] val:
- File::Stat オブジェクトを指定します。
find_local_symbol(name) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule | RDoc::AnyMethod | RDoc::Alias | RDoc::Attr | RDoc::Constant
-
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。
find_module_named(name) -> RDoc::NormalModule
-
RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。 見つからなかった場合は nil を返します。
- [PARAM] name:
- モジュール名を文字列で指定します。
full_name -> String
-
自身が管理するファイルの名前を返します。