検索結果

RDoc::RDoc#document(argv) -> nil (24120.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 で与えられた引数を元にドキュメントをフォーマットして指定されたディ レクトリに出力します。

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

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

指定できるオプションについては、lib:rdoc#usage を参照し...

• RDoc::RDoc

RDoc::DOT_DOC_FILENAME -> ".document" (21119.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

• 定数

rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。

...
rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。...

• RDoc

RDoc::RDoc (21083.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

• クラス

rdoc ドキュメントの作成を行うクラスです。

...rdoc ドキュメントの作成を行うクラスです。

以下のようにして、rdoc コマンドを実行するのと同様に実行します。

require 'rdoc/rdoc'
rdoc = RDoc::RDoc.new
rdoc.document(args)

args には rdoc コマンドに渡すのと同様の引数を文字列...

...の配列で指定します。

rdoc コマンドと同様に変換結果はファイルに出力されるため、テキストを
HTML に変換する部分をライブラリとして使用したい場合、
rdoc/markup を参照してください。...

• rdoc/markup

RDoc::CodeObject#document_children=(val) (9120.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) (9120.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 (9114.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 (9114.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

RDoc::CodeObject#documented? -> bool (9101.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

• インスタンスメソッド

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

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

• RDoc::CodeObject

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

• 2.1.0
• 2.2.0
• 2.3.0
• 3.4

• インスタンスメソッド

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

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

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

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