要約
最上位のコンテキスト(ソースファイル)を表現するクラスです。
目次
- 特異メソッド
- インスタンスメソッド
継承しているメソッド
- RDoc::Contextから継承しているメソッド
-
- <=>
- add_alias
- add_attribute
- add_class
- add_constant
- add_include
- add_method
- add_module
- add_require
- add_to
- aliases
- attributes
- classes
- constants
- current_section
- defined_in?
- each_attribute
- each_classmodule
- each_constant
- each_method
- find_enclosing_module_named
- find_symbol
- in_files
- includes
- initialize_classes_and_modules
- initialize_methods_etc
- method_list
- modules
- name
- ongoing_visibility=
- record_location
- requires
- sections
- set_current_section
- set_visibility_for
- toplevel
- unmatched_alias_lists
- unmatched_alias_lists=
- visibility
- Comparableから継承しているメソッド
- RDoc::CodeObjectから継承しているメソッド
- RDoc::Textから継承しているメソッド
特異メソッド
all_classes_and_modules -> [RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule][permalink][rdoc][edit]-
RDoc が収集したクラス、モジュールを配列で返します。
find_class_named(name) -> RDoc::NormalClass | RDoc::SingleClass | nil[permalink][rdoc][edit]-
RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つからなかった場合は nil を返します。
- [PARAM] name:
- クラス名を文字列で指定します。
new(file_name) -> RDoc::TopLevel[permalink][rdoc][edit]-
自身を初期化します。
- [PARAM] file_name:
- ファイル名を文字列で指定します。
reset -> ()[permalink][rdoc][edit]-
RDoc が収集した RDoc::TopLevel の情報(クラス、モジュール、ファイル)をクリアします。
インスタンスメソッド
add_class_or_module(collection, class_type, name, superclass) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule[permalink][rdoc][edit]-
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[permalink][rdoc][edit]-
自身が管理するファイルに関する絶対パスを文字列で返します。
file_absolute_name=(val)[permalink][rdoc][edit]-
自身が管理するファイルに関する絶対パスを文字列で設定します。
- [PARAM] val:
- パスを文字列で指定します。
file_relative_name -> String[permalink][rdoc][edit]-
自身が管理するファイルに関する相対パスを文字列で返します。
file_relative_name=(val)[permalink][rdoc][edit]-
自身が管理するファイルに関する相対パスを文字列で設定します。
- [PARAM] val:
- パスを文字列で指定します。
file_stat -> File::Stat[permalink][rdoc][edit]-
自身が管理するファイルに関する File::Stat オブジェクトを返します。
file_stat=(val)[permalink][rdoc][edit]-
自身が管理するファイルに関する File::Stat オブジェクトを設定します。
- [PARAM] val:
- File::Stat オブジェクトを指定します。
find_local_symbol(name) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule | RDoc::AnyMethod | RDoc::Alias | RDoc::Attr | RDoc::Constant[permalink][rdoc][edit]-
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。
find_module_named(name) -> RDoc::NormalModule[permalink][rdoc][edit]-
RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。見つからなかった場合は nil を返します。
- [PARAM] name:
- モジュール名を文字列で指定します。
full_name -> String[permalink][rdoc][edit]-
自身が管理するファイルの名前を返します。