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

class RDoc::Parser::PerlPOD

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

要約

Perl のソースコードを解析するためのクラスです。

目次

特異メソッド

new

インスタンスメソッド

filter scan

特異メソッド

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

自身を初期化します。

[PARAM] top_level:

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

[PARAM] file_name:

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

[PARAM] body:

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

[PARAM] options:

Options オブジェクトを指定します。

[PARAM] stats:

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

インスタンスメソッド

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

Perl のコメントの各行のマークアップを rdoc 向けのものに変換した文字列を 返します。

現在は基本的な部分のみを処理できます。まだ C<<...>> などを適切に処理す る事ができません。

[PARAM] comment:

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

scan -> RDoc::TopLevel[permalink][rdoc]

Perl ソースコード中に記述された POD (Plain old Documentation) 形式のコ メントを解析します。

[RETURN]

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