`%'
) 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:
@@, @{, @}
The only special characters are `@'
(at sign), `{'
and `}'
(curly braces) which must be
preceded by @
(at sign). All other characters are included
literally.
@code{
text}
is used for references to
identifiers from the source code.
@emph{
text}
is used to emphasize text.
@ref{@Overview{
structure name}}
inserts
a (hyper-)link to the documentation of structure name.
ocs
command knows several targets for generating
documentation. Some preparation is necessary, though:
ocs -top
or ocs -sub
command, create a link from the generated SysDefs file to a file just named
`SysDefs'
PROJECTROOT
which contains
the absolute path to the directory where the Opal sources are located.
ocs doc
to generate HTML documentation
ocs dvi
to generate DVI documentation
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 |