検索結果

RDoc::RDoc#document(argv) -> nil (24214.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) -> () (12332.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 ドキュメントの始まりで呼び出されます。

...がない場合は空の配列が渡されます。

tag_directives には tag directive の配列が渡されます。
それぞれの tag は [prefix, suffix] という配列で表現されます。

implicit にはドキュメントが implicit に始まっているかどうかが
真偽値で渡...

...さい。


@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) (12220.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) (12220.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 (12214.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 (12214.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::Handler#end_document(implicit) -> () (12208.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 です...

...。
---
hello world

また、以下の YAML ドキュメントでは implicit は false です。
---
hello world
......

• Psych::Handler

REXML::Element#delete_attribute(key) -> REXML::Attribute | nil (9313.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

• インスタンスメソッド

要素から key という属性名の属性を削除します。

...。

@param key 削除する要素(文字列(属性名) or REXML::Attributeオブジェクト)

//emlist[][ruby]{
require 'rexml/document'
e = REXML::Element.new("E")
e.add_attribute("x", "foo"); e # => <E x='foo'/>
e.add_attribute("y:x", "bar"); e # => <E x='foo' y:x='bar'/>
e.delete_attribute("x")...

• REXML::Attribute
• REXML::Element

Psych::Nodes::Document#tag_directives=(tags) (9225.0)

• 2.1.0
• 2.6.0
• 3.0
• 3.1

• インスタンスメソッド

tag directive の配列を設定します。

...tag directive の配列を設定します。

@param tags 設定する tag directive の配列
@see Psych::Nodes::Document#tag_directives,
Psych::Nodes::Document.new...

• Psych::Nodes::Document