Working with Main Annotations

Main Annotations are notes / comments added to specific individual components for a program from different viewpoints. Users can review, update and erase existing main annotations. In order to work with annotations the user must first perform the following steps:

  1. Select and locate the Program's source code
  2. Determine which declaration / header files to include or exclude
  3. Generate the program's Class list



From the main screen, in order to view, update and/or erase an existion annotation, select a class from the list of classes.
After a class is selected, click the "Annotation" to display the list of classes.




The Annotations dialog will be displayed. Using this dialog you can view, update and/or erase any main annotations for the class, or function within the class or a specific alogrithm within a function.




Class-level Annotations

Any existing class-level main annotation will automatically be displayed when the dialog window opens. To update, ore erase the existing annotation content for the "class", just enter the annotation text into the Domain Annotation for Class: ### edit box.




When the "OK" button is pressed, PAS Generator will temporarily save any updates. In order to permanently save any annotations updates you must do so by generating PAS documentation.


Function/Method-level & Algorithm-level Annotations

In order to view, and/or update a specific function-level annotation you need to first select one of the listed functions in the "List of Functions" listbox as highlighted in red. This will display any saved main annotation information for this function as well as any saved algorithm annotation.



To update or erase the existing annotation content for the "function" domain-level annotation, just enter or delete the annotation text into the Domain Annotation for the Function: ### edit box highlight in green (see above).

To update or erase the existing algorithm annotation for a function you must use the "Algorithm for Function: ###" edit box.

Remember that in order to save all main annotation information permanently you must perform the Generate Documentation step.