class RDoc::Parser::C

要約

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメントを解析するためのクラスです。

目次

特異メソッド

• new

インスタンスメソッド

• progress=
• scan

継承しているメソッド

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

• parse_files_matching

特異メソッド

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

自身を初期化します。

[PARAM] top_level:

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

[PARAM] file_name:

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

[PARAM] body:

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

[PARAM] options:

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

[PARAM] stats:

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

インスタンスメソッド

progress=(val)[permalink][rdoc][edit]

進捗を出力する IO を指定します。

[PARAM] val:

進捗を出力する IO を指定します。指定しなかった場合は $stderr が使われます。

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

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメントを解析します。

[RETURN]

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