next up previous contents index
Next: Examples of how to Up: Brief Description of the Previous: The three laldoc environments   Contents   Index

How laldoc handles the output files

Default file names: In any of the laldoc environments, if you do not specify an output file in the opening key-word line, laldoc will assign one automatically. The file name will be constructed from the input file name, e.g. if the input is MyHeader.h, the default output will be MyHeaderH.tex.

Appending to files: If the output file doesn't already exist, laldoc will create it. If the output file already exists, laldoc will append to it. When the environment-closing key-word is encountered, the output file is closed.

Although this is a fairly obvious feature, it is quite useful. For example, the function prototypes in a module don't appear together in the source, but they should appear together in the documentation. With laldoc this is easy to accomplish. In your source code when you encounter each prototype that must be captured for inclusion, use the same file name for the extraction, i.e surround each prototype with the pair <lalVerbatim file="MyModuleCPrototypes"> and </lalVerbatim>. Each prototype will be appended to the file MyModuleCPrototypes.tex, and separate margin pars will tell exactly where each came from.


next up previous contents index
Next: Examples of how to Up: Brief Description of the Previous: The three laldoc environments   Contents   Index
LAL test account 2003-10-23