検索結果

RDoc::RDoc#document(argv) -> nil (18113.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ レクトリに出力します。

...ォーマットして指定されたディ
レクトリに出力します。

@param argv コマンドラインで rdoc コマンドに指定するのと同じ引数を文字
列の配列で指定します。

@raise RDoc::Error ドキュメントの処理中にエラーがあった場...

• RDoc::RDoc

Psych::Handler#start_document(version, tag_directives, implicit) -> () (6131.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

YAML ドキュメントの始まりで呼び出されます。

...さい。


@param version バージョン
@param tag_directives tag directive の配列
@param implicit ドキュメントが implicit に始まっているかどうか

=== 例

以下の YAML に対しては
%YAML 1.1
%TAG ! tag:tenderlovemaking.com,2009:
--- !squee
start_document に渡さ...

...version # => [1, 1]
tag_directives # => tenderlovemaking.com,2009:"
implicit # => false

以下の YAML に対しては
- x
- y
start_document に渡される引数は以下の通りです。
version # => []
tag_directives # => []
implicit # => true...

• Psych::Handler

RDoc::CodeObject#document_children=(val) (6119.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを設定します。

...トに含めるか
どうかを設定します。

:nodoc:、:stopdoc: を指定した時に false が設定されます。

@param val true を指定した場合、上記をドキュメントに含めます。

@see RDoc::CodeObject#document_self=,
RDoc::CodeObject#remove_classes_and_modules...

• RDoc::CodeObject

RDoc::CodeObject#document_self=(val) (6119.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

自身をドキュメントに含めるかどうかを設定します。

...c: を指定した時に true が設定されます。
:nodoc:、:stopdoc: を指定した時に false が設定されます。

@param val true を指定した場合、自身をドキュメントに含めます。

@see RDoc::CodeObject#document_children=,
RDoc::CodeObject#remove_methods_etc...

• RDoc::CodeObject

RDoc::CodeObject#document_children -> bool (6113.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを返します。

...自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか
どうかを返します。

@see RDoc::CodeObject#document_self...

• RDoc::CodeObject

絞り込み条件を変える

RDoc::CodeObject#document_self -> bool (6113.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

自身をドキュメントに含めるかどうかを返します。

...自身をドキュメントに含めるかどうかを返します。

@see RDoc::CodeObject#document_children...

• RDoc::CodeObject

Psych.load_documents(yaml) -> [object] (6112.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0

• 特異メソッド

複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。 このメソッドは deprecated です。Psych.load_stream を代わりに 使ってください。

...します。
このメソッドは deprecated です。Psych.load_stream を代わりに
使ってください。

@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します...

• Psych

Psych.load_documents(yaml) {|obj| ... } -> () (6112.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0

• 特異メソッド

複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。 このメソッドは deprecated です。Psych.load_stream を代わりに 使ってください。

...します。
このメソッドは deprecated です。Psych.load_stream を代わりに
使ってください。

@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します...

• Psych

Psych::Handler#end_document(implicit) -> () (6107.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

ドキュメントが終了したときに呼び出されます。

...が implicit に終わったならば implicit には真が渡されます。

必要に応じてこのメソッドを override してください。

@param implicit ドキュメントが implicit に終わったかどうか

=== 例

以下の YAML ドキュメントでは implicit は true です...

• Psych::Handler

Psych::Nodes::Document.new(version=[], tag_directives=[], implicit=false) -> Psych::Nodes::Document (3159.0)

• 2.1.0
• 2.2.0
• 2.4.0
• 2.5.0
• 2.6.0
• 3.1
• 3.2
• 3.3

• 特異メソッド

Document オブジェクトを生成します。

...
Document オブジェクトを生成します。

version にはドキュメントのバージョンを指定します。
[major, minor] という配列で指定します。

tag_directives には tag directive の配列を指定します。
それぞれの tag は [prefix, suffix] という文字...

...キュメントが implicit に始まっているかどうかを
真偽値で指定します。

@param version YAML ドキュメントのバージョン
@param tag_directives tag directive の配列
@param implicit ドキュメントが implicit に始まっているかどうか

=== 例
以下の...

...YAML 1.1 のドキュメントで、
tag directive を1つ持ち、 implicit にドキュメントが開始
している Document オブジェクトを生成しています。

Psych::Nodes::Document.new(
[1,1],
tenderlovemaking.com,2009:",
true)

@see Psych::Handler#start_document...

• Psych::Nodes::Document

絞り込み条件を変える