Previous Next
Looking at the status of a symbols documentation

In addition to monitoring the documentation status of individual symbols in your source files, you may also want to look at the documentation status of entire source files and projects. You can do so in the Documentation Synchronization dialog. You can open this dialog by choosing the Documentation Synchronizer... command in the Documentation Editor's Info menu.
Your source files and projects can be in one of four possible documentation states -- empty, undocumented, partially documented and fully documented. The following table summarizes these states:

Source Files Projects
Empty file:
This source file doesn't have a corresponding documentation file.
Empty project:
None of the source files in the project has a corresponding documentation file.
Undocumented file:
All symbols in the corresponding documentation file are undocumented.
Undocumented project:
Project contains at least one source file that contains only empty documentation frames.
Partially documented file:
At least one symbol in the corresponding documentation file is either partially documented or fully documented.
Partially documented project:
Project contains at least one source file that is either partially documented or fully documented.
Fully documented file:
All symbols in the corresponding documentation file are fully documented.
Fully documented project:
All source files in the project are fully documented.

Previous Next