Class

HTMLGenerator

Extends:

Includes:

There's no documentation for this item.

Public Methods
for Generators may need to return specific subclasses depending on the options they are passed. Because of this we create them using a factory
gen_url convert a target url to one that is relative to a given path
generate Build the initial indices and output objects based on an array of TopLevel objects containing the extracted information.
new Set up a new HTML generator. Basically all we do here is load up the correct output temlate
Private Methods
build_class_list
build_indices Generate:
gen_an_index
gen_class_index
gen_file_index
gen_into
gen_main_index The main index page is mostly a template frameset, but includes the initial page. If the —main option was given, we use this as our main page, otherwise we use the first file specified on the command line.
gen_method_index
gen_sub_directories See the comments at the top for a description of the directory structure
generate_html Generate all the HTML
load_html_template Load up the HTML template specified in the options. If the template name contains a slash, use it literally
main_url return the url of the main page
write_style_sheet Write out the style sheet used by the main frames
Comments

Have your say
Please use Textile formatting (click here for a cheat sheet). Use <code/> and <pre/> for code samples.
Click here to login with OpenID to to post comments.