class RDoc::Generator::Darkfish

要約

HTML を生成するためのクラスです。

目次

インスタンスメソッド

• class_dir
• file_dir
• generate
• initialize
• time_delta_string

定数

• GENERATOR_DIR
• VERSION

継承しているメソッド

インスタンスメソッド

class_dir -> nilRuby 1.9.2 から Ruby 4.0 で削除[permalink][rdoc][edit]

file_dir -> nil

常に nil を返します。

生成するクラス・ファイルの HTML を出力ディレクトリのどこに置くか(出力ディレクトリからの相対パス)を返すためのフックです。サブクラスでオーバーライドして使用します。

generate -> ()Ruby 1.9.3 から[permalink][rdoc][edit]

解析した情報を HTML ファイルや検索用のインデックスに出力します。

initialize(store, options) -> RDoc::Generator::DarkfishRuby 1.9.3 から[permalink][rdoc][edit]

RDoc::Generator::Darkfish オブジェクトを初期化します。

[PARAM] store:

RDoc::Store オブジェクトを指定します。

[PARAM] options:

RDoc::Options オブジェクトを指定します。

time_delta_string(seconds) -> StringRuby 2.0.0 から Ruby 4.0 で削除[permalink][rdoc][edit]

seconds で指定した秒数を、人が読みやすい形式の文字列にして返します。

[PARAM] seconds:

秒数を数値で指定します。

[RETURN]

"less than a minute"、"3 minutes"、"about one hour"、"2 days"、 "3 weeks" のように、秒数のおおまかさに応じた形式の文字列を返します。

定数

GENERATOR_DIR -> StringRuby 1.9.3 から[permalink][rdoc][edit]

このファイルの親ディレクトリへのパスを表す文字列です。

テンプレートなどのリソースを検索するのに内部で使用します。

VERSION -> '3'Ruby 1.9.3 から[permalink][rdoc][edit]

darkfish のバージョンです。