The HTML Formatter

The HTML formatter generates html output. It is designed in a modular way, to let users customize in much detail how to format the data. All output is organized by a set of views, which highlight different aspects of data. Some views show the file / directory layout, others group declarations by scopes, or provide an annotated (and cross-referenced) source view.

By default the formatter generates its output using frames. The views are formatter parameters. index is a list of views that fill the upper-left index frame. detail is a list of views for the lower-left detail frame, and content sets all the views for the main content frame.

When the index and detail arguments are empty lists, non-framed html will be generated.

Here are the most important View types:

Scope

The most important view for documentation purposes is doubtless the Scope view. It presents all declaration in a given scope, together with a number of references to other views if appropriate.

InheritanceGraph

A UML-like inheritance diagram for all classes.

NameIndex

A global index of all declared names (macros, variables, types, ...)

Source

A cross-referenced view of a source file.

XRef

A listing of symbols with links to their documentation, definition, and reference.

FileDetails

Shows details about a given file, such as what other files are included, what declarations it contains, etc.

Directory

Presents a directory (of source files). This is typically used in conjunction with the Source view above.

FileTree

A javascript-based file tree view suitable for the index frame for navigation.

ModuleTree

A javascript-based module tree view suitable for the index frame for navigation.