Ruby 2.5.0 リファレンスマニュアル > ライブラリ一覧 > rdoc/contextライブラリ > RDoc::Contextクラス

class RDoc::Context

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

要約

モジュール、クラス、メソッドなどの、rdoc/code_objects が定義す るクラスを管理するクラスです。

目次

特異メソッド
new
インスタンスメソッド
<=> add_alias add_attribute add_class add_class_or_module 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_local_symbol find_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

特異メソッド

new -> RDoc::Context[permalink][rdoc]

自身を初期化します。

インスタンスメソッド

self <=> other -> -1 | 0 | 1[permalink][rdoc]

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

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

[PARAM] other:
自身と比較したいオブジェクトを指定します。
add_alias(an_alias) -> RDoc::Alias[permalink][rdoc]

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

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

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

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

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

[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[permalink][rdoc]

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) -> ()[permalink][rdoc]

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

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

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

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

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

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

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

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

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

[SEE_ALSO] RDoc::Context#add_class

add_require(a_require) -> ()[permalink][rdoc]

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

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

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][permalink][rdoc]

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

attributes -> [RDoc::Attr][permalink][rdoc]

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

classes -> [RDoc::SingleClass | RDoc::NormalClass][permalink][rdoc]

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

constants -> [RDoc::Constant][permalink][rdoc]

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

current_section -> RDoc::Context::Section[permalink][rdoc]

現在の section を返します。

defined_in?(file)[permalink][rdoc]

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

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

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

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

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

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

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

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

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

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

find_enclosing_module_named(name) -> RDoc::NormalModule | nil[permalink][rdoc]

find a module at a higher scope

find_local_symbol(symbol)[permalink][rdoc]

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

find_module_named(name) -> RDoc::NormalModule | nil[permalink][rdoc]

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

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

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

in_files[permalink][rdoc]

Files this context is found in

includes -> [RDoc::Include][permalink][rdoc]

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

initialize_classes_and_modules -> ()[permalink][rdoc]

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

initialize_methods_etc -> ()[permalink][rdoc]

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

method_list -> [RDoc::AnyMethod][permalink][rdoc]

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

modules -> [RDoc::NormalModule][permalink][rdoc]

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

name -> String[permalink][rdoc]

自身の名前を返します。

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

ongoing_visibility=(vis)[permalink][rdoc]

Change the default visibility for new methods

record_location(toplevel)[permalink][rdoc]

Record the file that we happen to find it in

requires -> [RDoc::Require][permalink][rdoc]

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

sections -> RDoc::Context::Section[permalink][rdoc]

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

set_current_section(title, comment) -> ()[permalink][rdoc]

Handle sections

set_visibility_for(methods, visibility, singleton = false) -> ()[permalink][rdoc]

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

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

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

unmatched_alias_lists -> {String => RDoc::Alias}[permalink][rdoc]

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

unmatched_alias_lists=(val)[permalink][rdoc]

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

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

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

定数

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

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

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

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