2012-03-22 22:22:59 +01:00
|
|
|
README
|
|
|
|
|
======
|
|
|
|
|
|
|
|
|
|
This directory contains the documentation automatically generated by Doxygen.
|
|
|
|
|
|
|
|
|
|
Contents
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
o Installing the necessary packages in Ubuntu
|
|
|
|
|
o Generating documentation
|
2012-03-27 17:01:22 +02:00
|
|
|
o References
|
2012-03-22 22:22:59 +01:00
|
|
|
|
|
|
|
|
Installing the necessary packages in Ubuntu
|
|
|
|
|
===========================================
|
|
|
|
|
|
|
|
|
|
1. Install the following packages.
|
|
|
|
|
|
|
|
|
|
$ sudo aptitude install doxygen doxygen-doc doxygen-gui dot2tex graphviz
|
|
|
|
|
|
2012-03-27 17:01:22 +02:00
|
|
|
2. (Optional) Install Doxygen from the latest sourcode.
|
2012-03-22 22:22:59 +01:00
|
|
|
|
2012-03-27 17:01:22 +02:00
|
|
|
The Ubuntu package is outdated. The newer the version of Doxygen, the better
|
2012-03-22 22:22:59 +01:00
|
|
|
the documentation looks.
|
|
|
|
|
|
|
|
|
|
Place yourself in some temporary folder where you can download the source,
|
2012-03-27 17:01:22 +02:00
|
|
|
and run [1]:
|
2012-03-22 22:22:59 +01:00
|
|
|
|
|
|
|
|
$ svn co https://doxygen.svn.sourceforge.net/svnroot/doxygen/trunk doxygen-svn
|
|
|
|
|
$ cd doxygen-svn
|
|
|
|
|
$ ./configure
|
|
|
|
|
$ make
|
|
|
|
|
$ make install
|
|
|
|
|
|
|
|
|
|
Generating documentation
|
|
|
|
|
========================
|
|
|
|
|
|
2012-03-27 17:01:22 +02:00
|
|
|
Two ways described here:
|
2012-03-22 22:22:59 +01:00
|
|
|
|
2012-03-27 17:01:22 +02:00
|
|
|
1. Use the provided gendoc.sh script.
|
|
|
|
|
|
|
|
|
|
trunk/NXWidgets/Doxygen/gendoc.sh
|
|
|
|
|
|
|
|
|
|
The script only needs the argument to the absolute path where to place the
|
|
|
|
|
generated documentation. I.e.:
|
|
|
|
|
|
|
|
|
|
$ cd /path/to/nuttx/trunk/NXWidgets/Doxygen/
|
|
|
|
|
$ mkdir doc
|
|
|
|
|
$ ./gendoc.sh $PWD/doc
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2. Using the Doxyfile directly:
|
2012-03-22 22:22:59 +01:00
|
|
|
|
|
|
|
|
The file "Doxyfile" contains the configuration of the Doxygen settings
|
|
|
|
|
for the run, edit only if necessary.
|
|
|
|
|
|
|
|
|
|
To generate the documentation type:
|
|
|
|
|
|
2012-03-27 17:01:22 +02:00
|
|
|
$ cd /path/to/nuttx/trunk/NXWidgets/Doxygen/
|
|
|
|
|
$ doxygen Doxyfile
|
|
|
|
|
|
|
|
|
|
References
|
|
|
|
|
==========
|
|
|
|
|
|
|
|
|
|
[1] http://www.stack.nl/~dimitri/doxygen/download.html
|
