キーワード
- Alias (1)
- AnonClass (1)
- AnyMethod (1)
- Attr (1)
- C (1)
- ChangeLog (1)
- ClassModule (1)
- CodeObject (1)
- Constant (1)
- Context (1)
- Darkfish (1)
- Error (1)
- Formatter (1)
- GhostMethod (1)
- Include (1)
- JsonIndex (1)
- Markdown (2)
- Markup (1)
- MetaMethod (1)
- NormalClass (1)
- NormalModule (1)
- Options (1)
- Parser (1)
- RD (1)
- RDoc (1)
- RI (1)
- Require (1)
- Ruby (1)
- RubyLex (1)
- Section (1)
- Simple (1)
- SingleClass (1)
- Stats (1)
- ToAnsi (1)
- ToBs (1)
- ToHtml (1)
- ToHtmlCrossref (1)
- ToRdoc (1)
- TopLevel (1)
検索結果
-
RDoc
:: Error (10.0) -
ドキュメントの処理中にエラーがあった場合に発生します。
ドキュメントの処理中にエラーがあった場合に発生します。 -
RDoc
:: Alias (7.0) -
aliasされたメソッドを表現するクラスです。
aliasされたメソッドを表現するクラスです。
ライブラリの内部で使用します。 -
RDoc
:: AnonClass (7.0) -
匿名クラスを表現するクラスです。
匿名クラスを表現するクラスです。
現在は使用されていません。 -
RDoc
:: AnyMethod (7.0) -
メソッドを表現するクラスの基本クラスです。
メソッドを表現するクラスの基本クラスです。
ライブラリの内部で使用します。 -
RDoc
:: Attr (7.0) -
属性を表現するクラスです。
属性を表現するクラスです。
ライブラリの内部で使用します。 -
RDoc
:: ClassModule (7.0) -
クラスやモジュールを表現するための基本クラスです。
クラスやモジュールを表現するための基本クラスです。
ライブラリの内部で使用します。 -
RDoc
:: CodeObject (7.0) -
RDoc のコードツリーを表現するクラスの基本クラスです。
...RDoc のコードツリーを表現するクラスの基本クラスです。
以下は RDoc::CodeObject のサブクラスのツリーです。
//emlist{
* RDoc::Context
* RDoc::TopLevel
* RDoc::ClassModule
* RDoc::AnonClass
* RDoc::NormalClass
* RDoc::NormalModule
* RD......oc::SingleClass
* RDoc::AnyMethod
* RDoc::GhostMethod
* RDoc::MetaMethod
* RDoc::Alias
* RDoc::Attr
* RDoc::Constant
* RDoc::Require
* RDoc::Include
//}... -
RDoc
:: Constant (7.0) -
定数を表現するクラスです。
定数を表現するクラスです。
ライブラリの内部で使用します。 -
RDoc
:: Context (7.0) -
モジュール、クラス、メソッドなどの、rdoc/code_objects が定義す るクラスを管理するクラスです。
...モジュール、クラス、メソッドなどの、rdoc/code_objects が定義す
るクラスを管理するクラスです。... -
RDoc
:: Context :: Section (7.0) -
section に関する情報を保持するクラスです。
section に関する情報を保持するクラスです。
ドキュメント中で以下のように記述した情報を保持しています。
# :section: The title
# The body -
RDoc
:: Generator :: Darkfish (7.0) -
HTML を生成するためのクラスです。
HTML を生成するためのクラスです。 -
RDoc
:: Generator :: JsonIndex (7.0) -
他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ クスを生成するクラスです。
他のジェネレータが生成する HTML で検索が行えるように、JSON の検索インデッ
クスを生成するクラスです。 -
RDoc
:: Generator :: RI (7.0) -
ri のためのファイルを生成するためのクラスです。
ri のためのファイルを生成するためのクラスです。 -
RDoc
:: GhostMethod (7.0) -
コメントでのみ参照されるメソッドを表現します。
コメントでのみ参照されるメソッドを表現します。
ライブラリの内部で使用します。 -
RDoc
:: Include (7.0) -
includeされるファイルを表現します。
includeされるファイルを表現します。
ライブラリの内部で使用します。 -
RDoc
:: Markdown (7.0) -
Markdown 形式で記述されたドキュメントを rdoc 上で解析するための クラスです。
...Markdown 形式で記述されたドキュメントを rdoc 上で解析するための
クラスです。... -
RDoc
:: Markup (7.0) -
RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。
...RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。
例:
require 'rdoc/markup/to_html'
h = RDoc::Markup::ToHtml.new
puts h.convert(input_string)
独自のフォーマットを行うようにパーサを拡張する事もできます。
例:
req......uire 'rdoc/markup'
require 'rdoc/markup/to_html'
class WikiHtml < RDoc::Markup::ToHtml
# WikiWord のフォントを赤く表示。
def handle_special_WIKIWORD(special)
"<font color=red>" + special.text + "</font>"
end
end
m = RDoc::Markup.new
# { 〜 } までを :STRIK......STRIKE のフォーマットを <strike> 〜 </strike> に指定。
wh.add_tag(:STRIKE, "<strike>", "</strike>")
puts "<body>#{wh.convert ARGF.read}</body>"
変換する形式を変更する場合、フォーマッタ(例. RDoc::Markup::ToHtml)
を変更、拡張する必要があります。... -
RDoc
:: Markup :: Formatter (7.0) -
RDoc 形式のドキュメントを整形するための基本クラスです。
...RDoc 形式のドキュメントを整形するための基本クラスです。
実際にドキュメントを整形するには、RDoc::Markup::ToHtml のような、
継承したクラスで convert メソッドを実行してください。... -
RDoc
:: Markup :: ToAnsi (7.0) -
RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするクラスで す。
...RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするクラスで
す。... -
RDoc
:: Markup :: ToBs (7.0) -
RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効 果を持たせるように見せるクラスです。
...RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効
果を持たせるように見せるクラスです。... -
RDoc
:: Markup :: ToHtml (7.0) -
RDoc 形式のドキュメントを HTML に整形するクラスです。
...RDoc 形式のドキュメントを HTML に整形するクラスです。... -
RDoc
:: Markup :: ToHtmlCrossref (7.0) -
RDoc 形式のドキュメントを HTML に整形するクラスです。
...RDoc 形式のドキュメントを HTML に整形するクラスです。... -
RDoc
:: Markup :: ToRdoc (7.0) -
RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための クラスです。
...RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
クラスです。... -
RDoc
:: MetaMethod (7.0) -
動的に定義されたメソッドを表現するクラスです。
動的に定義されたメソッドを表現するクラスです。
ライブラリの内部で使用します。 -
RDoc
:: NormalClass (7.0) -
クラスを表現するためのクラスです。
クラスを表現するためのクラスです。
特異クラスや匿名クラスは含まれません。
ライブラリの内部で使用します。 -
RDoc
:: NormalModule (7.0) -
モジュールを表現するクラスです。
モジュールを表現するクラスです。
ライブラリの内部で使用します。 -
RDoc
:: Options (7.0) -
rdoc コマンドのオプションを解析するためのクラスです。
...rdoc コマンドのオプションを解析するためのクラスです。
それぞれのオプションの詳細に関しては、lib:rdoc#usage を参照してくだ
さい。
===[a:custom_options] カスタムオプション
RDoc のジェネレータでは、RDoc::Options をフックし......まれていた場合、RDoc はジェネ
レータ独自のオプションを解析するために setup_options メソッドを呼び出し
ます。カスタムオプションを指定する場合は --format オプションは必ず指定
する必要があります。rdoc --help を実行する......きます。
例:
class RDoc::Generator::Spellcheck
RDoc::RDoc.add_generator self
def self.setup_options rdoc_options
op = rdoc_options.option_parser
op.on('--spell-dictionary DICTIONARY',
RDoc::Options::Path) do |dictionary|
# RDoc::Options に spell_di... -
RDoc
:: Parser (7.0) -
ソースコードを解析するパーサを生成するための基本クラスです。
ソースコードを解析するパーサを生成するための基本クラスです。
新しいパーサを作成する場合には継承して使用します。 -
RDoc
:: Parser :: C (7.0) -
C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析するためのクラスです。
C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン
トを解析するためのクラスです。 -
RDoc
:: Parser :: ChangeLog (7.0) -
ChangeLog ファイルを解析するためのクラスです。
ChangeLog ファイルを解析するためのクラスです。 -
RDoc
:: Parser :: Markdown (7.0) -
Markdown 形式で記述されたファイルを解析するためのクラスです。
Markdown 形式で記述されたファイルを解析するためのクラスです。
解析された情報はコメントとして扱われます。 -
RDoc
:: Parser :: RD (7.0) -
RD 形式で記述されたファイルを解析するためのクラスです。
RD 形式で記述されたファイルを解析するためのクラスです。
解析された情報はコメントとして扱われます。 -
RDoc
:: Parser :: Ruby (7.0) -
Ruby のソースコードを解析するためのクラスです。
Ruby のソースコードを解析するためのクラスです。 -
RDoc
:: Parser :: Simple (7.0) -
ソースコード以外のファイルを解析するためのクラスです。
ソースコード以外のファイルを解析するためのクラスです。 -
RDoc
:: RDoc (7.0) -
rdoc ドキュメントの作成を行うクラスです。
...rdoc ドキュメントの作成を行うクラスです。
以下のようにして、rdoc コマンドを実行するのと同様に実行します。
require 'rdoc/rdoc'
rdoc = RDoc::RDoc.new
rdoc.document(args)
args には rdoc コマンドに渡すのと同様の引数を文字列......の配列で指定します。
rdoc コマンドと同様に変換結果はファイルに出力されるため、テキストを
HTML に変換する部分をライブラリとして使用したい場合、
rdoc/markup を参照してください。... -
RDoc
:: Require (7.0) -
require されるファイルを表現します。
require されるファイルを表現します。
ライブラリの内部で使用します。 -
RDoc
:: RubyLex (7.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: SingleClass (7.0) -
特異クラスを表現するクラスです。
特異クラスを表現するクラスです。
ライブラリの内部で使用します。 -
RDoc
:: Stats (7.0) -
RDoc のステータスを管理するクラスです。
...RDoc のステータスを管理するクラスです。... -
RDoc
:: TopLevel (7.0) -
最上位のコンテキスト(ソースファイル)を表現するクラスです。
最上位のコンテキスト(ソースファイル)を表現するクラスです。