Changes between Version 2 and Version 3 of doc/tec/doxygen

Timestamp:

Oct 13, 2015 8:59:43 AM (9 years ago)

Author:

knoop

Comment:

--

doc/tec/doxygen

@@ -3 +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.
 
-   1. Make sure you have doxygen installed on your system.
+   1. Make sure you have [[http://www.stack.nl/~dimitri/doxygen/download.html|doxygen]] and [[http://www.graphviz.org/|dot]] installed on your system.
    2. Go to the {{{trunk/DOC/}}} directory, which contains the file {{{palm2doxygen.config}}}.
    3. Execute doxygen as follows:
@@ -11 +11 @@
       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. 
    4. To explore the generated HTML documentation, please open {{{trunk/DOC/doxygen/html/index.html}}} 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:
+   5. 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