Generating Documentation
Generating PAS documentation saves all recently updated and added PAS annotations. In order to generate documentation the user must
first perform the following steps:
- Select and locate the Program's source code
- Determine which declaration / header files to include or exclude
- Generate the program's Class list
From the main screen, click the "Generate Documentation" button to initiate the generation of an updated set of documentation.
The PAS-Generator first displays a warning dialog asking if your are sure. Select yes.
Next the PAS-Generator will check to see if a "html" directory exists. If so, the PAS-Generator
asks if you wish to over-write it. Select yes.
After determing the html directory, the PAS-Generator provides the programmer with the option of printing the data members for each class
before the class functions or after. Select either the "Before" or "After" button.
The PAS-Generator then proceeds to read through each class constructing the PAS documentation based on the current variable and member options
selected, and the programmers decision to place the variables before or after the functions.
Finally the PAS-Generator makes copy of the .h and .cpp files for each class into the "html" folder.