検索結果

rdoc (38380.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
• 3.4

• ライブラリ

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

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

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

...ットに変換するた
めのライブラリです。RDoc によってメソッドやクラスに関するドキュメントを
生成するとき、コメント部を変換するために使われます。

=== ロードマップ

* RDoc で Ruby のソースファイルに対するドキュメ...

...d_typewriter] イタリック体、ボールド体、タイプライター体

文中で以下のようなマークアップもできます。

* イタリック体 italic: _word_ もしくは <em>text</em>
* ボールド体 bold: *word* もしくは <b>text</b>
* タイプライター体 typewr...

• 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::Markup#get_line_types -> [Symbol] (9106.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
• 3.4

• インスタンスメソッド

変換する文字列の各行のタイプを Symbol の配列で返します。

...変換する文字列の各行のタイプを Symbol の配列で返します。

rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。

@see SM::SimpleMarkup#convert...

• RDoc::Markup
• Symbol

RDoc::Context::TYPES -> ["class", "instance"] (9100.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
• 3.4

• 定数

メソッドの種類を文字列の配列で返します。

メソッドの種類を文字列の配列で返します。

• RDoc::Context

rdoc/markdown (6094.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
• 3.4

• ライブラリ

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

...ドキュメントを rdoc 上で解析するための
サブライブラリです。

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

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

Markdown 形式をデフォルトのフォーマットにする場合は、
lib:rdoc#saved_options を参...

...ルトを
.rdoc_options ファイルで設定してください。

=== 拡張

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

==== RDoc

RDoc の Markdow...

...m/

==== CSS

RDoc::Markdown#css を設定する事で CSS を記述した場合に出力に含め
る事ができます。ただし、それを常に RDoc の出力に含める事はできま
せん。この拡張はデフォルトでは無効になっています。

例:

<style type="text/css"...

• RDoc::Markdown
• rdoc
• rdoc/markdown/entities
• rubygems
• rubygems/builder
• rubygems/defaults
• rubygems/dependency
• rubygems/digest/sha2
• rubygems/exceptions
• rubygems/gem_path_searcher
• rubygems/platform
• rubygems/remote_fetcher
• rubygems/requirement
• rubygems/source_index
• rubygems/source_info_cache
• rubygems/source_info_cache_entry
• rubygems/spec_fetcher
• rubygems/specification
• rubygems/user_interaction
• rubygems/version

RDoc::Context#add_class_or_module(collection, class_type, name, superclass = nil) -> RDoc::NormalClass | RDoc::SingleClass | RDoc::NormalModule (3440.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
• 3.4

• インスタンスメソッド

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

...加する先を Hash オブジェ
クトで指定します。

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

@para...

...am 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 (3440.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
• 3.4

• インスタンスメソッド

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

...加する先を Hash オブジェ
クトで指定します。

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

@para...

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

既に登録済みであった場合は、引数で指定した情報で内容を更新します。ただ
し、RDoc::CodeObject#done_documenting が true を返す場...

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

RDoc::Context#add_module(class_type, name) -> RDoc::NormalModule | RDoc::SingleClass | RDoc::NormalClass (3434.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
• 3.4

• インスタンスメソッド

引数で指定したモジュールを追加します。

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

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

@see RDoc::Context#add_cl...

• RDoc::Context
• RDoc::NormalClass

RDoc::Context#add_class(class_type, name, superclass) -> RDoc::SingleClass | RDoc::NormalClass (3333.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
• 3.4

• インスタンスメソッド

引数で指定したクラスを追加します。

...引数で指定したクラスを追加します。

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

@param name クラス名を文...

...字列で指定します。

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

• RDoc::Context
• RDoc::NormalClass

RDoc::Parser::Ruby::NORMAL -> "::" (3032.0)

• 2.5.0
• 2.6.0
• 3.0
• 3.1

• 定数

RDoc::NormalClass type

...
RDoc::NormalClass type...

• RDoc::Parser::Ruby