Ruby 1.9.3 リファレンスマニュアル > ライブラリ一覧 > rdoc/markup/to_html_crossrefライブラリ > RDoc::Markup::ToHtmlCrossrefクラス

class RDoc::Markup::ToHtmlCrossref + RDoc::Markup::ToHtml + RDoc::Markup::Formatter

クラスの継承リスト: RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml < RDoc::Markup::Formatter < Object < Kernel < BasicObject

要約

RDoc 形式のドキュメントを HTML に整形するクラスです。

特異メソッド

new(path, context, show_hash) -> RDoc::Markup::ToHtmlCrossref

自身を初期化します。

[PARAM] path:
生成するファイルのパスを文字列で指定します。
[PARAM] context:
RDoc::Context オブジェクトかそのサブクラスのオブジェ クトを指定します。
[PARAM] show_hash:
true を指定した場合、メソッド名のリンクに # を表示しま す。false の場合は表示しません。
[EXCEPTION] ArgmentError:
path に nil を指定した場合に発生します。
new -> RDoc::Markup::ToHtml

自身を初期化します。

new(markup = nil) -> RDoc::Markup::Formatter

自身を初期化します。

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

インスタンスメソッド

add_tag(name, start, stop) -> ()

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

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

[PARAM] content:
変換する文字列を指定します。
class RDoc::Markup::ToHtmlCrossref