Changes between Version 6 and Version 7 of doc/tec/doxygen


Ignore:
Timestamp:
Nov 19, 2018 5:19:56 PM (5 years ago)
Author:
kanani
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • doc/tec/doxygen

    v6 v7  
    33[[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.
    44
    5    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.
     5   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.\\\\
    66   2. To generate the PALM source code documentation just run:
    77      {{{
    88         generate_documentation
    99      }}}
    10       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.
    11    3. To explore the generated HTML documentation, please open {{{documentation/PALM_doc.html}}} with your favorite browser.
     10      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.\\\\
     11   3. To explore the generated HTML documentation, please open {{{documentation/PALM_doc.html}}} with your favorite browser.\\\\
    1212   4. To explore the generated PDF documentation, please open {{{documentation/PALM_doc.pdf}}} with your favorite pdf viewer.