next up previous contents index
Next: Annex Up: Documentation Previous: Document a macro   Contents   Index


Print the documentation

Once the document skeleton of a module or macro is generated, and the description file is written, you can compile the document skeleton by calling the macro mwdoclatex (see section 5.1). Of course this needs to have the LATEX environment installed on your system. You get a DVI file which can be printed on various devices using commands of the standard TeXware distribution.

If you want to print the documentation of all modules and user's macros instead of only one, use the macro mwmakedoc. This will actually create an updated sample of the Volume Three of the MegaWave2 guides (``MegaWave2 User's Modules Library'').

In the document skeleton of each module (not available for macros), a field named ``See Also'' lists all the modules calling the module or called by the module: this is a dependencies list. In order to update this list, you need to compile each module which the option -dep and you need to run the macro mwdep before the macros mwdoclatex and mwmakedoc.


next up previous contents index
Next: Annex Up: Documentation Previous: Document a macro   Contents   Index
mw 2004-05-05