クエリ:document > クエリ:rdoc > バージョン:3.4

24件ヒット [1-24件を表示] （0.019秒）

トップページ >

:document

:rdoc

:3.4

別のキーワード

種類

ライブラリ

クラス

モジュール

RDoc (1)
RDoc::Text (1)

キーワード

検索結果

rdoc (115141.0)

ライブラリ

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

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

このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby のソースファイルに対するドキュメントを生成
するアプリケーションです。 JavaDoc と同様に、ソースを解析し、クラス、モ
ジュール、メソッドの定義を抜き出してきます(include,require もです)。そ
してこれらの内容とその直前に書かれたコメントを併合し、ドキュメントを出
力します(現在は HTML しか出力できませんが、こ...

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

インスタンスメソッド

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

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

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

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

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

RDoc::DOT_DOC_FILENAME -> ".document" (51352.0)

定数

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

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

インスタンスメソッド

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

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

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

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

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

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

インスタンスメソッド

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

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

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#document_self

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

インスタンスメソッド

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

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

@see RDoc::CodeObject#document_children

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

インスタンスメソッド

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

RDoc::RDoc (27247.0)

クラス

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

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

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

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

args には rdoc コマンドに渡すのと同様の引数を文字列の配列で指定します。

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

rdoc/parser/c (18109.0)

ライブラリ

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

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

C 言語で記述された拡張ライブラリなどを解析するのに使用します。
rb_define_class や rb_define_method などで定義されたものに
対応する C 言語の関数のコメントを解析します。

例: Array#flatten の場合。rb_ary_flatten のコメントが解析されます。

/*
* Returns a new array that is a one-dimensional flattening of this
* arra...

絞り込み条件を変える

Gem::DocumentError (18049.0)

クラス

システムに RDoc がインストールされていない場合に使用する例外です。

rdoc/parser/changelog (18037.0)

ライブラリ

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

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

ChangeLog ファイルを解析して、RDoc::Markup::Document オブジェクト
に変換します。出力される HTML はサイドバーに日ごとに分けられます。

このサブライブラリは主に MRI の ChangeLog を解析するために使われますが、
GNU style の ChangeLog(http://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html
参照)であれば解析できます。

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

インスタンスメソッド

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

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

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

RDoc::Markdown.parse(markdown) -> RDoc::Markup::Document (9703.0)

特異メソッド

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

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

インスタンスメソッド

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

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

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

@see RDoc::Text#normalize_comment

絞り込み条件を変える

RDoc::CodeObject#start_doc -> () (9139.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#stop_doc -> () (9139.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#remove_classes_and_modules -> () (9097.0)

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

NEWS for Ruby 2.0.0 (253.0)

文書

NEWS for Ruby 2.0.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。

NEWS for Ruby 2.0.0
このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。

それぞれのエントリーは参照情報があるため短いです。
十分な情報と共に書かれた全ての変更のリストは ChangeLog ファイルか bugs.ruby-lang.org の issue を参照してください。

== 1.9.3 以降の変更

=== 言語仕様の変更

* キーワード引数を追加しました
* %i, %I をシンボルの配列作成のために追加しました。(%w, %W に似ています)
* デフォルトのソースエンコーディングを US-ASCI...

絞り込み条件を変える

Ruby用語集 (91.0)

文書

Ruby用語集 A　B　C　D　E　F　G　I　J　M　N　O　R　S　Y

Ruby用語集
A　B　C　D　E　F　G　I　J　M　N　O　R　S　Y

a　ka　sa　ta　na　ha　ma　ya　ra　wa

=== 記号・数字
: %記法
: % notation
「%」記号で始まる多種多様なリテラル記法の総称。

参照：d:spec/literal#percent

: 0 オリジン
: zero-based
番号が 0 から始まること。

例えば、
Array や Vector、Matrix などの要素の番号、
String における文字の位置、
といったものは 0 オリジンである。

: 1 オリジン
: one-based
...

NEWS for Ruby 2.5.0 (73.0)

文書

NEWS for Ruby 2.5.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。

...加 12063

* FrozenError
* 新しい例外クラスです 13224

=== 標準添付ライブラリの更新

* bigdecimal
* BigDecimal 1.3.4 に更新
* BigDecimal::VERSION を追加
* 非推奨(1.4.0で削除予定)
* BigDecimal.new
* BigDecimal.ver
* BigDecimal#cl...

ruby 1.8.4 feature (73.0)

文書

ruby 1.8.4 feature ruby 1.8.4 での ruby 1.8.3 からの変更点です。

ruby 1.8.4 feature
ruby 1.8.4 での ruby 1.8.3 からの変更点です。

掲載方針

*バグ修正の影響も含めて動作が変わるものを収録する。
*単にバグを直しただけのものは収録しない。
*ライブラリへの単なる定数の追加は収録しない。

以下は各変更点に付けるべきタグです。

記号について(特に重要なものは大文字(主観))

# * カテゴリ
# * [ruby]: ruby インタプリタの変更
# * [api]: 拡張ライブラリ API
# * [lib]: ライブラリ
* レベル
* [bug]: バグ修正
* [new]: 追加され...

NEWS for Ruby 2.6.0 (55.0)

文書

NEWS for Ruby 2.6.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。

NEWS for Ruby 2.6.0
このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。

それぞれのエントリーは参照情報があるため短いです。
十分な情報と共に書かれた全ての変更のリストは ChangeLog ファイルか bugs.ruby-lang.org の issue を参照してください。

== 2.5.0 以降の変更

=== 言語仕様の変更

* $SAFE はプロセスグローバルで扱われることになると共に、0以外を設定した後に0に戻せるようになりました。 14250

* Refinements がブロック引数にも反映されるよ...

別のキーワード

種類

ライブラリ

クラス

モジュール

キーワード

検索結果

先頭5件

rdoc (115141.0)

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

RDoc::DOT_DOC_FILENAME -> ".document" (51352.0)

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

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

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

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

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

RDoc::RDoc (27247.0)

rdoc/parser/c (18109.0)

Gem::DocumentError (18049.0)

rdoc/parser/changelog (18037.0)

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

RDoc::Markdown.parse(markdown) -> RDoc::Markup::Document (9703.0)

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

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

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

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

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

NEWS for Ruby 2.0.0 (253.0)

Ruby用語集 (91.0)

NEWS for Ruby 2.5.0 (73.0)

ruby 1.8.4 feature (73.0)

NEWS for Ruby 2.6.0 (55.0)