検索結果

rdoc (44644.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• ライブラリ

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

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

このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby...

...ラリとして使いたければ、RDoc::Markup を参照してください。

=== 概要

インストールすれば、'rdoc' コマンドでドキュメントが生成できます。
(Windows では 'rdoc.bat' です)

$ rdoc [options] [names...]

"rdoc --help" と打てば、最新のオプ...

...、--ri-site で $datadir/ri/<ver>/site
に、--ri-system で $datadir/ri/<ver>/system に出力されます。これらす
べてはうしろに指定した --op を上書きします。デフォルトのディレクトリ
は ri のデフォルトのサーチパスです。

: --show-hash...

• RDoc
• RDoc::Error
• rdoc/alias
• rdoc/anon_class
• rdoc/any_method
• rdoc/attr
• rdoc/class_module
• rdoc/code_object
• rdoc/code_objects
• rdoc/constant
• rdoc/context
• rdoc/generator
• rdoc/generator/darkfish
• rdoc/generator/json_index
• rdoc/generator/markup
• rdoc/generator/ri
• rdoc/ghost_method
• rdoc/include
• rdoc/known_classes
• rdoc/markdown
• ...

RDoc::Text#strip_hashes(text) -> String (15400.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

引数から各行の行頭の # を削除します。

...引数から各行の行頭の # を削除します。

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

• RDoc::Text

RDoc::Options#show_hash -> bool (12233.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

コマンドライン引数の --show-hash オプションを指定していた場合、true を 返します。そうでない場合は false を返します。

...コマンドライン引数の --show-hash オプションを指定していた場合、true を
返します。そうでない場合は false を返します。...

• RDoc::Options

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

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

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

...加します。

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

@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ...

...ブジェクトのいずれかで指定します。

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

@param superclass 追加するクラスの親クラスを RDoc::NormalClass オ
ブジェクトで指定します。

既に登録済みであった場合は、...

...引数で指定した情報で内容を更新します。ただ
し、RDoc::CodeObject#done_documenting が true を返す場合、何も行
われません。...

• Hash
• RDoc::Context
• RDoc::NormalClass

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

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

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

...加します。

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

@param class_type 追加するクラス、モジュールを RDoc::NormalClass、
RDoc::SingleClass、RDoc::NormalModule オ...

...ブジェクトのいずれかで指定します。

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

@param superclass 追加するクラスの親クラスを RDoc::NormalClass オ
ブジェクトで指定します。

既に登録済みであった場合は、...

...引数で指定した情報で内容を更新します。ただ
し、RDoc::CodeObject#done_documenting が true を返す場合、何も行
われません。...

• Hash
• RDoc::NormalClass
• RDoc::TopLevel

絞り込み条件を変える

RDoc::Markup::ToHtmlCrossref.new(path, context, show_hash) -> RDoc::Markup::ToHtmlCrossref (6414.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• 特異メソッド

自身を初期化します。

...自身を初期化します。

@param path 生成するファイルのパスを文字列で指定します。

@param context RDoc::Context オブジェクトかそのサブクラスのオブジェ
クトを指定します。

@param show_hash true を指定した場合、メソッ...

...ド名のリンクに # を表示しま
す。false の場合は表示しません。

@raise ArgumentError path に nil を指定した場合に発生します。...

• RDoc::Context
• RDoc::Markup::ToHtmlCrossref

RDoc::Context#unmatched_alias_lists -> {String => RDoc::Alias} (6333.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• インスタンスメソッド

メソッド名の対応が取れていない alias の旧メソッド名がキー、 RDoc::Alias が値の Hash を返します。

...メソッド名の対応が取れていない alias の旧メソッド名がキー、
RDoc::Alias が値の Hash を返します。...

• Hash
• RDoc::Alias
• RDoc::Context

Ruby用語集 (6250.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• 文書

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-ba...

...アクセスするためのオブジェクト。
Hash に似たインターフェースを持つ。キーも値も文字列である。
ENV で環境変数を変更すると Ruby の子プロセスにも引き継がれる。

参照：ENV

: eRuby
テンプレートシステムおよびそ...

...つ。Linux、macOS などで動作する。

https://github.com/rbenv/rbenv

: RD（Ruby Document format）
Ruby スクリプト中に記述することを念頭に作られたドキュメントフォーマット。

: RDoc
Ruby スクリプトからそのスクリプトのドキュメント...

• ArgumentError
• Array
• BasicObject
• BigDecimal
• Class
• Comparable
• ENV
• ERB
• Encoding
• Enumerable
• Enumerator
• Exception
• Fiber
• Float
• GC
• Hash
• Integer
• Matrix
• Method
• Module
• ...

RDoc::Markdown::HTML_ENTITIES -> {String => [Integer]} (6232.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3

• 定数

HTML の実体参照のマッピングを表す Hash オブジェクトです。 RDoc::Markdown で使用します。

...HTML の実体参照のマッピングを表す Hash オブジェクトです。
RDoc::Markdown で使用します。...

• Hash
• RDoc::Markdown

RDoc::CodeObject#metadata -> Hash (6201.0)

• 2.1.0

• インスタンスメソッド

自身が持つメタデータ(他から任意の値を設定してもよい)を返します。

自身が持つメタデータ(他から任意の値を設定してもよい)を返します。

• RDoc::CodeObject

絞り込み条件を変える