The three laldoc environments

One general comment about the laldoc environments: None of the text on the line with the opening key-word or on the line with the closing key-word will be extracted.

$\bullet$

The verbatim environment is opened key-word <lalVerbatim file="myVerbatimJunk"> and closed with the key-word </lalVerbatim>. The material between the two key-words will be wrapped in a L^ATEX verbatim environment for later inclusion. This is useful for including such things as a function prototypes or data structures: they will appear ``verbatim'' in the documentation. When the information is included with <lalVerbatim> laldoc supplies a small marginpar gives the source-file name and line number where the snippet came from.

$\bullet$

The L^ATEX environment is opened and closed with the key-words <lalLaTeX file="myLatexJunk"> and </lalLaTeX>. This is used to write L^ATEX in the source-code. The material between the two key-words is stored in a file myLatexJunk.tex. This allows (not recommended) a programmer to put large sections of L^ATEX prose in the source code.

$\bullet$

The error-table environment. There is a special environment for translating the source code that assign the error codes and messages directly into a L^ATEX table. All you need to do is wrap the code between the key-words <lalErrTable file="myErrTabJunk"> and </lalErrTable>. This insures that if an error code is added in the source, it will automatically be added to the documentation.