Module

R2Doc::Generator

Inheritance

Custom generator

Methods

Instance

Visibility Signature
public generate (toplevels)
protected add_to_static_file_list (dir, relpath = '')
protected build_class_list (from, html_file)
protected build_indices ()
protected build_static_file_list ()
protected copy_static_files ()
protected generate_html ()
protected generate_index ()
protected load_html_template ()
protected render (filename, template, b = nil)

Instance Method Detail

generate(toplevels)

generate the docs

add_to_static_file_list(dir, relpath = '')

recursively add a directory‘s contents to the static file list

build_class_list(from, html_file)

Build a class list from a top-level class

build_indices()

build indices of our objects

build_static_file_list()

build the static file list

copy_static_files()

copy any static files needed by the template

generate_html()

Outputs the html

generate_index()

Generate an index file

load_html_template()

load the template files

render(filename, template, b = nil)

Run a template and output the contents