Introduction |
The Data Dictionary Report lists all Ada entities in alphabetic order. Each listing has the name of the entity, what kind of entity it is, where it can be found in the source code, and also the data dictionary definition given in the comments in the source code.
The data dictionary definition is parsed from comments following the entity. If the associate_comments flags are specified when running analyze_ada (See Analyzing Your Source Code) then comments are placed in the database. If these options are not checked, then any comments beginning with the % mark are used (e.g. --% comment ).
The Program Unit Cross Reference Report lists all program units analyzed into the library in alphabetic order along with information about what they return (if anything), what parameters are used, and where they are used by other program units.
The Exception Cross Reference Report documents the declaration and usage of all exceptions. Each declaration and any raises or handles are documented. In the HTML version each raise or handle may be visited in the source, as well as the declaration point of the Exception (if visible).
The Object Cross Reference Report lists all Ada objects (variables, parameters, constants) in alphabetic order along with declaration and usage references. The HTML version of this report includes hyperlinks to the source code of each reference.
The Type Cross Reference Report lists all types, sub-types, and derived types in alphabetic order along with declaration and usage. Usage information may be used to create a variable or new type/sub-type, or simply a reference to an attribute of the class (e.g. Integer'First).
The layout format and usage is identical to the Object and Program Unit Cross Reference Report.
The Interrupt Cross Reference Report tracks uses of the Ada mechnism for assigning a task unit to a physical memory address:
entry character_ready;This is most often used for defining interrupt handlers. Each physical memory assignment is documented in the report as shown below.
Scientific Toolworks, Inc. http://www.scitools.com Voice: (802) 763-2995 Fax: (802) 763-3066 support@scitools.com sales@scitools.com |