next up previous contents index
Next: Brief Description of the Up: The automatic documentation system Previous: The automatic documentation system   Contents   Index

A four step introduction to the code parser laldoc

These four-step instructions are also outlined in the file /lal/doc/laldoc/README.

(1)
Copy the executable (/lal/doc/laldoc/laldoc) and the sample input file (/lal/doc/laldoc/LalDocDemo.h) to an empty /home/alice/junk directory.
(2)
In /home/alice/junk run the command ``./laldoc LalDocDemo.h Errors.out''
(3)
LATEX the file LalDocDemo_LaTeX_This_File.tex.
(4)
Read the document created in step 3 (LalDocDemo_LaTeX_This_File.dvi) . It will explain how the various debris files were created from the original source file and how they were input to make the document. If you follow your nose, you will see exactly what laldoc does and how it works. Also, make sure you look at the file Errors.out.



LAL test account 2003-10-23