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

Timestamp:

Nov 10, 2015 11:38:26 AM (9 years ago)

Author:

knoop

Comment:

--

doc/tec/doxygen

@@ -5 +5 @@
    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:
+   3. To generate the PALM source code documentation just run:
       {{{
-         doxygen palm2doxygen.config
+         generate_documentation
       }}}
-      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, please go to {{{trunk/DOC/doxygen/latex/}}} and build the PDF documentation by executing the following command (LaTex compiler required):
-      {{{
-         make pdf
-      }}}
-      The PDF documentation is now available in the file {{{trunk/DOC/doxygen/latex/refman.pdf}}}
+      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. 
+   4. To explore the generated HTML documentation, please open {{{documentation/PALM_doc.html}}} with your favorite browser.
+   5. To explore the generated PDF documentation, please open {{{documentation/PALM_doc.pdf}}} with your favorite pdf viewer.