diff options
Diffstat (limited to 'NxWidgets/Doxygen/README.txt')
-rw-r--r-- | NxWidgets/Doxygen/README.txt | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/NxWidgets/Doxygen/README.txt b/NxWidgets/Doxygen/README.txt new file mode 100644 index 000000000..4546d4903 --- /dev/null +++ b/NxWidgets/Doxygen/README.txt @@ -0,0 +1,45 @@ +README +====== + +This directory contains the documentation automatically generated by Doxygen. + +Contents +======== + + o Installing the necessary packages in Ubuntu + o Generating documentation + +Installing the necessary packages in Ubuntu +=========================================== + +1. Install the following packages. + + $ sudo aptitude install doxygen doxygen-doc doxygen-gui dot2tex graphviz + +2. (Optional) Install from the latest sourcode. + + The Ubuntu package is outdated. The newer the version of Doxygen, the cooler + the documentation looks. + + Place yourself in some temporary folder where you can download the source, + and run (http://www.stack.nl/~dimitri/doxygen/download.html): + + $ svn co https://doxygen.svn.sourceforge.net/svnroot/doxygen/trunk doxygen-svn + $ cd doxygen-svn + $ ./configure + $ make + $ make install + +Generating documentation +======================== + +1. Position the shell into this folder: + + misc/NXWidgets/Doxygen + + The file "Doxyfile" contains the configuration of the Doxygen settings + for the run, edit only if necessary. + + To generate the documentation type: + + $ doxygen Doxyfile |