Previous Next
Documentation Editor view

Click for full size, then use Back button

Alignment

Editor Width[chars] Defines the maximum number of characters allowed on a line in the Documentation view. Lines that are longer than the Editor Width are wrapped.

Text Highlighting

Text Properties for HTML Tags Specifies the font and color properties of a number of the HTML tags that are supported by the Documentation Editor. Press Choose... to open the HTML Tags Text Properties dialog.

Click for full size, then use Back button

Documentation Creation

Documentation Template Directory Specifies the directory in which your documentation template files are stored. These template files are then used for creating documentation frames for symbols.
You can specify multiple directories in the Template Directory field. A colon (:) separates multiple directories from each other. When searching for a template file, SNiFF+ searches the directories in the order they are given and terminates the search as soon as the template file is found.
To learn how to customize template files, please refer to Creating documentation templates files.
Default:
$SNIFF_DIR/config/docu (SNiFF+ default documentation template files are stored in this directory)
    Caution
    If you want to use the default documentation template files for documenting any or all of your symbols, make sure to include $SNIFF_DIR/config/docu in the Documentation Template Directory field!

Sort Symbols Alphabetically Sorts the symbols in the documentation files alphabetically.
Use Read-Only Mode Documentation can only be browsed -- it can neither be generated nor edited. Obsolete documentation is hidden completely.

Documentable Symbol
Specifies which kinds of symbols are documentable. You can restrict documentable symbols according to access specifiers (Private, Protected, Public).

Previous Next