Previous Next
Basic components

Documentation View
The Documentation View contains the documentation of source code at the symbol level. The documentation of a particular symbol is contained within separators. A symbol's documentation starts with the symbol name and symbol signature (if it has one). The actual documentation of the symbol follows in the documentation body, which is split into a series of sections. Each section begins with a section identifier. Its section text follows on the next line.
Symbol List
For a description of the icons used in the Symbol List, please see Quick Reference.
The Symbol List displays the list of symbols that are documented in the documentation file. The list contains one or more symbols, depending on whether the documentation file has been generated for one symbol or an entire file.
The icons that precede the symbols in the Symbol List and the typeface of the symbols indicate what their documentation status is.
A typical entry in the Symbol List looks like this:

It consists of a status icon, the symbol name and, in parentheses, the symbol type. For a list of the various symbol types, please refer to Graph view.
Class drop-down
You can use the Class drop-down to specify which classes of symbols are to be displayed in the Symbol List.

Previous Next