検索結果

RDoc::TopLevel (69001.0)

• 2.3.0

• クラス

最上位のコンテキスト(ソースファイル)を表現するクラスです。

最上位のコンテキスト(ソースファイル)を表現するクラスです。

RDoc::TopLevel.new(file_name) -> RDoc::TopLevel (63304.0)

• 2.3.0

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param file_name ファイル名を文字列で指定します。

• RDoc::TopLevel

RDoc::TopLevel.reset -> () (63049.0)

• 2.3.0

• 特異メソッド

RDoc が収集した RDoc::TopLevel の情報(クラス、モジュール、ファイ ル)をクリアします。

RDoc が収集した RDoc::TopLevel の情報(クラス、モジュール、ファイ
ル)をクリアします。

• RDoc::TopLevel

RDoc::TopLevel#add_class_or_module(collection, class_type, name, superclass) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule (63001.0)

• 2.3.0

• インスタンスメソッド

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

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

@param collection クラス、モジュールを追加する先を Hash オブジェ
クトで指定します。

@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

@param name クラス名を文字列で指定します。

@param su...

• Hash
• RDoc::NormalClass
• RDoc::TopLevel

RDoc::TopLevel#file_absolute_name -> String (63001.0)

• 2.3.0

• インスタンスメソッド

自身が管理するファイルに関する絶対パスを文字列で返します。

自身が管理するファイルに関する絶対パスを文字列で返します。

• RDoc::TopLevel

絞り込み条件を変える

RDoc::TopLevel#file_absolute_name=(val) (63001.0)

• 2.3.0

• インスタンスメソッド

自身が管理するファイルに関する絶対パスを文字列で設定します。

自身が管理するファイルに関する絶対パスを文字列で設定します。

@param val パスを文字列で指定します。

• RDoc::TopLevel

RDoc::TopLevel#file_relative_name -> String (63001.0)

• 2.3.0

• インスタンスメソッド

自身が管理するファイルに関する相対パスを文字列で返します。

自身が管理するファイルに関する相対パスを文字列で返します。

• RDoc::TopLevel

RDoc::TopLevel#file_relative_name=(val) (63001.0)

• 2.3.0

• インスタンスメソッド

自身が管理するファイルに関する相対パスを文字列で設定します。

自身が管理するファイルに関する相対パスを文字列で設定します。

@param val パスを文字列で指定します。

• RDoc::TopLevel

RDoc::TopLevel#file_stat -> File::Stat (63001.0)

• 2.3.0

• インスタンスメソッド

自身が管理するファイルに関する File::Stat オブジェクトを返します。

自身が管理するファイルに関する File::Stat オブジェクトを返します。

• File::Stat
• RDoc::TopLevel

RDoc::TopLevel#file_stat=(val) (63001.0)

• 2.3.0

• インスタンスメソッド

自身が管理するファイルに関する File::Stat オブジェクトを設定しま す。

自身が管理するファイルに関する File::Stat オブジェクトを設定しま
す。

@param val File::Stat オブジェクトを指定します。

• File::Stat
• RDoc::TopLevel

絞り込み条件を変える

RDoc::TopLevel#find_local_symbol(name) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule | RDoc::AnyMethod | RDoc::Alias | RDoc::Attr | RDoc::Constant (63001.0)

• 2.3.0

• インスタンスメソッド

クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。

クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。

• RDoc::TopLevel

RDoc::TopLevel#find_module_named(name) -> RDoc::NormalModule (63001.0)

• 2.3.0

• インスタンスメソッド

RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。 見つからなかった場合は nil を返します。

RDoc が収集したクラスの内、name で指定した名前のモジュールを返します。
見つからなかった場合は nil を返します。

@param name モジュール名を文字列で指定します。

• RDoc::TopLevel

RDoc::TopLevel#full_name -> String (63001.0)

• 2.3.0

• インスタンスメソッド

自身が管理するファイルの名前を返します。

自身が管理するファイルの名前を返します。

• RDoc::TopLevel

RDoc::TopLevel.all_classes_and_modules -> [RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule] (63001.0)

• 2.3.0

• 特異メソッド

RDoc が収集したクラス、モジュールを配列で返します。

RDoc が収集したクラス、モジュールを配列で返します。

• RDoc::TopLevel

RDoc::TopLevel.find_class_named(name) -> RDoc::NormalClass | RDoc::SingleClass | nil (63001.0)

• 2.3.0

• 特異メソッド

RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ からなかった場合は nil を返します。

RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ
からなかった場合は nil を返します。

@param name クラス名を文字列で指定します。

• RDoc::TopLevel

絞り込み条件を変える

RDoc::Parser::Simple#scan -> RDoc::TopLevel (370.0)

• 2.3.0

• インスタンスメソッド

自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し ます。

自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し
ます。

@return RDoc::TopLevel オブジェクトを返します。

• RDoc::Parser::Simple
• RDoc::TopLevel

RDoc::Context#toplevel -> RDoc::TopLevel (352.0)

• 2.3.0

• インスタンスメソッド

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

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

• RDoc::Context
• RDoc::TopLevel

RDoc::Parser::C#scan -> RDoc::TopLevel (322.0)

• 2.3.0

• インスタンスメソッド

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析します。

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析します。

@return RDoc::TopLevel オブジェクトを返します。

• RDoc::Parser::C
• RDoc::TopLevel

RDoc::Parser::ChangeLog#scan -> RDoc::TopLevel (322.0)

• 2.3.0

• インスタンスメソッド

ChangeLog ファイルを解析します。

ChangeLog ファイルを解析します。

@return RDoc::TopLevel オブジェクトを返します。

• RDoc::Parser::ChangeLog
• RDoc::TopLevel

RDoc::Parser::Markdown#scan -> RDoc::TopLevel (322.0)

• 2.3.0

• インスタンスメソッド

Markdown 形式で記述されたファイルを解析します。

Markdown 形式で記述されたファイルを解析します。

@return RDoc::TopLevel オブジェクトを返します。

• RDoc::Parser::Markdown
• RDoc::TopLevel

絞り込み条件を変える

RDoc::Parser::RD#scan -> RDoc::TopLevel (322.0)

• 2.3.0

• インスタンスメソッド

RD 形式で記述されたファイルを解析します。

RD 形式で記述されたファイルを解析します。

@return RDoc::TopLevel オブジェクトを返します。

• RDoc::Parser::RD
• RDoc::TopLevel

RDoc::Parser::Ruby#scan -> RDoc::TopLevel (322.0)

• 2.3.0

• インスタンスメソッド

Ruby のソースコードからクラス/モジュールのドキュメントを解析します。

Ruby のソースコードからクラス/モジュールのドキュメントを解析します。

@return RDoc::TopLevel オブジェクトを返します。

• RDoc::Parser::Ruby
• RDoc::TopLevel

RDoc::Context#add_require(a_require) -> () (49.0)

• 2.3.0

• インスタンスメソッド

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

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

@param a_require RDoc::Require オブジェクトを指定します。

• RDoc::Context
• RDoc::Require
• RDoc::TopLevel

rdoc/top_level (49.0)

• 2.3.0

• ライブラリ

RDoc::TopLevel を定義するサブライブラリです。

RDoc::TopLevel を定義するサブライブラリです。

• RDoc::TopLevel

rdoc/generator (37.0)

• 2.3.0

• ライブラリ

RDoc が解析したソースコードを RDoc::CodeObject のツリーから その他の形式に出力するためのサブライブラリです。

RDoc が解析したソースコードを RDoc::CodeObject のツリーから
その他の形式に出力するためのサブライブラリです。

RDoc には HTML 向けのジェネレータの
RDoc::Generator::Darkfish と ri 向けのジェネレータの
RDoc::Generator::RI が付属しています。

=== ジェネレータの登録

RDoc::RDoc.add_generator を呼び出す事でジェネレータの登録が行えます。

class My::Awesome::Generator
RDoc::RDoc.add_generator self
end
...

• RDoc::Generator
• rdoc/generator/darkfish
• rdoc/generator/json_index
• rdoc/generator/markup
• rdoc/generator/ri

絞り込み条件を変える

rdoc/parser (37.0)

• 2.3.0

• ライブラリ

rdoc で解析できるファイルの種類を追加するためのサブライブラリです。

rdoc で解析できるファイルの種類を追加するためのサブライブラリです。

以下のメソッドを定義したクラスを作成する事で、新しいパーサクラスを作成
する事ができます。

* #initialize(top_level, file_name, body, options, stats)
* #scan

initialize メソッドは以下の引数を受け取ります。

* top_level RDoc::TopLevel オブジェクトを指定します。
* file_name: file_name ファイル名を文字列で指定します。
* body: ソースコードの内容を文字列で指定します。
*...

• RDoc::Parser
• e2mmap
• irb/notifier
• irb/output-method
• irb/slex
• rdoc
• rdoc/alias
• rdoc/anon_class
• rdoc/any_method
• rdoc/attr
• rdoc/class_module
• rdoc/code_object
• rdoc/code_objects
• rdoc/constant
• rdoc/context
• rdoc/ghost_method
• rdoc/include
• rdoc/known_classes
• rdoc/meta_method
• rdoc/normal_class
• ...

RDoc::CodeObject (19.0)

• 2.3.0

• クラス

RDoc のコードツリーを表現するクラスの基本クラスです。

RDoc のコードツリーを表現するクラスの基本クラスです。

以下は RDoc::CodeObject のサブクラスのツリーです。

//emlist{
* RDoc::Context
* RDoc::TopLevel
* RDoc::ClassModule
* RDoc::AnonClass
* RDoc::NormalClass
* RDoc::NormalModule
* RDoc::SingleClass
* RDoc::AnyMethod
* RDoc::GhostMethod
* RDoc::MetaMethod
...

• RDoc::CodeObject

RDoc::Parser.parser_for(top_level, file_name, body, options, stats) -> RDoc::Parser (19.0)

• 2.3.0

• 特異メソッド

file_name を解析できるパーサのインスタンスを返します。 見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。

file_name を解析できるパーサのインスタンスを返します。
見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。

@param top_level RDoc::TopLevel オブジェクトを指定します。

@param file_name ファイル名を文字列で指定します。

@param body ソースコードの内容を文字列で指定します。

@param options RDoc::Options オブジェクトを指定します。

@param stats RDoc::Stats オブジェクトを指定します。

• RDoc::Options
• RDoc::Parser
• RDoc::Parser::Simple
• RDoc::Stats
• RDoc::TopLevel

RDoc::Parser::C.new(top_level, file_name, body, options, stats) -> RDoc::Parser::C (19.0)

• 2.3.0

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param top_level RDoc::TopLevel オブジェクトを指定します。

@param file_name ファイル名を文字列で指定します。

@param body ソースコードの内容を文字列で指定します。

@param options RDoc::Options オブジェクトを指定します。

@param stats RDoc::Stats オブジェクトを指定します。

• RDoc::Options
• RDoc::Parser::C
• RDoc::Stats
• RDoc::TopLevel

RDoc::Parser::Ruby.new(top_level, file_name, body, options, stats) -> RDoc::Parser::Ruby (19.0)

• 2.3.0

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param top_level RDoc::TopLevel オブジェクトを指定します。

@param file_name ファイル名を文字列で指定します。

@param body ソースコードの内容を文字列で指定します。

@param options RDoc::Options オブジェクトを指定します。

@param stats RDoc::Stats オブジェクトを指定します。

• RDoc::Options
• RDoc::Parser::Ruby
• RDoc::Stats
• RDoc::TopLevel

絞り込み条件を変える

RDoc::Parser::Simple.new(top_level, file_name, body, options, stats) -> RDoc::Parser::Simple (19.0)

• 2.3.0

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param top_level RDoc::TopLevel オブジェクトを指定します。

@param file_name ファイル名を文字列で指定します。

@param body 内容を文字列で指定します。

@param options RDoc::Options オブジェクトを指定します。

@param stats RDoc::Stats オブジェクトを指定します。

• RDoc::Options
• RDoc::Parser::Simple
• RDoc::Stats
• RDoc::TopLevel