constants | attributes | methods
Class

Generators::XMLGenerator

Inheritance
< Generators::HTMLGenerator < Object

Generate XML output as one big file

Methods

Class

Visibility Signature
public for (options)
public new (*args)

Instance

Visibility Signature
public build_class_list (from, html_file, class_dir)
public build_indices ()
public gen_an_index (collection, title)
public gen_class_index ()
public gen_file_index ()
public gen_into (list)
public gen_method_index ()
public generate (info)
public generate_xml ()

Class Method Detail

for(options)

Standard generator factory

new(*args)

Instance Method Detail

build_class_list(from, html_file, class_dir)

build_indices()

Generate:

  • a list of HtmlFile objects for each TopLevel object.
  • a list of HtmlClass objects for each first level class or module in the TopLevel objects
  • a complete list of all hyperlinkable terms (file, class, module, and method names)

gen_an_index(collection, title)

gen_class_index()

gen_file_index()

gen_into(list)

gen_method_index()

generate(info)

Build the initial indices and output objects based on an array of TopLevel objects containing the extracted information.

generate_xml()

Generate all the HTML. For the one-file case, we generate all the information in to one big hash