= How to create source code documentation using doxygen =

[[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.

   1. Make sure you have [[http://www.stack.nl/~dimitri/doxygen/download.html|doxygen]], [[http://www.graphviz.org/|dot]] and LaTeX installed on your system.\\\\
   2. To generate the PALM source code documentation just run:
      {{{
         generate_documentation
      }}}
      Doxygen will create a directory called {{{documentation}}} in your base_directory, which contains a HTML and a PDF version of the PALM source code documentation.\\\\ 
   3. To explore the generated HTML documentation, please open {{{documentation/PALM_doc.html}}} with your favorite browser.\\\\
   4. To explore the generated PDF documentation, please open {{{documentation/PALM_doc.pdf}}} with your favorite pdf viewer.