Next: Indexing requirements
Up: Autodocumentation and Indexing
Previous: Autodocumentation and Indexing
  Contents
  Index
There is an automatic documentation tool supplied with the LAL. To
what extent the coders wish to use the autodocmentation system, is
largely left up to their judgment and patience. However, the
LAL-Spec require several items to be auto-extracted from the code
to include the documentation. See the LAL-Spec for the official
list, but here are some examples

- Function Prototypes

- Error code tables

- The author and version-control information. This
should appear as footnote at the bottom of all
header sections, and module and test subsections.
This can be done with the LATEX command
\vfill{\footnotesize\input{MyFileHAuthVer}},
where MYFILEHAuthVer.tex is the file where
the Author-Version information from MyFile.H
was extracted to. You can find examples of
this to mimic.
LAL test account
2003-10-23