クエリ:r > クエリ:rdoc > バージョン:3.1

417件ヒット [1-100件を表示] （0.110秒）

トップページ >

:rdoc

:3.1

別のキーワード

種類

ライブラリ

クラス

モジュール

キーワード

検索結果

<< 1 2 3 ... > >>

rdoc (193123.0)

ライブラリ

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

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

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

rdoc/markup/to_rdoc (132067.0)

ライブラリ

RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるためのサブライブラリです。

RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
サブライブラリです。

サブクラス(RDoc::Markup::ToAnsi など)を作成して使います。

rdoc/rdoc (132049.0)

ライブラリ

rdoc コマンドのためのサブライブラリです。

rdoc/parser/rd (114001.0)

ライブラリ

RD 形式で記述されたファイルを解析するためのサブライブラリです。

rdoc/generator (96547.0)

ライブラリ

RDoc が解析したソースコードを RDoc::CodeObject のツリーからその他の形式に出力するためのサブライブラリです。

RDoc が解析したソースコードを RDoc::CodeObject のツリーから
その他の形式に出力するためのサブライブラリです。

RDoc には HTML 向けのジェネレータの
RDoc::Generator::Darkfish と ri 向けのジェネレータの
RDoc::Generator::RI が付属しています。

=== ジェネレータの登録

RDoc::RDoc.add_generator を呼び出す事でジェネレータの登録が行えます。

class My::Awesome::Generator
RDoc::RDoc.add_generator self
end
...

絞り込み条件を変える

rdoc/markup (96283.0)

ライブラリ

RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。

RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。

RDoc::Markup は RDoc 形式のドキュメント、Wiki エントリ、Web上の
FAQ などを想定したプレインテキストから様々なフォーマットへの変換を行う
ツール群の基礎として作られています。RDoc::Markup 自身は何の出力も
行いません。
それらは output_format で後述するクラス群に委ねられています。

=== Markup

基本的には、lib:rdoc#markup と同じです。ただし、rdoc コマンドと
は異なり、Ruby のソースコードのコメント部分ではなく、プレイン...

rdoc/markdown (96265.0)

ライブラリ

Markdown 形式で記述されたドキュメントを rdoc 上で解析するためのサブライブラリです。

Markdown 形式で記述されたドキュメントを rdoc 上で解析するための
サブライブラリです。

詳しくは以下を参照してください。

* https://daringfireball.net/projects/markdown/syntax

Markdown 形式をデフォルトのフォーマットにする場合は、
lib:rdoc#saved_options を参考にプロジェクトのデフォルトを
.rdoc_options ファイルで設定してください。

=== 拡張

以降の Markdown の拡張は RDoc のパーサ独自にサポートされているも
のです。ただし、全てがデフォルトで有効にな...

rake/rdoctask (96235.0)

ライブラリ

ドキュメントを作成するためのタスクを定義します。

ドキュメントを作成するためのタスクを定義します。

以下のタスクを定義します。

: rdoc
RDoc を作成します。
: clobber_rdoc
生成された RDoc のファイルを削除します。
このタスクは clobber タスクにも追加されます。
: rerdoc
既に存在する RDoc が古くなくても RDoc を作成します。

例:
Rake::RDocTask.new do |rd|
rd.main = "README.rdoc"
rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
...

rdoc/parser (96211.0)

ライブラリ

rdoc で解析できるファイルの種類を追加するためのサブライブラリです。

rdoc で解析できるファイルの種類を追加するためのサブライブラリです。

以下のメソッドを定義したクラスを作成する事で、新しいパーサクラスを作成
する事ができます。

* #initialize(top_level, file_name, body, options, stats)
* #scan

initialize メソッドは以下の引数を受け取ります。

* top_level RDoc::TopLevel オブジェクトを指定します。
* file_name: file_name ファイル名を文字列で指定します。
* body: ソースコードの内容を文字列で指定します。
*...

rubygems/commands/rdoc_command (96157.0)

ライブラリ

RDoc と ri のライブラリを生成するためのライブラリです。

RDoc と ri のライブラリを生成するためのライブラリです。

Usage: gem rdoc [args] [options]
Options:
--all インストールされている全ての Gem パッケージの
RDoc/RI ドキュメントを生成します。
--[no-]rdoc RDoc を含めます
--[no-]ri RI ...

絞り込み条件を変える

rdoc/markup/to_bs (96103.0)

ライブラリ

RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効果を持たせるように見せるサブライブラリです。

RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効
果を持たせるように見せるサブライブラリです。

require 'rdoc/markup/to_bs'

h = RDoc::Markup::ToBs.new
puts h.convert(input_string)

変換した結果は文字列で取得できます。実際に効果を確認するためにはページャ
などで出力を確認します。

テキスト中の以下のマークアップ記法をエスケープシーケンスの \b と組み合
わせる事によって見た目を変更します。

* イタリック体(_word_): word にアンダーラインを付けて...

rdoc/context (96097.0)

ライブラリ

RDoc::Context と RDoc::Context::Section を定義するサブライブラリです。

RDoc::Context と RDoc::Context::Section を定義するサブライ
ブラリです。

rdoc/parser/ruby_tools (96097.0)

ライブラリ

RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコードのパーサを記述するためのモジュールを定義するサブライブラリです。

RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー
ドのパーサを記述するためのモジュールを定義するサブライブラリです。

rdoc/markup/to_ansi (96085.0)

ライブラリ

RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライブラリです。

RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ
ブラリです。

require 'rdoc/markup/to_ansi'

h = RDoc::Markup::ToAnsi.new
puts h.convert(input_string)

変換した結果は文字列で取得できます。

rdoc/markup/to_html (96085.0)

ライブラリ

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

require 'rdoc/markup/to_html'

h = RDoc::Markup::ToHtml.new
puts h.convert(input_string)

変換した結果は文字列で取得できます。

絞り込み条件を変える

rdoc/markup/to_html_crossref (96067.0)

ライブラリ

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

RDoc::Markup::ToHtml を拡張して、ドキュメント内のメソッド名やクラ
ス名を自動的にリンクにします。

rdoc/alias (96049.0)

ライブラリ

RDoc::Alias を定義するサブライブラリです。

rdoc/anon_class (96049.0)

ライブラリ

RDoc::AnonClass を定義するサブライブラリです。

rdoc/any_method (96049.0)

ライブラリ

RDoc::AnyMethod を定義するサブライブラリです。

rdoc/attr (96049.0)

ライブラリ

RDoc::Attr を定義するサブライブラリです。

絞り込み条件を変える

rdoc/class_module (96049.0)

ライブラリ

RDoc::ClassModule を定義するサブライブラリです。

rdoc/code_object (96049.0)

ライブラリ

RDoc::CodeObject を定義するサブライブラリです。

rdoc/constant (96049.0)

ライブラリ

RDoc::Constant を定義するサブライブラリです。

rdoc/ghost_method (96049.0)

ライブラリ

RDoc::GhostMethod を定義するサブライブラリです。

rdoc/include (96049.0)

ライブラリ

RDoc::Include を定義するサブライブラリです。

絞り込み条件を変える

rdoc/markup/formatter (96049.0)

ライブラリ

RDoc 形式のドキュメントを整形するためのサブライブラリです。

rdoc/meta_method (96049.0)

ライブラリ

RDoc::MetaMethod を定義するサブライブラリです。

rdoc/normal_class (96049.0)

ライブラリ

RDoc::NormalClass を定義するサブライブラリです。

rdoc/normal_module (96049.0)

ライブラリ

RDoc::NormalModule を定義するサブライブラリです。

rdoc/options (96049.0)

ライブラリ

rdoc コマンドのオプションを解析するためのサブライブラリです。

絞り込み条件を変える

rdoc/require (96049.0)

ライブラリ

RDoc::Require を定義するサブライブラリです。

rdoc/single_class (96049.0)

ライブラリ

RDoc::SingleClass を定義するサブライブラリです。

rdoc/stats (96049.0)

ライブラリ

RDoc のステータスを管理するサブライブラリです。

rdoc/top_level (96049.0)

ライブラリ

RDoc::TopLevel を定義するサブライブラリです。

rdoc/generator/json_index (96037.0)

ライブラリ

他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデックスを生成するサブライブラリです。

他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ
クスを生成するサブライブラリです。

This generator is derived from sdoc by Vladimir Kolesnikov and
contains verbatim code written by him.

このジェネレータは HTML ジェネレータと一緒に使うために設計されています。:

class RDoc::Generator::Darkfish
def initialize options
# ...
@base_dir = Pa...

絞り込み条件を変える

rdoc/parser/c (96037.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...

rdoc/parser/changelog (96019.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/parser/ruby (96019.0)

ライブラリ

Ruby のソースコードを解析するためのサブライブラリです。

Ruby のソースコードを解析するためのサブライブラリです。

拡張子が .rb、.rbw のファイルを解析する事ができます。

=== メタプログラミングされたメソッド

動的に定義されたメソッドをドキュメントに含めたい場合、## でコメントを開始します。

##
# This is a meta-programmed method!

add_my_method :meta_method, :arg1, :arg2

RDoc::Parser::Ruby は上記の :meta_method ようにメソッドの定義を行
うような識別子の後に続くトークンをメソッド名として解釈します。...

rdoc/code_objects (96001.0)

ライブラリ

Ruby のソースコード中にあるクラス、モジュール、メソッドなどの構成要素を表現するためのサブライブラリです。

Ruby のソースコード中にあるクラス、モジュール、メソッドなどの構成要素を
表現するためのサブライブラリです。

rdoc/generator/darkfish (96001.0)

ライブラリ

HTML を生成するためのサブライブラリです。

絞り込み条件を変える

rdoc/generator/markup (96001.0)

ライブラリ

ライブラリ内部で使用します。

rdoc/generator/ri (96001.0)

ライブラリ

ri のためのファイルを生成するためのサブライブラリです。

rdoc/known_classes (96001.0)

ライブラリ

Ruby の組み込みクラスに関する定数を定義するサブライブラリです。

rdoc/markdown/entities (96001.0)

ライブラリ

HTML の実体参照のマッピングを表す情報を定義するサブライブラリです。

rdoc/parser/markdown (96001.0)

ライブラリ

Markdown 形式で記述されたファイルを解析するためのサブライブラリです。

絞り込み条件を変える

rdoc/parser/simple (96001.0)

ライブラリ

ソースコード以外のファイルを解析するためのサブライブラリです。

ソースコード以外のファイルを解析するためのサブライブラリです。

ファイルの内容すべてを 1 つの大きなコメントとして処理します。ただし、ファ
イルの先頭が # で始まっていた場合、先頭行は削除されます。

rdoc/parser/text (96001.0)

ライブラリ

プログラムを含まないテキストを解析するためのサブライブラリです。

rdoc/text (96001.0)

ライブラリ

コメントテキストを処理するためのサブライブラリです。

rdoc/token_stream (96001.0)

ライブラリ

トークンを管理するためのサブライブラリです。

int rb_scan_args(int argc, const VALUE *argv, const char *fmt, ...) (78319.0)

関数

長さ argc の配列 argv を fmt に従って解析し、第四引数以降で渡されたアドレスに書き込みます。

長さ argc の配列 argv を fmt に従って
解析し、第四引数以降で渡されたアドレスに書き込みます。

fmt のフォーマットは以下の通りです。

* 必須引数の数 (省略可能な引数があるなら省略不可)
* 省略可能な引数の数 (ゼロ個ならば省略可)
* 残りの引数を Ruby の配列として受け取ることを示す '*' (省略可)
* 最後の引数をオプションハッシュとして受け取る事を示す ':' (省略可)
* ブロックを Proc オブジェクト化して受け取ることを示す '&' (省略可)

これらの指定文字はそれぞれ省略可能ですが、
必ずこの順番で現れなければい...

絞り込み条件を変える

rubygems (78091.0)

ライブラリ

RubyGems を扱うためのクラスやモジュールが定義されているライブラリです。

RubyGems を扱うためのクラスやモジュールが定義されているライブラリです。

===[a:gem_command] gem コマンドの使い方

$ gem help

RubyGems は Ruby のための高機能なパッケージ管理ツールです。
これはより多くの情報へのポインタを含んでいる基本的なヘルプメッセージです。

使用方法:
gem -h/--help
gem -v/--version
gem command [arguments...] [options...]

例:
...

rubygems/commands/install_command (78073.0)

ライブラリ

Gem パッケージをローカルリポジトリにインストールするためのライブラリです。

Gem パッケージをローカルリポジトリにインストールするためのライブラリです。

Usage: gem install GEMNAME [GEMNAME ...] [options] -- --build-flags [options]
Options:
--platform PLATFORM 指定されたプラットフォームの Gem パッケージをインストールします
-v, --version VERSION 指定されたバージョンの Gem パッケージをインストールします
Install/Update Op...

rubygems/doc_manager (78049.0)

ライブラリ

Gem パッケージの RDoc, RI を生成するためのクラスを扱うライブラリです。

rubygems/commands/server_command (78019.0)

ライブラリ

ローカルにインストールされている Gem パッケージとそのドキュメントを HTTP サーバに載せて公開するためのライブラリです。

ローカルにインストールされている Gem パッケージとそのドキュメントを HTTP サーバに
載せて公開するためのライブラリです。

Usage: gem server [options]
Options:
-p, --port=PORT port to listen on
-d, --dir=GEMDIR directory from which to serve gems
--[no-]daemon run as a daemon
...

RDoc::VERSION -> String (69349.0)

定数

RDoc のバージョンを表す文字列を返します。

絞り込み条件を変える

RDoc::ATTR_MODIFIERS -> [String] (69301.0)

定数

ライブラリの内部で使用します。

RDoc::CLASS_MODIFIERS -> [String] (69301.0)

定数

ライブラリの内部で使用します。

RDoc::CONSTANT_MODIFIERS -> [String] (69301.0)

定数

ライブラリの内部で使用します。

RDoc::GENERAL_MODIFIERS -> [String] (69301.0)

定数

ライブラリの内部で使用します。

RDoc::METHOD_MODIFIERS -> [String] (69301.0)

定数

ライブラリの内部で使用します。

絞り込み条件を変える

RDoc (60049.0)

モジュール

rdoc ドキュメントを扱うためのモジュールです。

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

定数

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

RDoc::Options#rdoc_include -> [String] (54604.0)

インスタンスメソッド

コマンドライン引数の --include オプションで指定したディレクトリを文字列の配列で返します。

コマンドライン引数の --include オプションで指定したディレクトリを文字列
の配列で返します。

指定しなかった場合は ['.'] を返します。

RDoc::RDoc (54229.0)

クラス

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

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

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

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

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

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

RDoc::Markup::ToRdoc (54049.0)

クラス

RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるためのクラスです。

RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
クラスです。

絞り込み条件を変える

RDoc::Error (51001.0)

クラス

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

Rake::RDocTask#rdoc_files -> Rake::FileList (45652.0)

インスタンスメソッド

RDoc の生成に使用するファイルリストを返します。デフォルトは空です。

RDoc の生成に使用するファイルリストを返します。
デフォルトは空です。

Rake::RDocTask#rdoc_files=(filelist) (45652.0)

インスタンスメソッド

RDoc の生成に使用するファイルリストをセットします。

RDoc の生成に使用するファイルリストをセットします。

@param filelist ファイルリストを指定します。

Rake::RDocTask#rdoc_dir -> String (45604.0)

インスタンスメソッド

作成した HTML ファイルを保存するディレクトリ名を返します。デフォルトは html です。

作成した HTML ファイルを保存するディレクトリ名を返します。
デフォルトは html です。

Rake::RDocTask#rdoc_dir=(dir) (45604.0)

インスタンスメソッド

作成した HTML ファイルを保存するディレクトリ名をセットします。

絞り込み条件を変える

RDoc::RDoc.add_generator(klass) -> klass (45319.0)

特異メソッド

引数 klass で指定したクラスをジェネレータとして登録します。

引数 klass で指定したクラスをジェネレータとして登録します。

@param klass 登録するクラスを指定します。

@see c:RDoc::Options#custom_options

RDoc::Context#requires -> [RDoc::Require] (37552.0)

インスタンスメソッド

追加された RDoc::Require の配列を返します。

RDoc::Context#add_require(a_require) -> () (37315.0)

インスタンスメソッド

自身が所属する RDoc::TopLevel オブジェクトに引数で指定した RDoc::Require を追加します。

自身が所属する RDoc::TopLevel オブジェクトに引数で指定した
RDoc::Require を追加します。

@param a_require RDoc::Require オブジェクトを指定します。

RDoc::Parser.parsers -> [[Regexp, RDoc::Parser]] (37252.0)

特異メソッド

RDoc::Parser#parse_files_matching で登録した正規表現とパーサクラスの配列の配列を返します。

RDoc::Parser#parse_files_matching で登録した正規表現とパーサクラ
スの配列の配列を返します。

RDoc::Markup::ToRdoc.new(markup = nil) -> RDoc::Markup::ToRdoc (37222.0)

特異メソッド

自身を初期化します。

自身を初期化します。

@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。

絞り込み条件を変える

Gem::DocManager.load_rdoc (36718.0)

特異メソッド

Gem の RDoc が使用可能な場合は使用します。そうでない場合は、標準添付の RDoc を使用します。

Gem の RDoc が使用可能な場合は使用します。
そうでない場合は、標準添付の RDoc を使用します。

@raise Gem::DocumentError RDoc が使用できない場合に発生します。

Gem::Specification#has_rdoc? -> bool (36718.0)

インスタンスメソッド

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

@see Gem::Specification#has_rdoc

Gem::Specification#has_rdoc -> bool (36700.0)

インスタンスメソッド

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

Gem::DocManager#run_rdoc(*args) (36688.0)

インスタンスメソッド

与えられた引数を使用して RDoc を実行します。

与えられた引数を使用して RDoc を実行します。

@param args RDoc に与える引数を指定します。

@raise Gem::FilePermissionError RDoc でドキュメント生成中にファイルにアクセス出来なかった場合に発生します。

Gem::DocManager#setup_rdoc (36670.0)

インスタンスメソッド

RDoc を実行するための準備を行います。

RDoc を実行するための準備を行います。

@raise Gem::FilePermissionError RDoc を保存するディレクトリにアクセスする権限がない場合に発生します。

絞り込み条件を変える

Gem::Specification#extra_rdoc_files=(paths) (36670.0)

インスタンスメソッド

RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。

RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。

@param paths RDoc でドキュメントを作成する際に使用する特別なファイルのリストを指定します。

Gem::Specification#rdoc_options=(options) (36670.0)

インスタンスメソッド

API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。

API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。

@param options API ドキュメントを生成するときに rdoc コマンドに与えるオプションを指定します。

Gem::DocManager#generate_rdoc (36652.0)

インスタンスメソッド

自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。

Gem::DocManager#install_rdoc (36652.0)

インスタンスメソッド

RDoc を生成してインストールします。

Gem::DocManager#rdoc_installed? -> bool (36652.0)

インスタンスメソッド

RDoc がインストール済みの場合は、真を返します。そうでない場合は偽を返します。

RDoc がインストール済みの場合は、真を返します。
そうでない場合は偽を返します。

絞り込み条件を変える

Gem::Server::RDOC_CSS -> String (36652.0)

定数

RDoc のための CSS を表す文字列です。

Gem::Specification#extra_rdoc_files -> [String] (36652.0)

インスタンスメソッド

RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。

Gem::Specification#has_rdoc=(flag) (36652.0)

インスタンスメソッド

RDoc を生成するかどうかをセットします。デフォルトは偽です。

Gem::Specification#rdoc_options -> [String] (36652.0)

インスタンスメソッド

API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。

RDoc::KNOWN_CLASSES -> {String => String} (36619.0)

定数

Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。

Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。

RDoc::KNOWN_CLASSES["rb_cObject"] # => "Object"

ライブラリの内部で使用します。

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

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

RDoc::Markup#add_word_pair(start, stop, name) -> () (36337.0)

インスタンスメソッド

start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にします。

start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま
す。

@param start 開始となる文字列を指定します。

@param stop 終了となる文字列を指定します。start と同じ文字列にする事も
可能です。

@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

@raise RuntimeError start に "<" で始まる文字列を指定した場合に発生します。

例:

require 'rdoc/markup/...

RDoc::Context#record_location(toplevel) (36301.0)

インスタンスメソッド

Record the file that we happen to find it in

Gem::Commands::RdocCommand (36049.0)

クラス

RDoc と ri のライブラリを生成するためのクラスです。

RDoc::Parser::RD (36001.0)

クラス

RD 形式で記述されたファイルを解析するためのクラスです。

RD 形式で記述されたファイルを解析するためのクラスです。

解析された情報はコメントとして扱われます。

絞り込み条件を変える

RDoc::Require (36001.0)

クラス

require されるファイルを表現します。

require されるファイルを表現します。

ライブラリの内部で使用します。

Rake::RDocTask (36001.0)

クラス

RDoc::Context#add_class_or_module(collection, class_type, name, superclass = nil) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule (28300.0)

インスタンスメソッド

collection に name で指定したクラス、モジュールを追加します。

collection に name で指定したクラス、モジュールを追加します。

@param collection クラス、モジュールを追加する先を Hash オブジェ
クトで指定します。

@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。

@param name クラス名を文字列で指定します。

@param su...

RDoc::TopLevel#add_class_or_module(collection, class_type, name, superclass) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule (28300.0)

インスタンスメソッド

collection に name で指定したクラス、モジュールを追加します。

RDoc::Parser.parser_for(top_level, file_name, body, options, stats) -> RDoc::Parser (28006.0)

特異メソッド

file_name を解析できるパーサのインスタンスを返します。見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。

file_name を解析できるパーサのインスタンスを返します。
見つからなかった場合は RDoc::Parser::Simple のインスタンスを返します。

@param top_level RDoc::TopLevel オブジェクトを指定します。

@param file_name ファイル名を文字列で指定します。

@param body ソースコードの内容を文字列で指定します。

@param options RDoc::Options オブジェクトを指定します。

@param stats RDoc::Stats オブジェクトを指定します。

絞り込み条件を変える

<< 1 2 3 ... > >>

別のキーワード

種類

ライブラリ

クラス

モジュール

キーワード

検索結果

先頭5件

rdoc (193123.0)

rdoc/markup/to_rdoc (132067.0)

rdoc/rdoc (132049.0)

rdoc/parser/rd (114001.0)

rdoc/generator (96547.0)

rdoc/markup (96283.0)

rdoc/markdown (96265.0)

rake/rdoctask (96235.0)

rdoc/parser (96211.0)

rubygems/commands/rdoc_command (96157.0)

rdoc/markup/to_bs (96103.0)

rdoc/context (96097.0)

rdoc/parser/ruby_tools (96097.0)

rdoc/markup/to_ansi (96085.0)

rdoc/markup/to_html (96085.0)

rdoc/markup/to_html_crossref (96067.0)

rdoc/alias (96049.0)

rdoc/anon_class (96049.0)

rdoc/any_method (96049.0)

rdoc/attr (96049.0)

rdoc/class_module (96049.0)

rdoc/code_object (96049.0)

rdoc/constant (96049.0)

rdoc/ghost_method (96049.0)

rdoc/include (96049.0)

rdoc/markup/formatter (96049.0)

rdoc/meta_method (96049.0)

rdoc/normal_class (96049.0)

rdoc/normal_module (96049.0)

rdoc/options (96049.0)

rdoc/require (96049.0)

rdoc/single_class (96049.0)

rdoc/stats (96049.0)

rdoc/top_level (96049.0)

rdoc/generator/json_index (96037.0)

rdoc/parser/c (96037.0)

rdoc/parser/changelog (96019.0)

rdoc/parser/ruby (96019.0)

rdoc/code_objects (96001.0)

rdoc/generator/darkfish (96001.0)

rdoc/generator/markup (96001.0)

rdoc/generator/ri (96001.0)

rdoc/known_classes (96001.0)

rdoc/markdown/entities (96001.0)

rdoc/parser/markdown (96001.0)

rdoc/parser/simple (96001.0)

rdoc/parser/text (96001.0)

rdoc/text (96001.0)

rdoc/token_stream (96001.0)

int rb_scan_args(int argc, const VALUE *argv, const char *fmt, ...) (78319.0)

rubygems (78091.0)

rubygems/commands/install_command (78073.0)

rubygems/doc_manager (78049.0)

rubygems/commands/server_command (78019.0)

RDoc::VERSION -> String (69349.0)

RDoc::ATTR_MODIFIERS -> [String] (69301.0)

RDoc::CLASS_MODIFIERS -> [String] (69301.0)

RDoc::CONSTANT_MODIFIERS -> [String] (69301.0)

RDoc::GENERAL_MODIFIERS -> [String] (69301.0)

RDoc::METHOD_MODIFIERS -> [String] (69301.0)

RDoc (60049.0)

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

RDoc::Options#rdoc_include -> [String] (54604.0)

RDoc::RDoc (54229.0)

RDoc::Markup::ToRdoc (54049.0)

RDoc::Error (51001.0)

Rake::RDocTask#rdoc_files -> Rake::FileList (45652.0)

Rake::RDocTask#rdoc_files=(filelist) (45652.0)

Rake::RDocTask#rdoc_dir -> String (45604.0)

Rake::RDocTask#rdoc_dir=(dir) (45604.0)

RDoc::RDoc.add_generator(klass) -> klass (45319.0)

RDoc::Context#requires -> [RDoc::Require] (37552.0)

int rb_scan_args(int argc, const VALUE argv, const char fmt, ...) (78319.0)