種類
- インスタンスメソッド (11)
- クラス (8)
- 特異メソッド (7)
- 定数 (2)
- モジュール (2)
クラス
-
RDoc
:: Options (2) -
RDoc
:: Parser (5) -
RDoc
:: Parser :: C (3) -
RDoc
:: Parser :: ChangeLog (1) -
RDoc
:: Parser :: Markdown (1) -
RDoc
:: Parser :: RD (1) -
RDoc
:: Parser :: Ruby (4) -
RDoc
:: Parser :: Simple (3)
キーワード
- C (1)
- ChangeLog (1)
- Markdown (1)
- NORMAL (1)
- Options (1)
- RD (1)
- Ruby (1)
- RubyTools (1)
- SINGLE (1)
- Simple (1)
- Text (1)
-
alias
_ extension (1) -
can
_ parse (1) - new (3)
-
option
_ parser (1) -
option
_ parser= (1) -
parse
_ files _ matching (1) -
parser
_ for (1) - parsers (1)
- progress= (1)
-
remove
_ private _ comments (1) - scan (6)
検索結果
先頭5件
-
RDoc
:: Parser (63004.0) -
ソースコードを解析するパーサを生成するための基本クラスです。
ソースコードを解析するパーサを生成するための基本クラスです。
新しいパーサを作成する場合には継承して使用します。 -
RDoc
:: Parser . parser _ for(top _ level , file _ name , body , options , stats) -> RDoc :: Parser (37063.0) -
file_name を解析できるパーサのインスタンスを返します。 見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。
... RDoc::Parser::Simple のインスタンスを返します。
@param top_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body ソースコードの内容を文字列で指定します。
@param options RDoc::Op......tions オブジェクトを指定します。
@param stats RDoc::Stats オブジェクトを指定します。... -
RDoc
:: Parser . parsers -> [[Regexp , RDoc :: Parser]] (37006.0) -
RDoc::Parser#parse_files_matching で登録した正規表現とパーサクラ スの配列の配列を返します。
...
RDoc::Parser#parse_files_matching で登録した正規表現とパーサクラ
スの配列の配列を返します。... -
RDoc
:: Options # option _ parser -> OptionParser | nil (27607.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを返し ます。
コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。 -
RDoc
:: Options # option _ parser=(val) (27307.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを設定 します。
コマンドライン引数の解析のための OptionParser オブジェクトを設定
します。
@param val OptionParser オブジェクトを指定します。 -
RDoc
:: Parser :: C . new(top _ level , file _ name , body , options , stats) -> RDoc :: Parser :: C (18664.0) -
自身を初期化します。
...op_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body ソースコードの内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats... -
RDoc
:: Parser :: Ruby . new(top _ level , file _ name , body , options , stats) -> RDoc :: Parser :: Ruby (18664.0) -
自身を初期化します。
...op_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body ソースコードの内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats... -
RDoc
:: Parser :: Simple . new(top _ level , file _ name , body , options , stats) -> RDoc :: Parser :: Simple (18664.0) -
自身を初期化します。
...@param top_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body 内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats オブジ... -
RDoc
:: Parser . can _ parse(file _ name) -> RDoc :: Parser | nil (18610.0) -
file_name を解析できるパーサクラスを返します。見つからなかった場合は nil を返します。
file_name を解析できるパーサクラスを返します。見つからなかった場合は
nil を返します。
@param file_name 解析するファイルの名前を指定します。 -
RDoc
:: Parser :: Simple # scan -> RDoc :: TopLevel (18373.0) -
自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し ます。
...自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し
ます。
@return RDoc::TopLevel オブジェクトを返します。... -
RDoc
:: Parser :: C # scan -> RDoc :: TopLevel (18325.0) -
C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析します。
...C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析します。
@return RDoc::TopLevel オブジェクトを返します。... -
RDoc
:: Parser :: ChangeLog # scan -> RDoc :: TopLevel (18325.0) -
ChangeLog ファイルを解析します。
...ChangeLog ファイルを解析します。
@return RDoc::TopLevel オブジェクトを返します。... -
RDoc
:: Parser :: Markdown # scan -> RDoc :: TopLevel (18325.0) -
Markdown 形式で記述されたファイルを解析します。
...Markdown 形式で記述されたファイルを解析します。
@return RDoc::TopLevel オブジェクトを返します。... -
RDoc
:: Parser :: RD # scan -> RDoc :: TopLevel (18325.0) -
RD 形式で記述されたファイルを解析します。
...RD 形式で記述されたファイルを解析します。
@return RDoc::TopLevel オブジェクトを返します。... -
RDoc
:: Parser :: Ruby # scan -> RDoc :: TopLevel (18325.0) -
Ruby のソースコードからクラス/モジュールのドキュメントを解析します。
...Ruby のソースコードからクラス/モジュールのドキュメントを解析します。
@return RDoc::TopLevel オブジェクトを返します。... -
RDoc
:: Parser :: RubyTools (18136.0) -
RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー ドのパーサを記述するためのメソッドを定義するモジュールです。
...RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー
ドのパーサを記述するためのメソッドを定義するモジュールです。
RDoc::Parser を継承していないため、パーサクラスとしては利用できま
せん。
ライブラリの内部で使用... -
RDoc
:: Parser :: Text (18094.0) -
プログラムを含まないテキストを解析するためのクラスです。
...プログラムを含まないテキストを解析するためのクラスです。
単体では使用せず、RDoc::Parser のサブクラスで RDoc::Parser::Text
を include する事で、プログラムを含んでいない事を rdoc に伝えます。... -
RDoc
:: Parser # parse _ files _ matching(regexp) -> () (18076.0) -
regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、 自身を登録します。
...マッチするファイルを解析できるパーサとして、
自身を登録します。
@param regexp 正規表現を指定します。
新しいパーサを作成する時に使用します。
例:
class RDoc::Parser::Xyz < RDoc::Parser
parse_files_matching /\.xyz$/
...
end... -
RDoc
:: Parser :: Ruby :: NORMAL -> " :: " (18052.0) -
RDoc::NormalClass type
...
RDoc::NormalClass type... -
RDoc
:: Parser :: Ruby :: SINGLE -> "<<" (18052.0) -
RDoc::SingleClass type
...
RDoc::SingleClass type... -
RDoc
:: Parser . alias _ extension(old _ ext , new _ ext) -> bool (18004.0) -
old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登 録します。
old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登
録します。
@param old_ext 拡張子を文字列で指定します。
@param new_ext 拡張子を文字列で指定します。
@return エイリアスが登録された場合は true を返します。old_ext にパーサ
が登録されていない場合、エイリアスが登録されずに false を返しま
す。 -
RDoc
:: Parser :: C (18004.0) -
C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析するためのクラスです。
C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析するためのクラスです。 -
RDoc
:: Parser :: C # progress=(val) (18004.0) -
進捗を出力する IO を指定します。
進捗を出力する IO を指定します。
@param val 進捗を出力する IO を指定します。指定しなかった場合は
$stderr が使われます。 -
RDoc
:: Parser :: ChangeLog (18004.0) -
ChangeLog ファイルを解析するためのクラスです。
ChangeLog ファイルを解析するためのクラスです。 -
RDoc
:: Parser :: Markdown (18004.0) -
Markdown 形式で記述されたファイルを解析するためのクラスです。
Markdown 形式で記述されたファイルを解析するためのクラスです。
解析された情報はコメントとして扱われます。 -
RDoc
:: Parser :: RD (18004.0) -
RD 形式で記述されたファイルを解析するためのクラスです。
RD 形式で記述されたファイルを解析するためのクラスです。
解析された情報はコメントとして扱われます。 -
RDoc
:: Parser :: Ruby (18004.0) -
Ruby のソースコードを解析するためのクラスです。
Ruby のソースコードを解析するためのクラスです。 -
RDoc
:: Parser :: Simple (18004.0) -
ソースコード以外のファイルを解析するためのクラスです。
ソースコード以外のファイルを解析するためのクラスです。 -
RDoc
:: Parser :: Simple # remove _ private _ comments(comment) -> String (18004.0) -
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返 します。
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返
します。
@param comment 対象の文字列を指定します。
@return コメントが削除された文字列を返します。 -
RDoc
:: Options (9304.0) -
rdoc コマンドのオプションを解析するためのクラスです。
...rdoc コマンドのオプションを解析するためのクラスです。
それぞれのオプションの詳細に関しては、lib:rdoc#usage を参照してくだ
さい。
===[a:custom_options] カスタムオプション
RDoc のジェネレータでは、RDoc::Options をフックし......まれていた場合、RDoc はジェネ
レータ独自のオプションを解析するために setup_options メソッドを呼び出し
ます。カスタムオプションを指定する場合は --format オプションは必ず指定
する必要があります。rdoc --help を実行する......ます。
例:
class RDoc::Generator::Spellcheck
RDoc::RDoc.add_generator self
def self.setup_options rdoc_options
op = rdoc_options.option_parser
op.on('--spell-dictionary DICTIONARY',
RDoc::Options::Path) do |dictionary|
# RDoc::Options に spell_dicti...