class RDoc::Markup::ToHtmlCrossref

要約

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

目次

特異メソッド

• new

継承しているメソッド

RDoc::Markup::Formatterから継承しているメソッド

• add_tag
• convert

特異メソッド

new(path, context, show_hash) -> RDoc::Markup::ToHtmlCrossref[permalink][rdoc][edit]

自身を初期化します。

[PARAM] path:

生成するファイルのパスを文字列で指定します。

[PARAM] context:

RDoc::Context オブジェクトかそのサブクラスのオブジェクトを指定します。

[PARAM] show_hash:

true を指定した場合、メソッド名のリンクに # を表示します。false の場合は表示しません。

[EXCEPTION] ArgumentError:

path に nil を指定した場合に発生します。