るりまサーチ

最速Rubyリファレンスマニュアル検索！
240件ヒット [1-100件を表示] （0.021秒）
トップページ > クエリ:rd[x] > クエリ:document[x]

別のキーワード

  1. socket shut_rd
  2. pstore rd_access
  3. rd scan
  4. rdoc/parser/rd rd
  5. constants shut_rd

種類

ライブラリ

クラス

モジュール

キーワード

検索結果

先頭5件

  1. rdoc/parser/c
  2. rdoc
  3. rdoc/parser/changelog
  4. RDoc::RDoc#document(argv) -> nil
  5. RDoc::CodeObject#document_children -> bool
<< 1 2 3 > >>

rdoc/parser/c (26024.0)

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析するためのサブライブラリです。

...必要があります。

また、Ruby のソースコードとは別にコメントには特別な命令を指定する事がで
きます。

: Document-class: name

記述する内容を name で指定した Ruby のクラスのものに指定します。同じ
.c ファイルに複数のク...
...数の
xxx の部分がクラス名と同一ではない場合に使用します。

: Document-method: name

記述する内容を name で指定した Ruby のメソッドのものに指定します。
RDoc が対応するメソッドを見つけられなかった場合に使用します。...
...また、RDoc は rb_define_method などの定義と C 言語の関数の実装が同じファ
イルにある事を前提としています。そうでない場合は以下のような指定を行います。

rb_define_method(....); // in ファイル名

例:

/*
* Document-class: MyC...

rdoc (26018.0)

RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。

...RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。

このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby...
...マットに変換するた
めのライブラリです。RDoc によってメソッドやクラスに関するドキュメントを
生成するとき、コメント部を変換するために使われます。

=== ロードマップ

* RDoc で Ruby のソースファイルに対するドキュ...
... rdoc です。
markdown、rd、rdoc、tomdoc のいずれかから選択できます。

: --root root

Root of the source tree documentation will be generated for. Set this
when building documentation outside the source directory. Default is
the current directory.

: --page-dir dir

Di...

rdoc/parser/changelog (26006.0)

ChangeLog ファイルを解析するためのサブライブラリです。

...RDoc::Markup::Document オブジェクト
に変換します。出力される HTML はサイドバーに日ごとに分けられます。

このサブライブラリは主に MRI の ChangeLog を解析するために使われますが、
GNU style の ChangeLog(http://www.gnu.org/prep/standards/h...

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

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

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

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

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

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

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

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

@see RDoc::CodeObject#document_self...

絞り込み条件を変える

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

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

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

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

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

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

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

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

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

@see RDoc::CodeObject#document_children...

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

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

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

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

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

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

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

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

検索対象のドキュメントは るりまプロジェクト の成果物です。

検索エンジンは Groonga 14.1.2 を使っています。

Groongaは Rroonga 12.1.0 経由で利用しています。

Powered by Ruby 3.1.2.

るりまサーチのリポジトリ は GitHub 上にあります。