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

class RDoc::Parser::C

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

要約

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

目次

特異メソッド

new

インスタンスメソッド

progress= scan

特異メソッド

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

自身を初期化します。

[PARAM] top_level:

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

[PARAM] file_name:

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

[PARAM] body:

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

[PARAM] options:

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

[PARAM] stats:

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

インスタンスメソッド

progress=(val)[permalink][rdoc]

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

[PARAM] val:

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

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

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

[RETURN]

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