キーワード
-
rake
/ rdoctask (1) -
rdoc
/ any _ method (1) -
rdoc
/ attr (1) -
rdoc
/ code _ object (1) -
rdoc
/ code _ objects (1) -
rdoc
/ constant (1) -
rdoc
/ context (1) -
rdoc
/ generator (1) -
rdoc
/ generator / darkfish (1) -
rdoc
/ generator / json _ index (1) -
rdoc
/ generator / markup (1) -
rdoc
/ generator / ri (1) -
rdoc
/ ghost _ method (1) -
rdoc
/ markdown / entities (1) -
rdoc
/ markup / formatter (1) -
rdoc
/ markup / to _ ansi (1) -
rdoc
/ markup / to _ bs (1) -
rdoc
/ markup / to _ html (1) -
rdoc
/ markup / to _ html _ crossref (1) -
rdoc
/ markup / to _ rdoc (1) -
rdoc
/ parser / c (1) -
rdoc
/ parser / ruby (1) -
rdoc
/ parser / ruby _ tools (1) -
rdoc
/ parser / text (1) -
rdoc
/ stats (1) -
rdoc
/ text (1) -
rdoc
/ token _ stream (1) -
rdoc
/ top _ level (1) -
rubygems
/ commands / install _ command (1)
検索結果
-
rdoc (115126.0)
-
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。
このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby のソースファイルに対するドキュメントを生成
するアプリケーションです。 JavaDoc と同様に、ソースを解析し、クラス、モ
ジュール、メソッドの定義を抜き出してきます(include,require もです)。そ
してこれらの内容とその直前に書かれたコメントを併合し、ドキュメントを出
力します(現在は HTML しか出力できませんが、こ... -
rdoc
/ markup / to _ rdoc (54070.0) -
RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための サブライブラリです。
RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
サブライブラリです。
サブクラス(RDoc::Markup::ToAnsi など)を作成して使います。 -
rdoc
/ markdown / entities (54004.0) -
HTML の実体参照のマッピングを表す情報を定義するサブライブラリです。
HTML の実体参照のマッピングを表す情報を定義するサブライブラリです。 -
rdoc
/ generator (36550.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
... -
rake
/ rdoctask (36238.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
/ context (36100.0) -
RDoc::Context と RDoc::Context::Section を定義するサブライ ブラリです。
RDoc::Context と RDoc::Context::Section を定義するサブライ
ブラリです。 -
rdoc
/ parser / ruby _ tools (36100.0) -
RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー ドのパーサを記述するためのモジュールを定義するサブライブラリです。
RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー
ドのパーサを記述するためのモジュールを定義するサブライブラリです。 -
rdoc
/ markup / to _ ansi (36088.0) -
RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ ブラリです。
RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ
ブラリです。
require 'rdoc/markup/to_ansi'
h = RDoc::Markup::ToAnsi.new
puts h.convert(input_string)
変換した結果は文字列で取得できます。 -
rdoc
/ markup / to _ bs (36088.0) -
RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効 果を持たせるように見せるサブライブラリです。
RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効
果を持たせるように見せるサブライブラリです。
require 'rdoc/markup/to_bs'
h = RDoc::Markup::ToBs.new
puts h.convert(input_string)
変換した結果は文字列で取得できます。実際に効果を確認するためにはページャ
などで出力を確認します。
テキスト中の以下のマークアップ記法をエスケープシーケンスの \b と組み合
わせる事によって見た目を変更します。
* イタリック体(_word_): word にアンダーラインを付けて... -
rdoc
/ markup / to _ html (36088.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 (36070.0) -
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
RDoc::Markup::ToHtml を拡張して、ドキュメント内のメソッド名やクラ
ス名を自動的にリンクにします。 -
rdoc
/ any _ method (36052.0) -
RDoc::AnyMethod を定義するサブライブラリです。
RDoc::AnyMethod を定義するサブライブラリです。 -
rdoc
/ attr (36052.0) -
RDoc::Attr を定義するサブライブラリです。
RDoc::Attr を定義するサブライブラリです。 -
rdoc
/ code _ object (36052.0) -
RDoc::CodeObject を定義するサブライブラリです。
RDoc::CodeObject を定義するサブライブラリです。 -
rdoc
/ constant (36052.0) -
RDoc::Constant を定義するサブライブラリです。
RDoc::Constant を定義するサブライブラリです。 -
rdoc
/ ghost _ method (36052.0) -
RDoc::GhostMethod を定義するサブライブラリです。
RDoc::GhostMethod を定義するサブライブラリです。 -
rdoc
/ markup / formatter (36052.0) -
RDoc 形式のドキュメントを整形するためのサブライブラリです。
RDoc 形式のドキュメントを整形するためのサブライブラリです。 -
rdoc
/ meta _ method (36052.0) -
RDoc::MetaMethod を定義するサブライブラリです。
RDoc::MetaMethod を定義するサブライブラリです。 -
rdoc
/ options (36052.0) -
rdoc コマンドのオプションを解析するためのサブライブラリです。
rdoc コマンドのオプションを解析するためのサブライブラリです。 -
rdoc
/ stats (36052.0) -
RDoc のステータスを管理するサブライブラリです。
RDoc のステータスを管理するサブライブラリです。 -
rdoc
/ top _ level (36052.0) -
RDoc::TopLevel を定義するサブライブラリです。
RDoc::TopLevel を定義するサブライブラリです。 -
rdoc
/ generator / json _ index (36040.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
/ code _ objects (36004.0) -
Ruby のソースコード中にあるクラス、モジュール、メソッドなどの構成要素を 表現するためのサブライブラリです。
Ruby のソースコード中にあるクラス、モジュール、メソッドなどの構成要素を
表現するためのサブライブラリです。 -
rdoc
/ generator / darkfish (36004.0) -
HTML を生成するためのサブライブラリです。
HTML を生成するためのサブライブラリです。 -
rdoc
/ generator / markup (36004.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
rdoc
/ generator / ri (36004.0) -
ri のためのファイルを生成するためのサブライブラリです。
ri のためのファイルを生成するためのサブライブラリです。 -
rdoc
/ parser / text (36004.0) -
プログラムを含まないテキストを解析するためのサブライブラリです。
プログラムを含まないテキストを解析するためのサブライブラリです。 -
rdoc
/ text (36004.0) -
コメントテキストを処理するためのサブライブラリです。
コメントテキストを処理するためのサブライブラリです。 -
rdoc
/ token _ stream (36004.0) -
トークンを管理するためのサブライブラリです。
トークンを管理するためのサブライブラリです。 -
rdoc
/ parser / c (18094.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... -
rubygems
/ commands / install _ command (18076.0) -
Gem パッケージをローカルリポジトリにインストールするためのライブラリです。
Gem パッケージをローカルリポジトリにインストールするためのライブラリです。
Usage: gem install GEMNAME [GEMNAME ...] [options] -- --build-flags [options]
Options:
--platform PLATFORM 指定されたプラットフォームの Gem パッケージをインストールします
-v, --version VERSION 指定されたバージョンの Gem パッケージをインストールします
Install/Update Op... -
rdoc
/ parser / ruby (18058.0) -
Ruby のソースコードを解析するためのサブライブラリです。
Ruby のソースコードを解析するためのサブライブラリです。
拡張子が .rb、.rbw のファイルを解析する事ができます。
=== メタプログラミングされたメソッド
動的に定義されたメソッドをドキュメントに含めたい場合、## でコメントを開始します。
##
# This is a meta-programmed method!
add_my_method :meta_method, :arg1, :arg2
RDoc::Parser::Ruby は上記の :meta_method ようにメソッドの定義を行
うような識別子の後に続くトークンをメソッド名として解釈します。...