Ruby 2.1.0 リファレンスマニュアル > ライブラリ一覧 > rdoc/parser/simpleライブラリ > RDoc::Parser::Simpleクラス

class RDoc::Parser::Simple

クラスの継承リスト: RDoc::Parser::Simple < RDoc::Parser < Object < Kernel < BasicObject

要約

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

目次

特異メソッド

new

インスタンスメソッド

remove_private_comments scan

特異メソッド

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 オブジェクトを返します。