検索結果

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 のソースファイルに対するドキュメ...

...ンを指定した場合に、標準エラーに情報を出力して終了ステー
タス 1 でプログラムを終了します。

: --image-format gif/png/jpg/jpeg

図のフォーマットを指定します。png、gif、jpeg、jpg が指定できます。指
定しなかった場合は...

• 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/formatter (12016.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::Formatter
• rdoc/markup

RDoc::Options#image_format -> String (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

• インスタンスメソッド

コマンドライン引数の --image-format オプションで指定した名前を文字列の 配列で返します。

...コマンドライン引数の --image-format オプションで指定した名前を文字列の
配列で返します。

指定しなかった場合は 'png' を返します。...

• RDoc::Options

RDoc::Options#formatter -> nil (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

• インスタンスメソッド

使用されていません。常に nil を返します。

使用されていません。常に nil を返します。

• RDoc::Options

RDoc::Options#formatter=(val) (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::Options

絞り込み条件を変える

RDoc::Markup::Formatter (9022.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::ToHtml のような、
継承したクラスで convert メソッドを実行してください。...

• RDoc::Markup::ToHtml

RDoc::Markup::Formatter.new(markup = nil) -> RDoc::Markup::Formatter (6207.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 markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。...

• RDoc::Markup
• RDoc::Markup::Formatter

rdoc/markup (6106.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::ToHtm...

• 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::Formatter#add_tag(name, start, stop) -> () (6018.0)

• 2.2.0
• 2.3.0
• 3.2
• 3.4

• インスタンスメソッド

name で登録された規則で取得された文字列を start と stop で囲むように指 定します。

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

@param start 開始の記号を文字列で指定します。

@param stop 終了の記号を文字列で指定します。

例:

require 'rdoc/markup/to_html...

...'

# :STRIKE のフォーマットを <strike> 〜 </strike> に指定。
h = RDoc::Markup::ToHtml.new
h.add_tag(:STRIKE, "<strike>", "</strike>")...

• RDoc::Markup::Formatter
• RDoc::Markup::ToHtml