class RDoc::Parser

要約

ソースコードを解析するパーサを生成するための基本クラスです。

新しいパーサを作成する場合には継承して使用します。

目次

特異メソッド

• alias_extension
• can_parse
• parser_for
• parsers

インスタンスメソッド

• parse_files_matching

特異メソッド

alias_extension(old_ext, new_ext) -> bool[permalink][rdoc][edit]

old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登録します。

[PARAM] old_ext:

拡張子を文字列で指定します。

[PARAM] new_ext:

拡張子を文字列で指定します。

[RETURN]

エイリアスが登録された場合は true を返します。old_ext にパーサが登録されていない場合、エイリアスが登録されずに false を返します。

can_parse(file_name) -> RDoc::Parser | nil[permalink][rdoc][edit]

file_name を解析できるパーサクラスを返します。見つからなかった場合は nil を返します。

[PARAM] file_name:

解析するファイルの名前を指定します。

parser_for(top_level, file_name, body, options, stats) -> RDoc::Parser[permalink][rdoc][edit]

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

RDoc::Parser#parse_files_matching で登録した正規表現とパーサクラスの配列の配列を返します。

インスタンスメソッド

parse_files_matching(regexp) -> ()[permalink][rdoc][edit]

regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、自身を登録します。

[PARAM] regexp:

正規表現を指定します。

新しいパーサを作成する時に使用します。

例:

class RDoc::Parser::Xyz < RDoc::Parser
  parse_files_matching /\.xyz$/
  ...
end