ライブラリ
- ビルトイン (3)
- rake (1)
-
rake
/ rdoctask (22) - rdoc (9)
-
rdoc
/ alias (1) -
rdoc
/ anon _ class (1) -
rdoc
/ any _ method (1) -
rdoc
/ attr (1) -
rdoc
/ class _ module (1) -
rdoc
/ code _ object (20) -
rdoc
/ constant (1) -
rdoc
/ context (55) -
rdoc
/ generator (1) -
rdoc
/ generator / darkfish (5) -
rdoc
/ generator / json _ index (4) -
rdoc
/ generator / markup (1) -
rdoc
/ generator / ri (4) -
rdoc
/ ghost _ method (1) -
rdoc
/ include (1) -
rdoc
/ known _ classes (1) -
rdoc
/ markdown (21) -
rdoc
/ markdown / entities (1) -
rdoc
/ markup (12) -
rdoc
/ markup / formatter (4) -
rdoc
/ markup / to _ ansi (2) -
rdoc
/ markup / to _ bs (2) -
rdoc
/ markup / to _ html (2) -
rdoc
/ markup / to _ html _ crossref (2) -
rdoc
/ markup / to _ rdoc (2) -
rdoc
/ normal _ class (1) -
rdoc
/ normal _ module (1) -
rdoc
/ parser (6) -
rdoc
/ parser / c (4) -
rdoc
/ parser / changelog (2) -
rdoc
/ parser / markdown (2) -
rdoc
/ parser / rd (2) -
rdoc
/ parser / ruby (7) -
rdoc
/ parser / ruby _ tools (1) -
rdoc
/ parser / simple (4) -
rdoc
/ parser / text (1) -
rdoc
/ rdoc (3) -
rdoc
/ require (1) -
rdoc
/ single _ class (1) -
rdoc
/ stats (11) -
rdoc
/ text (9) -
rdoc
/ token _ stream (1) -
rdoc
/ top _ level (15) -
rubygems
/ commands / rdoc _ command (1) -
rubygems
/ doc _ manager (12) -
rubygems
/ exceptions (1) -
rubygems
/ server (1) -
rubygems
/ specification (7)
クラス
-
Gem
:: DocManager (11) -
Gem
:: Server (1) -
Gem
:: Specification (7) - Module (2)
-
RDoc
:: CodeObject (19) -
RDoc
:: Context (45) -
RDoc
:: Context :: Section (8) -
RDoc
:: Generator :: Darkfish (4) -
RDoc
:: Generator :: JsonIndex (3) -
RDoc
:: Generator :: RI (3) -
RDoc
:: Markdown (21) -
RDoc
:: Markup (11) -
RDoc
:: Markup :: Formatter (3) -
RDoc
:: Markup :: ToAnsi (1) -
RDoc
:: Markup :: ToBs (1) -
RDoc
:: Markup :: ToHtml (1) -
RDoc
:: Markup :: ToHtmlCrossref (1) -
RDoc
:: Markup :: ToRdoc (1) -
RDoc
:: Options (72) -
RDoc
:: Parser (5) -
RDoc
:: Parser :: C (3) -
RDoc
:: Parser :: ChangeLog (1) -
RDoc
:: Parser :: Markdown (1) -
RDoc
:: Parser :: RD (1) -
RDoc
:: Parser :: Ruby (4) -
RDoc
:: Parser :: Simple (3) -
RDoc
:: RDoc (2) -
RDoc
:: Stats (10) -
RDoc
:: TopLevel (14) -
Rake
:: RDocTask (21)
モジュール
-
Gem
:: InstallUpdateOptions (1) - Kernel (1)
- RDoc (8)
-
RDoc
:: Text (8)
オブジェクト
- main (1)
キーワード
- <=> (1)
- == (1)
-
ATTR
_ MODIFIERS (1) - Alias (1)
- AnonClass (1)
- AnyMethod (1)
- Attr (1)
- C (1)
-
CLASS
_ MODIFIERS (1) -
CONSTANT
_ MODIFIERS (1) - ChangeLog (1)
- ClassModule (1)
- CodeObject (1)
- Constant (1)
- Context (1)
-
DEFAULT
_ EXTENSIONS (1) - DEPRECATED (1)
- DESCRIPTION (1)
-
DOT
_ DOC _ FILENAME (1) - Darkfish (1)
- DocManager (1)
- DocumentError (1)
- EXTENSIONS (1)
- Error (1)
- Formatter (1)
-
GENERAL
_ MODIFIERS (1) -
GENERATOR
_ DIR (1) - Generator (1)
- GhostMethod (1)
-
HTML
_ ENTITIES (1) - Include (1)
- JsonIndex (1)
-
KNOWN
_ CLASSES (1) -
LABEL
_ LIST _ RE (1) -
METHOD
_ MODIFIERS (1) - Markdown (2)
- Markup (2)
- MetaMethod (1)
-
NEWS for Ruby 2
. 0 . 0 (1) -
NEWS for Ruby 2
. 1 . 0 (1) -
NEWS for Ruby 2
. 2 . 0 (1) -
NEWS for Ruby 2
. 3 . 0 (1) -
NEWS for Ruby 2
. 4 . 0 (1) -
NEWS for Ruby 2
. 5 . 0 (1) -
NEWS for Ruby 2
. 6 . 0 (1) - NORMAL (1)
- NormalClass (1)
- NormalModule (1)
- Options (1)
- Parser (1)
- RD (1)
-
RDOC
_ CSS (1) - RDocTask (1)
- RI (1)
- RdocCommand (1)
- Require (1)
- Ruby (1)
- RubyLex (1)
- RubyToken (1)
- RubyTools (1)
- Ruby用語集 (1)
-
SEARCH
_ INDEX _ FILE (1) -
SIMPLE
_ LIST _ RE (1) - SINGLE (1)
- SPACE (1)
- SPECIAL (1)
- Section (1)
- Simple (1)
- SingleClass (1)
- Stats (1)
- TYPES (1)
- Text (2)
- ToAnsi (1)
- ToBs (1)
- ToHtml (1)
- ToHtmlCrossref (1)
- ToRdoc (1)
- TokenStream (1)
- TopLevel (1)
- VERSION (2)
- VISIBILITIES (1)
-
add
_ alias (1) -
add
_ attribute (1) -
add
_ class (1) -
add
_ class _ or _ module (2) -
add
_ constant (1) -
add
_ generator (1) -
add
_ html (1) -
add
_ include (1) -
add
_ method (1) -
add
_ module (1) -
add
_ require (1) -
add
_ special (1) -
add
_ tag (1) -
add
_ to (1) -
add
_ word _ pair (1) -
alias
_ extension (1) - aliases (1)
-
all
_ classes _ and _ modules (1) -
all
_ one _ file (1) -
attribute
_ manager (1) - attributes (1)
-
break
_ on _ newline (1) -
break
_ on _ newline= (1) -
can
_ parse (1) -
cgi
/ session (1) - charset (1)
- classes (1)
- comment (2)
- comment= (1)
-
configured
_ args (1) -
configured
_ args= (1) - constants (1)
- content (1)
- convert (2)
-
coverage
_ report (1) -
coverage
_ report= (1) - css (2)
- css= (1)
-
current
_ section (1) - define (1)
-
defined
_ in? (1) -
definition
_ lists (1) -
definition
_ lists= (1) - diagram (1)
- document (1)
-
document
_ children (1) -
document
_ children= (1) -
document
_ self (1) -
document
_ self= (1) - documented? (1)
- drb (1)
-
dry
_ run (1) -
dry
_ run= (1) -
each
_ attribute (1) -
each
_ classmodule (1) -
each
_ constant (1) -
each
_ method (1) - encoding (1)
- encoding= (1)
- exclude (1)
- exclude= (1)
- extension (2)
- extension? (1)
- external (1)
- external= (1)
-
extra
_ accessor _ flags (1) -
extra
_ accessors (1) -
extra
_ rdoc _ files (1) -
extra
_ rdoc _ files= (1) -
file
_ absolute _ name (1) -
file
_ absolute _ name= (1) -
file
_ relative _ name (1) -
file
_ relative _ name= (1) -
file
_ stat (1) -
file
_ stat= (1) - fileboxes (1)
- files (1)
-
find
_ class _ named (1) -
find
_ enclosing _ module _ named (1) -
find
_ local _ symbol (2) -
find
_ module _ named (2) -
find
_ symbol (1) -
finish
_ page _ dir (1) -
flush
_ left (1) -
force
_ output (1) -
force
_ output= (1) -
force
_ update (1) - formatter (1)
- formatter= (1)
-
full
_ name (1) - generate (3)
-
generate
_ rdoc (1) - generator (1)
- generator= (1)
-
get
_ line _ types (1) - github (1)
- github= (1)
-
has
_ rdoc (1) -
has
_ rdoc= (1) -
has
_ rdoc? (1) - html (1)
- html= (1)
-
hyperlink
_ all (1) -
hyperlink
_ all= (1) -
image
_ format (1) -
in
_ files (1) -
include
_ line _ numbers (1) - includes (1)
- initialize (2)
-
initialize
_ classes _ and _ modules (1) -
initialize
_ methods _ etc (1) -
inline
_ source (1) - inspect (1)
-
install
_ rdoc (1) -
install
_ update _ defaults _ str (1) -
line
_ numbers (1) -
line
_ numbers= (1) -
load
_ rdoc (1) - main (1)
- main= (1)
-
main
_ page (1) -
main
_ page= (1) - markup (2)
- markup= (1)
- merge (1)
-
method
_ list (1) - mkmf (1)
- modules (1)
- multitask (1)
- name (2)
- name= (1)
- new (19)
-
normalize
_ comment (1) - notes (1)
- notes= (1)
-
num
_ classes (1) -
num
_ classes= (1) -
num
_ files (1) -
num
_ files= (1) -
num
_ methods (1) -
num
_ methods= (1) -
num
_ modules (1) -
num
_ modules= (1) -
ongoing
_ visibility= (1) -
op
_ dir (1) -
op
_ dir= (1) -
op
_ name (1) -
option
_ list (1) -
option
_ parser (1) -
option
_ parser= (1) -
option
_ string (1) -
page
_ dir (1) -
page
_ dir= (1) - parent (2)
- parent= (1)
-
parent
_ file _ name (1) -
parent
_ name (1) - parse (4)
-
parse
_ files _ matching (1) -
parser
_ for (1) - parsers (1)
- pipe (1)
- pipe= (1)
- print (1)
- progress= (1)
- promiscuous (1)
- quiet (1)
- quote (1)
-
rake
/ rdoctask (1) -
rb
_ scan _ args (1) - rdoc (1)
-
rdoc
/ alias (1) -
rdoc
/ anon _ class (1) -
rdoc
/ any _ method (1) -
rdoc
/ attr (1) -
rdoc
/ class _ module (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
/ include (1) -
rdoc
/ known _ classes (1) -
rdoc
/ markdown (1) -
rdoc
/ markdown / entities (1) -
rdoc
/ markup (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
/ normal _ class (1) -
rdoc
/ normal _ module (1) -
rdoc
/ parser (1) -
rdoc
/ parser / c (1) -
rdoc
/ parser / changelog (1) -
rdoc
/ parser / markdown (1) -
rdoc
/ parser / rd (1) -
rdoc
/ parser / ruby (1) -
rdoc
/ parser / ruby _ tools (1) -
rdoc
/ parser / simple (1) -
rdoc
/ parser / text (1) -
rdoc
/ rdoc (1) -
rdoc
/ require (1) -
rdoc
/ single _ class (1) -
rdoc
/ stats (1) -
rdoc
/ text (1) -
rdoc
/ token _ stream (1) -
rdoc
/ top _ level (1) -
rdoc
_ dir (1) -
rdoc
_ dir= (1) -
rdoc
_ files (1) -
rdoc
_ files= (1) -
rdoc
_ include (1) -
rdoc
_ installed? (1) -
record
_ location (1) - refine (1)
-
remove
_ classes _ and _ modules (1) -
remove
_ methods _ etc (1) -
remove
_ private _ comments (1) - requires (1)
- reset (1)
- root (1)
- root= (1)
-
ruby 1
. 8 . 2 feature (1) -
ruby 1
. 8 . 4 feature (1) - rubygems (1)
-
rubygems
/ commands / install _ command (1) -
rubygems
/ commands / rdoc _ command (1) -
rubygems
/ commands / server _ command (1) -
rubygems
/ doc _ manager (1) -
run
_ rdoc (1) -
sanitize
_ path (1) - scan (6)
- section (1)
- section= (1)
- sections (1)
- sequence (1)
-
set
_ comment (1) -
set
_ current _ section (1) -
set
_ visibility _ for (1) -
setup
_ rdoc (1) -
show
_ all (1) -
show
_ all= (1) -
show
_ hash (1) -
start
_ doc (1) -
static
_ path (1) -
static
_ path= (1) -
stop
_ doc (1) -
strip
_ hashes (1) -
strip
_ newlines (1) -
strip
_ stars (1) -
tab
_ width (1) - template (2)
- template= (1)
-
template
_ dir (1) -
template
_ dir= (1) - title (3)
- title= (2)
- toplevel (1)
-
uninstall
_ doc (1) -
unmatched
_ alias _ lists (1) -
unmatched
_ alias _ lists= (1) -
update
_ ri _ cache (1) - using (2)
- verbosity (1)
- verbosity= (1)
- visibility (2)
- visibility= (1)
- warn (1)
- webcvs (1)
- コマンド (1)
- 正規表現 (1)
検索結果
先頭5件
-
RDoc (114049.0)
-
rdoc ドキュメントを扱うためのモジュールです。
rdoc ドキュメントを扱うためのモジュールです。 -
RDoc
:: RDoc (63229.0) -
rdoc ドキュメントの作成を行うクラスです。
rdoc ドキュメントの作成を行うクラスです。
以下のようにして、rdoc コマンドを実行するのと同様に実行します。
require 'rdoc/rdoc'
rdoc = RDoc::RDoc.new
rdoc.document(args)
args には rdoc コマンドに渡すのと同様の引数を文字列の配列で指定します。
rdoc コマンドと同様に変換結果はファイルに出力されるため、テキストを
HTML に変換する部分をライブラリとして使用したい場合、
rdoc/markup を参照してください。 -
RDoc
:: DOT _ DOC _ FILENAME -> " . document" (63049.0) -
rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。
rdoc コマンドが処理するファイル名の一覧が書かれたファイルの名前を返します。 -
RDoc
:: VERSION -> String (63049.0) -
RDoc のバージョンを表す文字列を返します。
RDoc のバージョンを表す文字列を返します。 -
RDoc
:: KNOWN _ CLASSES -> {String => String} (63019.0) -
Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。
Ruby の組み込みクラスの内部的な変数名がキー、クラス名が値のハッシュです。
RDoc::KNOWN_CLASSES["rb_cObject"] # => "Object"
ライブラリの内部で使用します。 -
RDoc
:: ATTR _ MODIFIERS -> [String] (63001.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: CLASS _ MODIFIERS -> [String] (63001.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: CONSTANT _ MODIFIERS -> [String] (63001.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: GENERAL _ MODIFIERS -> [String] (63001.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
RDoc
:: METHOD _ MODIFIERS -> [String] (63001.0) -
ライブラリの内部で使用します。
ライブラリの内部で使用します。 -
rdoc
/ markup / to _ rdoc (36067.0) -
RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための サブライブラリです。
RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
サブライブラリです。
サブクラス(RDoc::Markup::ToAnsi など)を作成して使います。 -
rdoc
/ rdoc (36049.0) -
rdoc コマンドのためのサブライブラリです。
rdoc コマンドのためのサブライブラリです。 -
Rake
:: RDocTask # rdoc _ files -> Rake :: FileList (27352.0) -
RDoc の生成に使用するファイルリストを返します。 デフォルトは空です。
RDoc の生成に使用するファイルリストを返します。
デフォルトは空です。 -
Rake
:: RDocTask # rdoc _ files=(filelist) (27352.0) -
RDoc の生成に使用するファイルリストをセットします。
RDoc の生成に使用するファイルリストをセットします。
@param filelist ファイルリストを指定します。 -
RDoc
:: Options # rdoc _ include -> [String] (27304.0) -
コマンドライン引数の --include オプションで指定したディレクトリを文字列 の配列で返します。
コマンドライン引数の --include オプションで指定したディレクトリを文字列
の配列で返します。
指定しなかった場合は ['.'] を返します。 -
Rake
:: RDocTask # rdoc _ dir -> String (27304.0) -
作成した HTML ファイルを保存するディレクトリ名を返します。 デフォルトは html です。
作成した HTML ファイルを保存するディレクトリ名を返します。
デフォルトは html です。 -
Rake
:: RDocTask # rdoc _ dir=(dir) (27304.0) -
作成した HTML ファイルを保存するディレクトリ名をセットします。
作成した HTML ファイルを保存するディレクトリ名をセットします。 -
RDoc
:: Markup :: ToRdoc (27049.0) -
RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための クラスです。
RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
クラスです。 -
rdoc (19105.0)
-
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。
このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby のソースファイルに対するドキュメントを生成
するアプリケーションです。 JavaDoc と同様に、ソースを解析し、クラス、モ
ジュール、メソッドの定義を抜き出してきます(include,require もです)。そ
してこれらの内容とその直前に書かれたコメントを併合し、ドキュメントを出
力します(現在は HTML しか出力できませんが、こ... -
RDoc
:: Markup :: ToRdoc . new(markup = nil) -> RDoc :: Markup :: ToRdoc (18622.0) -
自身を初期化します。
自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。 -
rdoc
/ generator (18547.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
... -
Gem
:: DocManager . load _ rdoc (18418.0) -
Gem の RDoc が使用可能な場合は使用します。 そうでない場合は、標準添付の RDoc を使用します。
Gem の RDoc が使用可能な場合は使用します。
そうでない場合は、標準添付の RDoc を使用します。
@raise Gem::DocumentError RDoc が使用できない場合に発生します。 -
Gem
:: Specification # has _ rdoc? -> bool (18418.0) -
真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。
真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。
@see Gem::Specification#has_rdoc -
Gem
:: Specification # has _ rdoc -> bool (18400.0) -
真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。
真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。 -
Gem
:: DocManager # run _ rdoc(*args) (18388.0) -
与えられた引数を使用して RDoc を実行します。
与えられた引数を使用して RDoc を実行します。
@param args RDoc に与える引数を指定します。
@raise Gem::FilePermissionError RDoc でドキュメント生成中にファイルにアクセス出来なかった場合に発生します。 -
Gem
:: DocManager # setup _ rdoc (18370.0) -
RDoc を実行するための準備を行います。
RDoc を実行するための準備を行います。
@raise Gem::FilePermissionError RDoc を保存するディレクトリにアクセスする権限がない場合に発生します。 -
Gem
:: Specification # extra _ rdoc _ files=(paths) (18370.0) -
RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。
RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。
@param paths RDoc でドキュメントを作成する際に使用する特別なファイルのリストを指定します。 -
Gem
:: Specification # rdoc _ options=(options) (18370.0) -
API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。
API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。
@param options API ドキュメントを生成するときに rdoc コマンドに与えるオプションを指定します。 -
Gem
:: DocManager # generate _ rdoc (18352.0) -
自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。
自身にセットされている Gem::Specification の情報をもとに RDoc のドキュメントを生成します。 -
Gem
:: DocManager # install _ rdoc (18352.0) -
RDoc を生成してインストールします。
RDoc を生成してインストールします。 -
Gem
:: DocManager # rdoc _ installed? -> bool (18352.0) -
RDoc がインストール済みの場合は、真を返します。 そうでない場合は偽を返します。
RDoc がインストール済みの場合は、真を返します。
そうでない場合は偽を返します。 -
Gem
:: Server :: RDOC _ CSS -> String (18352.0) -
RDoc のための CSS を表す文字列です。
RDoc のための CSS を表す文字列です。 -
Gem
:: Specification # extra _ rdoc _ files -> [String] (18352.0) -
RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。
RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。 -
Gem
:: Specification # has _ rdoc=(flag) (18352.0) -
RDoc を生成するかどうかをセットします。デフォルトは偽です。
RDoc を生成するかどうかをセットします。デフォルトは偽です。 -
Gem
:: Specification # rdoc _ options -> [String] (18352.0) -
API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。
API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。 -
rdoc
/ markup (18283.0) -
RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。
RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。
RDoc::Markup は RDoc 形式のドキュメント、Wiki エントリ、Web上の
FAQ などを想定したプレインテキストから様々なフォーマットへの変換を行う
ツール群の基礎として作られています。RDoc::Markup 自身は何の出力も
行いません。
それらは output_format で後述するクラス群に委ねられています。
=== Markup
基本的には、lib:rdoc#markup と同じです。ただし、rdoc コマンドと
は異なり、Ruby のソースコードのコメント部分ではなく、プレイン... -
rdoc
/ markdown (18265.0) -
Markdown 形式で記述されたドキュメントを rdoc 上で解析するための サブライブラリです。
Markdown 形式で記述されたドキュメントを rdoc 上で解析するための
サブライブラリです。
詳しくは以下を参照してください。
* https://daringfireball.net/projects/markdown/syntax
Markdown 形式をデフォルトのフォーマットにする場合は、
lib:rdoc#saved_options を参考に プロジェクトのデフォルトを
.rdoc_options ファイルで設定してください。
=== 拡張
以降の Markdown の拡張は RDoc のパーサ独自にサポートされているも
のです。ただし、全てがデフォルトで有効にな... -
rake
/ rdoctask (18235.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 (18211.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 (18157.0) -
RDoc と ri のライブラリを生成するためのライブラリです。
RDoc と ri のライブラリを生成するためのライブラリです。
Usage: gem rdoc [args] [options]
Options:
--all インストールされている全ての Gem パッケージの
RDoc/RI ドキュメントを生成します。
--[no-]rdoc RDoc を含めます
--[no-]ri RI ... -
rdoc
/ context (18097.0) -
RDoc::Context と RDoc::Context::Section を定義するサブライ ブラリです。
RDoc::Context と RDoc::Context::Section を定義するサブライ
ブラリです。 -
rdoc
/ parser / ruby _ tools (18097.0) -
RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー ドのパーサを記述するためのモジュールを定義するサブライブラリです。
RDoc::RubyLex と RDoc::RubyToken を使って Ruby のソースコー
ドのパーサを記述するためのモジュールを定義するサブライブラリです。 -
rdoc
/ markup / to _ ansi (18085.0) -
RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ ブラリです。
RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ
ブラリです。
require 'rdoc/markup/to_ansi'
h = RDoc::Markup::ToAnsi.new
puts h.convert(input_string)
変換した結果は文字列で取得できます。 -
rdoc
/ markup / to _ bs (18085.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 (18085.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 (18067.0) -
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
RDoc::Markup::ToHtml を拡張して、ドキュメント内のメソッド名やクラ
ス名を自動的にリンクにします。 -
RDoc
:: RDoc # document(argv) -> nil (18055.0) -
argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ レクトリに出力します。
argv で与えられた引数を元にドキュメントをフォーマットして指定されたディ
レクトリに出力します。
@param argv コマンドラインで rdoc コマンドに指定するのと同じ引数を文字
列の配列で指定します。
@raise RDoc::Error ドキュメントの処理中にエラーがあった場合に発生します。
指定できるオプションについては、lib:rdoc#usage を参照してくださ
い。出力ディレクトリが指定されなかった場合はカレントディレクトリ の
doc 以下に出力します。 -
Gem
:: Commands :: RdocCommand (18049.0) -
RDoc と ri のライブラリを生成するためのクラスです。
RDoc と ri のライブラリを生成するためのクラスです。 -
rdoc
/ alias (18049.0) -
RDoc::Alias を定義するサブライブラリです。
RDoc::Alias を定義するサブライブラリです。 -
rdoc
/ anon _ class (18049.0) -
RDoc::AnonClass を定義するサブライブラリです。
RDoc::AnonClass を定義するサブライブラリです。 -
rdoc
/ any _ method (18049.0) -
RDoc::AnyMethod を定義するサブライブラリです。
RDoc::AnyMethod を定義するサブライブラリです。 -
rdoc
/ attr (18049.0) -
RDoc::Attr を定義するサブライブラリです。
RDoc::Attr を定義するサブライブラリです。 -
rdoc
/ class _ module (18049.0) -
RDoc::ClassModule を定義するサブライブラリです。
RDoc::ClassModule を定義するサブライブラリです。 -
rdoc
/ code _ object (18049.0) -
RDoc::CodeObject を定義するサブライブラリです。
RDoc::CodeObject を定義するサブライブラリです。 -
rdoc
/ constant (18049.0) -
RDoc::Constant を定義するサブライブラリです。
RDoc::Constant を定義するサブライブラリです。 -
rdoc
/ ghost _ method (18049.0) -
RDoc::GhostMethod を定義するサブライブラリです。
RDoc::GhostMethod を定義するサブライブラリです。 -
rdoc
/ include (18049.0) -
RDoc::Include を定義するサブライブラリです。
RDoc::Include を定義するサブライブラリです。 -
rdoc
/ markup / formatter (18049.0) -
RDoc 形式のドキュメントを整形するためのサブライブラリです。
RDoc 形式のドキュメントを整形するためのサブライブラリです。 -
rdoc
/ meta _ method (18049.0) -
RDoc::MetaMethod を定義するサブライブラリです。
RDoc::MetaMethod を定義するサブライブラリです。 -
rdoc
/ normal _ class (18049.0) -
RDoc::NormalClass を定義するサブライブラリです。
RDoc::NormalClass を定義するサブライブラリです。 -
rdoc
/ normal _ module (18049.0) -
RDoc::NormalModule を定義するサブライブラリです。
RDoc::NormalModule を定義するサブライブラリです。 -
rdoc
/ options (18049.0) -
rdoc コマンドのオプションを解析するためのサブライブラリです。
rdoc コマンドのオプションを解析するためのサブライブラリです。 -
rdoc
/ require (18049.0) -
RDoc::Require を定義するサブライブラリです。
RDoc::Require を定義するサブライブラリです。 -
rdoc
/ single _ class (18049.0) -
RDoc::SingleClass を定義するサブライブラリです。
RDoc::SingleClass を定義するサブライブラリです。 -
rdoc
/ stats (18049.0) -
RDoc のステータスを管理するサブライブラリです。
RDoc のステータスを管理するサブライブラリです。 -
rdoc
/ top _ level (18049.0) -
RDoc::TopLevel を定義するサブライブラリです。
RDoc::TopLevel を定義するサブライブラリです。 -
rdoc
/ generator / json _ index (18037.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 (18037.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
:: RDoc . add _ generator(klass) -> klass (18019.0) -
引数 klass で指定したクラスをジェネレータとして登録します。
引数 klass で指定したクラスをジェネレータとして登録します。
@param klass 登録するクラスを指定します。
@see c:RDoc::Options#custom_options -
rdoc
/ parser / changelog (18019.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 (18019.0) -
Ruby のソースコードを解析するためのサブライブラリです。
Ruby のソースコードを解析するためのサブライブラリです。
拡張子が .rb、.rbw のファイルを解析する事ができます。
=== メタプログラミングされたメソッド
動的に定義されたメソッドをドキュメントに含めたい場合、## でコメントを開始します。
##
# This is a meta-programmed method!
add_my_method :meta_method, :arg1, :arg2
RDoc::Parser::Ruby は上記の :meta_method ようにメソッドの定義を行
うような識別子の後に続くトークンをメソッド名として解釈します。... -
Rake
:: RDocTask (18001.0) -
-
rdoc
/ code _ objects (18001.0) -
Ruby のソースコード中にあるクラス、モジュール、メソッドなどの構成要素を 表現するためのサブライブラリです。
Ruby のソースコード中にあるクラス、モジュール、メソッドなどの構成要素を
表現するためのサブライブラリです。 -
rdoc
/ generator / darkfish (18001.0) -
HTML を生成するためのサブライブラリです。
HTML を生成するためのサブライブラリです。 -
rdoc
/ generator / markup (18001.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
rdoc
/ generator / ri (18001.0) -
ri のためのファイルを生成するためのサブライブラリです。
ri のためのファイルを生成するためのサブライブラリです。 -
rdoc
/ known _ classes (18001.0) -
Ruby の組み込みクラスに関する定数を定義するサブライブラリです。
Ruby の組み込みクラスに関する定数を定義するサブライブラリです。 -
rdoc
/ markdown / entities (18001.0) -
HTML の実体参照のマッピングを表す情報を定義するサブライブラリです。
HTML の実体参照のマッピングを表す情報を定義するサブライブラリです。 -
rdoc
/ parser / markdown (18001.0) -
Markdown 形式で記述されたファイルを解析するためのサブライブラリです。
Markdown 形式で記述されたファイルを解析するためのサブライブラリです。 -
rdoc
/ parser / rd (18001.0) -
RD 形式で記述されたファイルを解析するためのサブライブラリです。
RD 形式で記述されたファイルを解析するためのサブライブラリです。 -
rdoc
/ parser / simple (18001.0) -
ソースコード以外のファイルを解析するためのサブライブラリです。
ソースコード以外のファイルを解析するためのサブライブラリです。
ファイルの内容すべてを 1 つの大きなコメントとして処理します。ただし、ファ
イルの先頭が # で始まっていた場合、先頭行は削除されます。 -
rdoc
/ parser / text (18001.0) -
プログラムを含まないテキストを解析するためのサブライブラリです。
プログラムを含まないテキストを解析するためのサブライブラリです。 -
rdoc
/ text (18001.0) -
コメントテキストを処理するためのサブライブラリです。
コメントテキストを処理するためのサブライブラリです。 -
rdoc
/ token _ stream (18001.0) -
トークンを管理するためのサブライブラリです。
トークンを管理するためのサブライブラリです。 -
RDoc
:: TopLevel # find _ local _ symbol(name) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule | RDoc :: AnyMethod | RDoc :: Alias | RDoc :: Attr | RDoc :: Constant (11122.0) -
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。
クラス、モジュール、メソッド、定数、属性、alias、ファイルから name で指定したものを返します。見つからなかった場合は nil を返します。 -
RDoc
:: Context # add _ class _ or _ module(collection , class _ type , name , superclass = nil) -> RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule (10000.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 (10000.0) -
collection に name で指定したクラス、モジュールを追加します。
collection に name で指定したクラス、モジュールを追加します。
@param collection クラス、モジュールを追加する先を Hash オブジェ
クトで指定します。
@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param su... -
RDoc
:: Context # add _ module(class _ type , name) -> RDoc :: NormalModule | RDoc :: SingleClass | RDoc :: NormalClass (9982.0) -
引数で指定したモジュールを追加します。
引数で指定したモジュールを追加します。
ただし、クラスとして既に同名のものが登録されていた場合は、何もせずにそ
のクラスを返します。
@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@see RDoc::Context#add_class -
RDoc
:: TopLevel . all _ classes _ and _ modules -> [RDoc :: NormalClass | RDoc :: SingleClass | RDoc :: NormalModule] (9958.0) -
RDoc が収集したクラス、モジュールを配列で返します。
RDoc が収集したクラス、モジュールを配列で返します。 -
RDoc
:: Context # each _ classmodule {|m| . . . } -> [RDoc :: SingleClass | RDoc :: NormalClass | RDoc :: NormalModule] (9946.0) -
追加されたクラス、モジュールに対してブロックを評価します。
追加されたクラス、モジュールに対してブロックを評価します。
@see RDoc::Context#classes, RDoc::Context#modules -
RDoc
:: Context # add _ class(class _ type , name , superclass) -> RDoc :: SingleClass | RDoc :: NormalClass (9679.0) -
引数で指定したクラスを追加します。
引数で指定したクラスを追加します。
@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ
ブジェクトのいずれかで指定します。
@param name クラス名を文字列で指定します。
@param superclass 追加するクラスの親クラスを RDoc::NormalClass オ
ブジェクトで指定します。 -
RDoc
:: TopLevel . find _ class _ named(name) -> RDoc :: NormalClass | RDoc :: SingleClass | nil (9655.0) -
RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ からなかった場合は nil を返します。
RDoc が収集したクラスの内、name で指定した名前のクラスを返します。見つ
からなかった場合は nil を返します。
@param name クラス名を文字列で指定します。 -
Rake
:: RDocTask . new(name = :rdoc) {|pkg| . . . } -> Rake :: RDocTask (9652.0) -
自身を初期化して RDoc タスクを定義します。
自身を初期化して RDoc タスクを定義します。
ブロックが与えられた場合は、自身をブロックパラメータとして
ブロックを評価します。
@param name タスクの名前を指定します。 -
RDoc
:: Context # classes -> [RDoc :: SingleClass | RDoc :: NormalClass] (9607.0) -
追加されたクラスの配列を返します。
追加されたクラスの配列を返します。 -
RDoc
:: Generator :: JsonIndex . new(parent _ generator , options) -> RDoc :: Generator :: JsonIndex (9406.0) -
RDoc::Generator::JsonIndex オブジェクトを初期化します。
RDoc::Generator::JsonIndex オブジェクトを初期化します。
@param parent_generator 親となるジェネレータオブジェクトを指定します。
RDoc::Generator::JsonIndex#class_dir や
#file_dir を決めるのに使用します。
他のジェネレータとは異なり、RDoc::Store
オブジェクトではない点に注意してください。
@... -
RDoc
:: Parser . parser _ for(top _ level , file _ name , body , options , stats) -> RDoc :: Parser (9406.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 オブジェクトを指定します。 -
RDoc
:: Generator :: Darkfish # initialize(store , options) -> RDoc :: Generator :: Darkfish (9388.0) -
RDoc::Generator::Darkfish オブジェクトを初期化します。
RDoc::Generator::Darkfish オブジェクトを初期化します。
@param store RDoc::Store オブジェクトを指定します。
@param options RDoc::Options オブジェクトを指定します。 -
RDoc
:: Generator :: RI # initialize(store , options) -> RDoc :: Generator :: RI (9388.0) -
RDoc::Generator::RI オブジェクトを初期化します。
RDoc::Generator::RI オブジェクトを初期化します。
@param store RDoc::Store オブジェクトを指定します。
@param options RDoc::Options オブジェクトを指定します。 -
RDoc
:: Context # add _ alias(an _ alias) -> RDoc :: Alias (9370.0) -
引数で指定した RDoc::Alias オブジェクトを追加します。
引数で指定した RDoc::Alias オブジェクトを追加します。
@param an_alias RDoc::Alias オブジェクトを指定します。 -
RDoc
:: Parser :: Simple # scan -> RDoc :: TopLevel (9370.0) -
自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し ます。
自身の持つ RDoc::TopLevel のコメントとしてファイルの内容を解析し
ます。
@return RDoc::TopLevel オブジェクトを返します。