Ruby 2.2.0 リファレンスマニュアル > ライブラリ一覧 > rdoc/top_levelライブラリ > RDoc::TopLevelクラス

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 を返します。
`new(file_name) -> RDoc::TopLevel`	自身を初期化します。
`reset -> ()`	RDoc が収集した RDoc::TopLevel の情報(クラス、モジュール、ファイル)をクリアします。

インスタンスメソッド

定義	説明
`add_class_or_module(collection, class_type, name, superclass) -> RDoc::NormalClass \| RDoc::SingleClass \| RDoc::NormalModule`	collection に name で指定したクラス、モジュールを追加します。
`file_absolute_name -> String`	自身が管理するファイルに関する絶対パスを文字列で返します。
`file_absolute_name=(val)`	自身が管理するファイルに関する絶対パスを文字列で設定します。
`file_relative_name -> String`	自身が管理するファイルに関する相対パスを文字列で返します。
`file_relative_name=(val)`	自身が管理するファイルに関する相対パスを文字列で設定します。
`file_stat -> File::Stat`	自身が管理するファイルに関する File::Stat オブジェクトを返します。
`file_stat=(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 を返します。
`full_name -> String`	自身が管理するファイルの名前を返します。

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined < <= == > >= between? !~ === =~ _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_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE comment comment= document_children document_children= document_self document_self= documented? metadata parent parent= parent_file_name parent_name remove_classes_and_modules remove_methods_etc section section= start_doc stop_doc <=> 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 ::TYPES ::VISIBILITIES expand_tabs flush_left markup normalize_comment parse strip_hashes strip_newlines strip_stars