| Version 3 (modified by knoop, 9 years ago) (diff) |
|---|
How to create source code documentation using doxygen
Doxygen is a tool for generating documentation from annotated source code. Please follow the instructions below to generate a PALM source code documentation using doxygen.
- Make sure you have doxygen and dot installed on your system.
- Go to the trunk/DOC/ directory, which contains the file palm2doxygen.config.
- Execute doxygen as follows:
doxygen palm2doxygen.config
Doxygen will create a directory called trunk/DOC/doxygen, which contains a HTML and a PDF version (LaTeX sources) of the PALM source code documentation. - To explore the generated HTML documentation, please open trunk/DOC/doxygen/html/index.html with your favorite browser.
- To explore the generated PDF documentation, please go to trunk/DOC/doxygen/latex/ and build the PDF documentation by executing the following command (LaTex? compiler required):
make pdf
The PDF documentation is now available in the file trunk/DOC/doxygen/latex/refman.pdf
