Introduction
When you document symbols in your source code, SNiFF+ uses documentation template files to generate documentation frames for each symbol. There is one documentation template file for each type of symbol.
To create documentation template files, complete these steps:
Customize an existing template file or create a new one.
Step 1: Customize documentation template files
Name it.
Determine where to store it in your file system.
Specify its location in SNiFF+.
There are two ways in which you can customize documentation template files:
In this section, you will find out which HTML tags are recognized by SNiFF+ and which macros you can use for extracting symbolic information and comments.
Using HTML tags in documentation template files
SNiFF+'s Documentation Editor recognizes the following HTML tags:
(In the following list, only the starting tags are shown.)
.
Step 2: Name your documentation template file
There are two points to keep in mind when naming documentation template files:
For example, suppose you have created and want to name a template file for subroutines in FORTRAN. In SNiFF+, the symbol type for subroutines is
The last column in the table lists the names of the default template files used for the listed symbol types. SNiFF+ uses the default template files if it can't find your template files. See also How SNiFF+ searches for documentation template files.
Step 3: Determine where to store template files
You have two options for storing your documentation template files:
For details about storing and specifying the location of template files, please refer to Step 4: Specify the location of template files.
Step 4: Specify the location of template files
For template files stored in a template directory
C/C+
| FORTRAN
| IDL
| Java
| Ada
Ansi_C/C++
| Ansi_C and, in it, a subdirectory called C++ ). FORTRAN_77
| IDL
| Java
| Ada9X
| |
If your language is not listed in the above table, launch SNiFF+. Then,
Load a project that contains source files in the language you want to document.
Create a language-specific subdirectory and name it according to the name used in the
Language drop down in the Symbol Browser, Hierarchy Browser and in the Cross Referencer.
Store your template file in the appropriate language-specific subdirectory.
Enter the template directory's path in the Template Directory field in the Documentation
Editor view of the Preferences dialog.
Scenario 1
You want to document a C++ source file that contains classes, enums and methods. SNiFF+ will use the following template files to create documentation frames: