検索結果

rdoc (38410.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...

...ュメントを出
力します(現在は HTML しか出力できませんが、この部分は取り替え可能にでき
ています)。Markup とはプレーンテキストを様々なフォーマットに変換するた
めのライブラリです。RDoc によってメソッドやクラスに...

...使われます。

=== ロードマップ

* RDoc で Ruby のソースファイルに対するドキュメントを生成したければ、まずこの文章を読みましょう。
* Cで書かれた拡張ライブラリを含めたければ、rdoc/parser/c を参照してください。
* コ...

• 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::Markdown#html -> bool (21117.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

• インスタンスメソッド

HTML を記述した場合にそのまま出力するかどうかを返します。

...
HTML を記述した場合にそのまま出力するかどうかを返します。

デフォルトでは true を返します。...

• RDoc::Markdown

rdoc/markup/to_html (12050.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 形式のドキュメントを HTML に整形するためのサブライブラリです。

...RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

require 'rdoc/markup/to_html'

h = RDoc::Markup::ToHtml.new
puts h.convert(input_string)

変換した結果は文字列で取得できます。...

• RDoc::Markup::ToHtml
• rdoc/markup
• rdoc/markup/formatter

rdoc/markup/to_html_crossref (12038.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 形式のドキュメントを HTML に整形するためのサブライブラリです。

...RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

RDoc::Markup::ToHtml を拡張して、ドキュメント内のメソッド名やクラ
ス名を自動的にリンクにします。...

• RDoc::Markup::ToHtmlCrossref
• rdoc/markup
• rdoc/markup/formatter
• rdoc/markup/to_html

RDoc::Markdown::HTML_ENTITIES -> {String => [Integer]} (9133.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

• 定数

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

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

• Hash
• RDoc::Markdown

絞り込み条件を変える

Rake::RDocTask#rdoc_dir -> String (9133.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

• インスタンスメソッド

作成した HTML ファイルを保存するディレクトリ名を返します。 デフォルトは html です。

...作成した HTML ファイルを保存するディレクトリ名を返します。
デフォルトは html です。...

• Rake::RDocTask

RDoc::Markup#add_html(tag, name) -> () (9125.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

• インスタンスメソッド

tag で指定したタグをフォーマットの対象にします。

...ram name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_html("no", :STRIKE)

h = SM::ToHtml.new
h.add_ta...

...g(:STRIKE, "<strike>", "</strike>")
puts m.convert(input_string, h)

変換時に実際にフォーマットを行うには SM::ToHtml#add_tag のように、
フォーマッタ側でも操作を行う必要があります。...

• RDoc::Markup
• SM::ToHtml

RDoc::Markdown#html=(val) (9117.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

• インスタンスメソッド

HTML を記述した場合にそのまま出力するかどうかを設定します。

...
HTML を記述した場合にそのまま出力するかどうかを設定します。...

• RDoc::Markdown

Rake::RDocTask#rdoc_dir=(dir) (9117.0)

• 2.3.0
• 3.0
• 3.1
• 3.4

• インスタンスメソッド

作成した HTML ファイルを保存するディレクトリ名をセットします。

...作成した HTML ファイルを保存するディレクトリ名をセットします。...

• Rake::RDocTask