class RDoc::Parser::Ruby + RDoc::RubyToken + RDoc::TokenStream + RDoc::Parser::RubyTools + RDoc::RubyToken + RDoc::Parser
クラスの継承リスト: RDoc::Parser::Ruby < RDoc::RubyToken < RDoc::TokenStream < RDoc::Parser::RubyTools < RDoc::RubyToken < RDoc::Parser < Object < Kernel < BasicObject
要約
Ruby のソースコードを解析するためのクラスです。
特異メソッド
alias_extension(old_ext, new_ext) -> bool
-
old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登 録します。
- [PARAM] old_ext:
- 拡張子を文字列で指定します。
- [PARAM] new_ext:
- 拡張子を文字列で指定します。
- [RETURN]
- エイリアスが登録された場合は true を返します。old_ext にパーサ が登録されていない場合、エイリアスが登録されずに false を返しま す。
can_parse(file_name) -> RDoc::Parser | nil
-
file_name を解析できるパーサクラスを返します。見つからなかった場合は nil を返します。
- [PARAM] file_name:
- 解析するファイルの名前を指定します。
new(top_level, file_name, body, options, stats) -> RDoc::Parser::Ruby
-
自身を初期化します。
- [PARAM] top_level:
- RDoc::TopLevel オブジェクトを指定します。
- [PARAM] file_name:
- ファイル名を文字列で指定します。
- [PARAM] body:
- ソースコードの内容を文字列で指定します。
- [PARAM] options:
- RDoc::Options オブジェクトを指定します。
- [PARAM] stats:
- RDoc::Stats オブジェクトを指定します。
parser_for(top_level, file_name, body, options, stats) -> RDoc::Parser
-
file_name を解析できるパーサのインスタンスを返します。 見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。
- [PARAM] top_level:
- RDoc::TopLevel オブジェクトを指定します。
- [PARAM] file_name:
- ファイル名を文字列で指定します。
- [PARAM] body:
- ソースコードの内容を文字列で指定します。
- [PARAM] options:
- RDoc::Options オブジェクトを指定します。
- [PARAM] stats:
- RDoc::Stats オブジェクトを指定します。
parsers -> [[Regexp, RDoc::Parser]]
-
RDoc::Parser#parse_files_matching で登録した正規表現とパーサクラ スの配列の配列を返します。
インスタンスメソッド
parse_files_matching(regexp) -> ()
-
regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、 自身を登録します。
- [PARAM] regexp:
- 正規表現を指定します。
新しいパーサを作成する時に使用します。
例:
class RDoc::Parser::Xyz < RDoc::Parser parse_files_matching /\.xyz$/ ... end
scan -> RDoc::TopLevel
-
Ruby のソースコードからクラス/モジュールのドキュメントを解析します。
- [RETURN]
- RDoc::TopLevel オブジェクトを返します。
定数
NORMAL -> "::"
-
RDoc::NormalClass type
SINGLE -> "<<"
-
RDoc::SingleClass type
class RDoc::Parser::Ruby