HTML output

[next] [tail] [up]

### 6.1 HTML output

The HTML output consists of the following files, per unit:

1. A general unit description with the contents of the module’s descr tag. The uses clause is documented here as well. All units in the uses clause together with their short description tags are typeset in a table.
2. A listing of all constants in the unit.
3. A listing of all types in the unit (except classes).
4. A listing of all variables in the unit.
5. A listing of all functions/procedures in the unit.
6. A listing of all classes in the unit.
7. An index page per unit and per package. This is an index page, listing all top-level identifiers in the current unit or all units of the package.

All these overviews are hyperlinked to pages which contain the documentation of each identifier. Each page starts with the name of the identifier, plus a synopsis (made from the short tag’s contents). After that follows the declaration, and the description. The description is filled with the descr node of the identifiers element tag.

If an errors tag was present, an ’Errors’ section follows the description. Similarly, if there is a seealso tag, a ’See also’ section with cross-reference links is made.

For classes, the declaration contains hyperlinks to separate pages which document all the members of the class. Each member in the declaration is followed by the short tag of the member’s element tag, if one exists. As an extra, the class hierarchy is given, plus links to pop-up pages (if JavaScript is available, otherwise they are normal links) which contain alphabetical or hierarchical listings of the methods, fields or properties of the class.

For functions and procedures, the declaration will be typeset in such a way that all function arguments (if they are present) are in tabular format, followed by the short description of the argument. If it concerns a function, and a result element exists, the result description will be provided in a separate section, before the actual description.

The declaration of an enumerated type will be laid out in a table, with the enumeration value at the left, and the short description node of the value’s element.

[next] [front] [up]