検索結果

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

• 2.2.0

• インスタンスメソッド

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

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

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

@raise RDoc::Error ドキュメントの処理中にエラーがあった場合に発生します。

指定できるオプションについては、lib:rdoc#usage を参照してくださ
い。出力ディレクトリが指定されなかった場合はカレントディレクトリ の
doc 以下に出力します。

• RDoc::RDoc

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

• 2.2.0

• インスタンスメソッド

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

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

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

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

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

• RDoc::CodeObject

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

• 2.2.0

• インスタンスメソッド

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

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

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

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

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

• RDoc::CodeObject

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

• 2.2.0

• インスタンスメソッド

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

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

@see RDoc::CodeObject#document_self

• RDoc::CodeObject

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

• 2.2.0

• インスタンスメソッド

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

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

@see RDoc::CodeObject#document_children

• RDoc::CodeObject

絞り込み条件を変える

RDoc::CodeObject#documented? -> bool (27304.0)

• 2.2.0

• インスタンスメソッド

出力すべきドキュメントがあるかどうかを返します。

出力すべきドキュメントがあるかどうかを返します。

• RDoc::CodeObject

RDoc::Markdown#parse(markdown) -> RDoc::Markup::Document (9706.0)

• 2.2.0

• インスタンスメソッド

引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。

引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。

@param markdown 解析の対象になるドキュメントを文字列で指定します。

• RDoc::Markdown
• RDoc::Markup::Document

RDoc::Text#parse(text) -> RDoc::Markup::Document | Array (9676.0)

• 2.2.0

• インスタンスメソッド

引数から RDoc::Text#normalize_comment でスペースや改行文字などを削 除した後に解析を行います。

引数から RDoc::Text#normalize_comment でスペースや改行文字などを削
除した後に解析を行います。

@param text 文字列を指定します。

@see RDoc::Text#normalize_comment

• RDoc::Text

RDoc::CodeObject#start_doc -> () (9142.0)

• 2.2.0

• インスタンスメソッド

以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまで の間、ドキュメントに含めます。

以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまで
の間、ドキュメントに含めます。

:startdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を true に設定します。

@see RDoc::CodeObject#end_doc

• RDoc::CodeObject

RDoc::CodeObject#stop_doc -> () (9142.0)

• 2.2.0

• インスタンスメソッド

以降に解析したコメントを RDoc::CodeObject#start_doc を呼び出すま での間、ドキュメントに含めません。

以降に解析したコメントを RDoc::CodeObject#start_doc を呼び出すま
での間、ドキュメントに含めません。

:stopdoc: を見つけた時に呼び出されます。
RDoc::CodeObject#document_self と
RDoc::CodeObject#document_children を false に設定します。

@see RDoc::CodeObject#start_doc

• RDoc::CodeObject

絞り込み条件を変える

RDoc::CodeObject#remove_classes_and_modules -> () (9100.0)

• 2.2.0

• インスタンスメソッド

何もしません。RDoc::CodeObject#document_children= に false を指定 した時のコールバックとして呼び出されます。オーバーライドして使用します。

何もしません。RDoc::CodeObject#document_children= に false を指定
した時のコールバックとして呼び出されます。オーバーライドして使用します。

• RDoc::CodeObject

RDoc::CodeObject#remove_methods_etc -> () (9100.0)

• 2.2.0

• インスタンスメソッド

何もしません。RDoc::CodeObject#document_self= に false を指定した 時のコールバックとして呼び出されます。オーバーライドして使用します。

何もしません。RDoc::CodeObject#document_self= に false を指定した
時のコールバックとして呼び出されます。オーバーライドして使用します。

• RDoc::CodeObject