add_word_pair(start, stop, name) -> ()Ruby 1.9.3 から Ruby 4.1 で削除[permalink][rdoc][edit]-
start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にします。
- [PARAM]
start: - 開始となる文字列を指定します。
- [PARAM]
stop: - 終了となる文字列を指定します。start と同じ文字列にする事も可能です。
- [PARAM]
name: - RDoc::Markup::ToHtml などのフォーマッタに識別させる時の名前を Symbol で指定します。
- [EXCEPTION]
ArgumentError: - start に "<" で始まる文字列を指定した場合に発生します。
require 'rdoc' require 'rdoc/markup/to_html' m = RDoc::Markup.new m.add_word_pair("{", "}", :MARK) h = RDoc::Markup::ToHtml.new(RDoc::Options.new, m) h.add_tag(:MARK, "<mark>", "</mark>") p h.convert("a {b} c") # => "\n<p>a <mark>b</mark> c</p>\n"変換時に実際にフォーマットを行うには RDoc::Markup::Formatter#add_tag のように、フォーマッタ側でも操作を行う必要があります。
- [PARAM]