class RDoc::Parser::Simple

要約

ソースコード以外のファイルを解析するためのクラスです。

目次

特異メソッド
インスタンスメソッド

継承しているメソッド

RDoc::Parserから継承しているメソッド

特異メソッド

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

自身を初期化します。

[PARAM] top_level:
RDoc::TopLevel オブジェクトを指定します。
[PARAM] file_name:
ファイル名を文字列で指定します。
[PARAM] body:
内容を文字列で指定します。
[PARAM] options:
RDoc::Options オブジェクトを指定します。
[PARAM] stats:
RDoc::Stats オブジェクトを指定します。

インスタンスメソッド

remove_private_comments(comment) -> String[permalink][rdoc]

行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返します。

[PARAM] comment:
対象の文字列を指定します。
[RETURN]
コメントが削除された文字列を返します。
scan -> RDoc::TopLevel[permalink][rdoc]

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

[RETURN]
RDoc::TopLevel オブジェクトを返します。