Documenting Wizard: Step 5 – Select Reports
Allows you to specify the types of reports that the Documenting Wizard creates. (The reports are actually text files.) The wizard can produce the types of reports listed in the following table.
| Report Type | File Name | Remarks |
|---|---|---|
| Action Diagram | project.act | Shows the hierarchical relations within your code. If you are not working with ASCII code page 1250 and ANSI code page 1252, see the directive "*# document ACTIONCHARS" in Customizing the Documenting Wizard. |
| Cross-Reference | Xref.lst | Lists all the user-defined symbols. |
| File Listing | Files.lst | Lists all the files in the project. |
| Source Code Listing | project.lst | Puts all formatted code in a single file. |
| Tree Diagram | Tree.lst | Shows the procedure calling tree. |
The wizard also automatically creates the following files.
| File Name | Description |
|---|---|
| Files.dbf | Table with a record for each file in the project. |
| Fdxref.dbf | Table with a record for each instance of user symbols in the code. |
Fdxref.dbf contains a field named Flag for identifying the keywords. The identifiers are the following.
| Flag | Description |
|---|---|
| B | Base class |
| C | Class name |
| D | Defined PROC or FUNC (not method) |
| F | Function call: myproc( ) or DO myproc |
| K | Keyword |
| M | Method definition |
| N | Name of file |
| O | Object |
| P | Property of an object |
| R | User symbol reference |
| V | User symbols (variable) definition (PARA, PRIV, PUBL, DIME) |
See Also
Customizing the Documenting Wizard | Documenting Wizard: Step 1 - Choose Source File | Documenting Wizard: Step 2 - Set Capitalization | Documenting Wizard: Step 3 - Set Indentation | Documenting Wizard: Step 4 - Add Headings | Documenting Wizard: Step 6 - Finish | Wizards Overview