ライブラリ
-
net
/ http (2) -
rdoc
/ markdown (2) -
rdoc
/ parser (6) -
rdoc
/ parser / c (4) -
rdoc
/ parser / changelog (2) -
rdoc
/ parser / markdown (2) -
rdoc
/ parser / rd (2) -
rdoc
/ parser / ruby (5) -
rdoc
/ parser / ruby _ tools (1) -
rdoc
/ parser / simple (4) -
rdoc
/ parser / text (1) -
rdoc
/ text (1)
クラス
-
RDoc
:: Markdown (2) -
RDoc
:: Options (3) -
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)
モジュール
-
Net
:: HTTPHeader (2) -
RDoc
:: Text (1)
キーワード
- ChangeLog (1)
- Markdown (1)
- NORMAL (1)
- Parser (1)
- Ruby (1)
- RubyTools (1)
- SINGLE (1)
- Simple (1)
- Text (1)
-
alias
_ extension (1) -
basic
_ auth (1) -
can
_ parse (1) - new (3)
-
option
_ parser (1) -
option
_ parser= (1) -
optparse
/ shellwords (1) -
parse
_ files _ matching (1) -
parser
_ for (1) - parsers (1)
- progress= (1)
-
proxy
_ basic _ auth (1) -
rdoc
/ parser (1) -
rdoc
/ parser / c (1) -
rdoc
/ parser / changelog (1) -
rdoc
/ parser / markdown (1) -
rdoc
/ parser / rd (1) -
rdoc
/ parser / ruby (1) -
rdoc
/ parser / ruby _ tools (1) -
rdoc
/ parser / simple (1) -
rdoc
/ parser / text (1) -
remove
_ private _ comments (1) - scan (6)
検索結果
先頭5件
-
RDoc
:: Parser :: RD (81049.0) -
RD 形式で記述されたファイルを解析するためのクラスです。
RD 形式で記述されたファイルを解析するためのクラスです。
解析された情報はコメントとして扱われます。 -
RDoc
:: Markdown # parse(markdown) -> RDoc :: Markup :: Document (72952.0) -
引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。
引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。
@param markdown 解析の対象になるドキュメントを文字列で指定します。 -
RDoc
:: Markdown . parse(markdown) -> RDoc :: Markup :: Document (72952.0) -
引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。
引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。
@param markdown 解析の対象になるドキュメントを文字列で指定します。 -
RDoc
:: Text # parse(text) -> RDoc :: Markup :: Document | Array (72904.0) -
引数から RDoc::Text#normalize_comment でスペースや改行文字などを削 除した後に解析を行います。
引数から RDoc::Text#normalize_comment でスペースや改行文字などを削
除した後に解析を行います。
@param text 文字列を指定します。
@see RDoc::Text#normalize_comment -
RDoc
:: Options # parse(argv) -> () (72304.0) -
コマンドライン引数を解析します。
コマンドライン引数を解析します。
@param argv コマンドライン引数を文字列の配列で指定します。
また、以下のような指定をした場合は標準エラーに出力を行い、終了コード 1
でプログラムを終了します。
* --extension オプションに拡張子を 2 つ指定しなかった場合
* --extension オプションに new=old を指定した時に old を扱えるフォーマッ
タがない場合
* --fmt オプションに扱えない出力を指定した場合 -
RDoc
:: Parser :: C (72049.0) -
C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析するためのクラスです。
C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析するためのクラスです。 -
rdoc
/ parser / rd (72049.0) -
RD 形式で記述されたファイルを解析するためのサブライブラリです。
RD 形式で記述されたファイルを解析するためのサブライブラリです。 -
RDoc
:: Parser . can _ parse(file _ name) -> RDoc :: Parser | nil (55204.0) -
file_name を解析できるパーサクラスを返します。見つからなかった場合は nil を返します。
file_name を解析できるパーサクラスを返します。見つからなかった場合は
nil を返します。
@param file_name 解析するファイルの名前を指定します。 -
RDoc
:: Parser # parse _ files _ matching(regexp) -> () (54622.0) -
regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、 自身を登録します。
regexp で指定した正規表現にマッチするファイルを解析できるパーサとして、
自身を登録します。
@param regexp 正規表現を指定します。
新しいパーサを作成する時に使用します。
例:
class RDoc::Parser::Xyz < RDoc::Parser
parse_files_matching /\.xyz$/
...
end -
rdoc
/ parser (54145.0) -
rdoc で解析できるファイルの種類を追加するためのサブライブラリです。
rdoc で解析できるファイルの種類を追加するためのサブライブラリです。
以下のメソッドを定義したクラスを作成する事で、新しいパーサクラスを作成
する事ができます。
* #initialize(top_level, file_name, body, options, stats)
* #scan
initialize メソッドは以下の引数を受け取ります。
* top_level RDoc::TopLevel オブジェクトを指定します。
* file_name: file_name ファイル名を文字列で指定します。
* body: ソースコードの内容を文字列で指定します。
*... -
rdoc
/ parser / c (54121.0) -
C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析するためのサブライブラリです。
C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析するためのサブライブラリです。
C 言語で記述された拡張ライブラリなどを解析するのに使用します。
rb_define_class や rb_define_method などで定義されたものに
対応する C 言語の関数のコメントを解析します。
例: Array#flatten の場合。rb_ary_flatten のコメントが解析されます。
/*
* Returns a new array that is a one-dimensional flattening of this
* arra... -
rdoc
/ parser / ruby _ tools (54097.0) -
RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー ドのパーサを記述するためのモジュールを定義するサブライブラリです。
RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー
ドのパーサを記述するためのモジュールを定義するサブライブラリです。 -
rdoc
/ parser / changelog (54019.0) -
ChangeLog ファイルを解析するためのサブライブラリです。
ChangeLog ファイルを解析するためのサブライブラリです。
ChangeLog ファイルを解析して、RDoc::Markup::Document オブジェクト
に変換します。出力される HTML はサイドバーに日ごとに分けられます。
このサブライブラリは主に MRI の ChangeLog を解析するために使われますが、
GNU style の ChangeLog(http://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html
参照)であれば解析できます。 -
rdoc
/ parser / ruby (54019.0) -
Ruby のソースコードを解析するためのサブライブラリです。
Ruby のソースコードを解析するためのサブライブラリです。
拡張子が .rb、.rbw のファイルを解析する事ができます。
=== メタプログラミングされたメソッド
動的に定義されたメソッドをドキュメントに含めたい場合、## でコメントを開始します。
##
# This is a meta-programmed method!
add_my_method :meta_method, :arg1, :arg2
RDoc::Parser::Ruby は上記の :meta_method ようにメソッドの定義を行
うような識別子の後に続くトークンをメソッド名として解釈します。... -
rdoc
/ parser / markdown (54001.0) -
Markdown 形式で記述されたファイルを解析するためのサブライブラリです。
Markdown 形式で記述されたファイルを解析するためのサブライブラリです。 -
rdoc
/ parser / simple (54001.0) -
ソースコード以外のファイルを解析するためのサブライブラリです。
ソースコード以外のファイルを解析するためのサブライブラリです。
ファイルの内容すべてを 1 つの大きなコメントとして処理します。ただし、ファ
イルの先頭が # で始まっていた場合、先頭行は削除されます。 -
rdoc
/ parser / text (54001.0) -
プログラムを含まないテキストを解析するためのサブライブラリです。
プログラムを含まないテキストを解析するためのサブライブラリです。 -
RDoc
:: Parser . parser _ for(top _ level , file _ name , body , options , stats) -> RDoc :: Parser (46303.0) -
file_name を解析できるパーサのインスタンスを返します。 見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。
file_name を解析できるパーサのインスタンスを返します。
見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。
@param top_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body ソースコードの内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats オブジェクトを指定します。 -
RDoc
:: Parser . parsers -> [[Regexp , RDoc :: Parser]] (46249.0) -
RDoc::Parser#parse_files_matching で登録した正規表現とパーサクラ スの配列の配列を返します。
RDoc::Parser#parse_files_matching で登録した正規表現とパーサクラ
スの配列の配列を返します。 -
RDoc
:: Parser :: RD # scan -> RDoc :: TopLevel (45667.0) -
RD 形式で記述されたファイルを解析します。
RD 形式で記述されたファイルを解析します。
@return RDoc::TopLevel オブジェクトを返します。 -
RDoc
:: Parser :: C # scan -> RDoc :: TopLevel (36667.0) -
C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析します。
C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析します。
@return RDoc::TopLevel オブジェクトを返します。 -
RDoc
:: Parser :: Simple # scan -> RDoc :: TopLevel (36667.0) -
自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し ます。
自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し
ます。
@return RDoc::TopLevel オブジェクトを返します。 -
RDoc
:: Options # option _ parser -> OptionParser | nil (36649.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを返し ます。
コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。 -
RDoc
:: Parser :: ChangeLog # scan -> RDoc :: TopLevel (36619.0) -
ChangeLog ファイルを解析します。
ChangeLog ファイルを解析します。
@return RDoc::TopLevel オブジェクトを返します。 -
RDoc
:: Parser :: Markdown # scan -> RDoc :: TopLevel (36619.0) -
Markdown 形式で記述されたファイルを解析します。
Markdown 形式で記述されたファイルを解析します。
@return RDoc::TopLevel オブジェクトを返します。 -
RDoc
:: Parser :: Ruby # scan -> RDoc :: TopLevel (36619.0) -
Ruby のソースコードからクラス/モジュールのドキュメントを解析します。
Ruby のソースコードからクラス/モジュールのドキュメントを解析します。
@return RDoc::TopLevel オブジェクトを返します。 -
RDoc
:: Parser :: Simple # remove _ private _ comments(comment) -> String (36601.0) -
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返 します。
行頭の "--" から "++" で囲まれたコメントを comment から削除した結果を返
します。
@param comment 対象の文字列を指定します。
@return コメントが削除された文字列を返します。 -
RDoc
:: Options # option _ parser=(val) (36367.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを設定 します。
コマンドライン引数の解析のための OptionParser オブジェクトを設定
します。
@param val OptionParser オブジェクトを指定します。 -
optparse
/ shellwords (36067.0) -
OptionParser#on で使用可能な引数に Shellwords 追加されます。 オプションの引数は Shellwords.#shellwords によって配列に変換されてから、 OptionParser#on のブロックに渡されます。
OptionParser#on で使用可能な引数に Shellwords
追加されます。
オプションの引数は Shellwords.#shellwords によって配列に変換されてから、
OptionParser#on のブロックに渡されます。
//emlist[][ruby]{
require 'optparse/shellwords'
opts = OptionParser.new
opts.on("-s VAL", Shellwords){|a|
p a #=> ["hoge", "foo", "bar"]
}
opts.parse!
# ruby command -s hog... -
RDoc
:: Parser (36001.0) -
ソースコードを解析するパーサを生成するための基本クラスです。
ソースコードを解析するパーサを生成するための基本クラスです。
新しいパーサを作成する場合には継承して使用します。 -
RDoc
:: Parser :: ChangeLog (36001.0) -
ChangeLog ファイルを解析するためのクラスです。
ChangeLog ファイルを解析するためのクラスです。 -
RDoc
:: Parser :: C . new(top _ level , file _ name , body , options , stats) -> RDoc :: Parser :: C (27958.0) -
自身を初期化します。
自身を初期化します。
@param top_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 (27955.0) -
自身を初期化します。
自身を初期化します。
@param top_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 (27955.0) -
自身を初期化します。
自身を初期化します。
@param top_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body 内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats オブジェクトを指定します。 -
RDoc
:: Parser :: RubyTools (27115.0) -
RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー ドのパーサを記述するためのメソッドを定義するモジュールです。
RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー
ドのパーサを記述するためのメソッドを定義するモジュールです。
RDoc::Parser を継承していないため、パーサクラスとしては利用できま
せん。
ライブラリの内部で使用します。 -
RDoc
:: Parser :: C # progress=(val) (27067.0) -
進捗を出力する IO を指定します。
進捗を出力する IO を指定します。
@param val 進捗を出力する IO を指定します。指定しなかった場合は
$stderr が使われます。 -
RDoc
:: Parser :: Text (27019.0) -
プログラムを含まないテキストを解析するためのクラスです。
プログラムを含まないテキストを解析するためのクラスです。
単体では使用せず、RDoc::Parser のサブクラスで RDoc::Parser::Text
を include する事で、プログラムを含んでいない事を rdoc に伝えます。 -
RDoc
:: Parser . alias _ extension(old _ ext , new _ ext) -> bool (27001.0) -
old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登 録します。
old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登
録します。
@param old_ext 拡張子を文字列で指定します。
@param new_ext 拡張子を文字列で指定します。
@return エイリアスが登録された場合は true を返します。old_ext にパーサ
が登録されていない場合、エイリアスが登録されずに false を返しま
す。 -
RDoc
:: Parser :: Markdown (27001.0) -
Markdown 形式で記述されたファイルを解析するためのクラスです。
Markdown 形式で記述されたファイルを解析するためのクラスです。
解析された情報はコメントとして扱われます。 -
RDoc
:: Parser :: Ruby (27001.0) -
Ruby のソースコードを解析するためのクラスです。
Ruby のソースコードを解析するためのクラスです。 -
RDoc
:: Parser :: Ruby :: NORMAL -> " :: " (27001.0) -
RDoc::NormalClass type
RDoc::NormalClass type -
RDoc
:: Parser :: Ruby :: SINGLE -> "<<" (27001.0) -
RDoc::SingleClass type
RDoc::SingleClass type -
RDoc
:: Parser :: Simple (27001.0) -
ソースコード以外のファイルを解析するためのクラスです。
ソースコード以外のファイルを解析するためのクラスです。 -
Net
:: HTTPHeader # basic _ auth(account , password) -> [String] (18619.0) -
Authorization: ヘッダを BASIC 認証用にセットします。
Authorization: ヘッダを BASIC 認証用にセットします。
@param account アカウント名を文字列で与えます。
@param password パスワードを文字列で与えます。
//emlist[例][ruby]{
require 'net/http'
uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.basic_auth("user", "pass") # => ["Basic dXNlcjpwYXNz"]
//}... -
Net
:: HTTPHeader # proxy _ basic _ auth(account , password) -> [String] (18619.0) -
Proxy 認証のために Proxy-Authorization: ヘッダをセットします。
Proxy 認証のために Proxy-Authorization: ヘッダをセットします。
@param account アカウント名を文字列で与えます。
@param password パスワードを文字列で与えます。
//emlist[例][ruby]{
require 'net/http'
uri = URI.parse('http://www.example.com/index.html')
req = Net::HTTP::Get.new(uri.request_uri)
req.proxy_basic_auth("account", "password") # => ["Ba...