class RDoc::Markup::Formatter

要約

RDoc 形式のドキュメントを整形するための基本クラスです。

実際にドキュメントを整形するには、RDoc::Markup::ToHtml のような、継承したクラスで convert メソッドを実行してください。

目次

特異メソッド

• new

インスタンスメソッド

• add_tag
• convert

特異メソッド

new(markup = nil) -> RDoc::Markup::Formatter[permalink][rdoc][edit]

自身を初期化します。

[PARAM] markup:

RDoc::Markup オブジェクトを指定します。省略した場合は新しく作成します。

インスタンスメソッド

add_tag(name, start, stop) -> ()[permalink][rdoc][edit]

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>")

convert(content) -> ()[permalink][rdoc][edit]

content で指定された文字列を変換します。

[PARAM] content:

変換する文字列を指定します。