Doc-O-Matic
 
Doc-O-Matic 6
PreviousUpNext
Assigning Topic IDs
Related Settings

Topic File Parsing

In this section you will learn how to assign topic IDs to comment blocks stored in DTX files. 

DTX files or documentation files are a special kind of ASCII files, in which Doc-O-Matic stores off-source comments.

  1. Type the Topic Identifier and the name of the symbol in your DTX files.
  2. The default Topic Identifier is @@.
  3. Identifiers have to be the first string of a line. No white spaces are allowed between the identifier and the beginning of the line.
  4. Text between two identifier lines is processed as documentation.
  5. Text in topic files is not enclosed in source code comment characters.
Additional Information
Copyright (c) 2000-2008 toolsfactory software inc. All rights reserved.