| | 1 | = How to create source code documentation using doxygen = |
| | 2 | |
| | 3 | [[http://www.stack.nl/~dimitri/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. |
| | 4 | |
| | 5 | 1. Make sure you have doxygen installed on your system. |
| | 6 | 2. Go to the {{{trunk/DOC/}}} directory, which contains the file {{{palm2doxygen.config}}}. |
| | 7 | 3. Execute doxygen as follows: |
| | 8 | {{{ |
| | 9 | doxygen palm2doxygen.config |
| | 10 | }}} |
| | 11 | 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. |
| | 12 | 4. To explore the generated HTML documentation, please open {{{trunk/DOC/doxygen/html/index.htlm}}} with your favorite browser. |
| | 13 | 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: |
| | 14 | {{{ |
| | 15 | make pdf |
| | 16 | }}} |
| | 17 | The PDF documentation is now available in the file {{{trunk/DOC/doxygen/latex/refman.pdf}}} |
