Generating Documentation

The Opal Compilation System contains support for generating documentation in either HTML or DVI format from the source code. The full documentation gives details for the operation of the documentation system DOSFOP. This document gives a short introduction into the usage of the documentation system.

Adding Documentation to the Source Code

Documentation is included in the form of special comments. Every comment which starts with a percent (`%') sign is treated as a comment. Source code is written in Texinfo (the same language which is used for the documentation of many GNU tools, e.g. emacs, gcc, ...). The most important Texinfo commands are:

Generating Documentation with ocs

The ocs command knows several targets for generating documentation. Some preparation is necessary, though: Then use one of The result is placed in doc/out.html or doc/out.dvi.
If you use bash, type
-> export PROJECTROOT=$PWD
-> ocs doc
If you use csh or tcsh, type
-> setenv PROJECTROOT $PWD
-> ocs doc

The Opal Group
Last modified: Thu Sep 16 21:37:15 MEST 1999