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.

1. Make sure you have doxygen installed on your system.
2. Go to the trunk/DOC/ directory, which contains the file palm2doxygen.config.
3. Execute doxygen as follows:

      doxygen palm2doxygen.config
   

   Doxygen will create a directory called trunk/DOC/doxygen, that contains a HTML and a PDF version (LaTeX sources) of the PALM source code documentation.
4. To explore the generated HTML documentation, please open trunk/DOC/doxygen/html/index.htlm with your favorite browser.
5. To explore the generated PDF documentation, all LaTeX files in trunk/DOC/doxygen/latex/ must be compiled by running the following command in this directory:

      make pdf
   

   The PDF documentation is now available in the file trunk/DOC/doxygen/latex/refman.pdf