検索結果

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

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

...ブラリを含めたければ、rdoc/parser/c を参照してください。
* コメント部で使えるマークアップについて知りたければ、rdoc/markup を参照してください。
* RDoc をライブラリとして使いたければ、RDoc::RDoc を参照してください。...

• 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::Options#markup -> String (21123.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

• インスタンスメソッド

コマンドライン引数の --markup オプションで指定したフォーマットを返しま す。

...コマンドライン引数の --markup オプションで指定したフォーマットを返しま
す。

指定されていない場合は 'rdoc' を返します。...

• RDoc::Options

RDoc::Text#markup(text) -> String (21101.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

• インスタンスメソッド

引数を整形します。

引数を整形します。

include したクラスに self#formatter メソッドが必要です。

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

• RDoc::Text

rdoc/markup/to_rdoc (18028.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 形式のドキュメントをマークアップ記法を保持したまま出力させるための サブライブラリです。

...RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
サブライブラリです。

サブクラス(RDoc::Markup::ToAnsi など)を作成して使います。...

• RDoc::Markup::ToRdoc

rdoc/markup (12130.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 形式に整形されたプレインテキストを変換するためのサブライブラリです。

...RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。

RDoc::Markup は RDoc 形式のドキュメント、Wiki エントリ、Web上の
FAQ などを想定したプレインテキストから様々なフォーマットへの変換を行う
ツ...

...基礎として作られています。RDoc::Markup 自身は何の出力も
行いません。
それらは output_format で後述するクラス群に委ねられています。

=== Markup

基本的には、lib:rdoc#markup と同じです。ただし、rdoc コマンドと
は異なり、Ruby...

...* lib:rdoc#list
* lib:rdoc#labeled_list
* lib:rdoc#headline
* lib:rdoc#ruled_line
* lib:rdoc#italic_bold_typewriter
* lib:rdoc#escape


===[a:output_format] 出力可能な形式

変換する形式として以下のいずれかを選択できます。

* HTML 形式: RDoc::Markup::ToHtml...

• RDoc::Markup
• rdoc/markup/formatter
• rdoc/markup/to_ansi
• rdoc/markup/to_bs
• rdoc/markup/to_html
• rdoc/markup/to_html_crossref
• rdoc/markup/to_rdoc

絞り込み条件を変える

rdoc/markup/to_ansi (12040.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 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ ブラリです。

...RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ
ブラリです。

require 'rdoc/markup/to_ansi'

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

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

• RDoc::Markup::ToAnsi

rdoc/markup/to_bs (12040.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 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効 果を持たせるように見せるサブライブラリです。

...RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効
果を持たせるように見せるサブライブラリです。

require 'rdoc/markup/to_bs'

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

変換した結果は文字列で...

• RDoc::Markup::ToBs

rdoc/markup/to_html (12040.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 (12028.0)

• 2.5.0
• 2.6.0
• 2.7.0
• 3.1

• ライブラリ

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

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

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

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