class SM::ToFlow

要約

RDoc 形式のドキュメントを表示する一段階前の構造化された状態にするためのクラスです。

[注意] 1.9 系では、require 先やクラス名が以下のように変更になりました。

• require 先: rdoc/markup/to_flow
• クラス名: RDoc::Markup::ToFlow

目次

特異メソッド

• new

インスタンスメソッド

• add_tag

特異メソッド

new -> SM::ToFlow[permalink][rdoc]

自身を初期化します。

実際に文字列を変換する際には、SM::SimpleMarkup#convert の引数に自身を渡します。

[SEE_ALSO] SM::SimpleMarkup#convert

インスタンスメソッド

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

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

[PARAM] name:

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

[PARAM] start:

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

[PARAM] stop:

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