Name: | DocCompiler |
Version: | 1.0 |
ID: | ID_DOCCOMPILER |
Status: | Unspecified |
Category: | Tool |
Date: | May 2001 |
Author: | Rocklyte Systems |
Copyright: | Rocklyte Systems (c) 2001. All rights reserved. |
Short: | Processes self-documenting source files from Rocklyte Systems. |
The DocCompiler class is designed to process source files that are self-documented using the Section Based Formatting standard from Rocklyte Systems. If you have seen source files from Rocklyte Systems before, then you may have noticed that all code is self documented within hash-marked areas. Take this example which documents a field named 'Apple':
##FIELD## Name: Apple Short: An apple a day keeps the doctor away. Type: LONG Status: Read/Write ##DESCRIPTION## <p>This field tells you the total amount of apples that have been eaten by the object.</p> ##SEE ALSO## Field: Banana ##END##
If you look through some existing source files you will quickly gather an idea of how self-documented code works. The main advantages of writing documents in this way are: 1. Updating the documentation is easier because it is much 'closer' to the code. 2. The formatting can theoretically be processed into any other document type (currently HTML is supported, others may follow).
The purpose of this document is to describe how the DocCompiler class works, not to provide detail on the documentation standards used by Rocklyte Systems. Because a freely available application that uses the class already exists, there may be little point in creating a new application based on the class. However, you may find this document helpful for making modifications to that application (which is located in scripts:development/compilers/)
The DocCompiler class supports the following actions:
Activate Processes source data into an output file.
The DocCompiler object consists of the following public fields:
Location Set this field to the source directory or file location. Output Defines the object that will receive the text data. Static Set to TRUE to make the object static.
Action: | Activate | |
Short: | Processes source data into an output file. | |
|
Field: | Output | |
Short: | Defines the object that will receive the text data. | |
Type: | OBJECTID | |
Status: | Read/Write | |
|
Field: | Static | |
Short: | Set to TRUE to make the object static. | |
Type: | BOOLEAN | |
Status: | Read/Init | |
|