Basic Components--Synchronizer
File List
The File List displays the header and implementation files that are part of the projects checkmarked in the Project Tree. All header and implementation files are displayed--both those for which documentation files exist and those for which no documentation files exist. Note that there is one documentation file (with extension
.d
) for each header file and its corresponding implementation file.
Each entry in the File List contains the name of the source file and two icon boxes. The first icon box indicates the type of the source file--header or implementation. The second icon box tells you what the documentation status of the source file is. A source file can be in one of four possible documentation states--empty, undocumented, partially documented and fully documented. These states are described on Icons used in the Documentation Synchronizer.
When you select a file--let's say
BrowserView.C
or
BrowserView.h
--in the File List, the symbols that have documentation frames in
BrowserView.d
are displayed in the Symbol List.
You can select multiple files in the File List by pressing
<SHIFT>
without letting go and then clicking on each file name. The symbols that are documented in the corresponding documentation files are then displayed in the Symbol List.
You can jump directly to a source file by double-clicking its name in the File List.
Synchronizing documentation and source files with each other
After time, your documentation and source files may no longer be in sync with each other. For example, you might have defined a new symbol in a source file, or renamed an existing one. To update documentation and source files with each other, select one or more source files in the File List and then choose the Synchronize Documentation of Selected Files command in the dialog's Synchronize menu. Note that you can also use this command to generate new documentation files.
Symbol List
The Symbol List displays the documented symbols in the source files that are selected in the File List. Documented symbols are those symbols for which documentation frames exists.
Each entry in the Symbol List contains the name of the symbol, followed by its type in quotes and then file in which it is documented. The icon box that precedes the symbol's name tells you what the documentation status of the source file is. A symbol can be in one of three possible documentation states--undocumented, partially documented and fully documented. See also Status menu.
You can jump directly to the documentation frame of a symbol by double-clicking its name in the Symbol List.