Ruby 1.8.7 リファレンスマニュアル > ライブラリ一覧 > rdoc/parsers/parse_cライブラリ > RDoc::C_Parserクラス

class RDoc::C_Parser

クラスの継承リスト: RDoc::C_Parser < Object < Kernel
extend: RDoc::ParserFactory

要約

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

目次

特異メソッド

new

インスタンスメソッド

progress= scan

特異メソッド

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

自身を初期化します。

[PARAM] top_level:

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

[PARAM] file_name:

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

[PARAM] body:

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

[PARAM] options:

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

[PARAM] stats:

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

インスタンスメソッド

progress=(val)[permalink][rdoc]

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

[PARAM] val:

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

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

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

[RETURN]

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