sergiotarxz/nuttx-apps

History

Xiang Xiao 0acd68b391 Indent the include statement by two spaces follow the coding style Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>		2023-05-13 10:16:26 -03:00
..
Doxyfile	Indent the include statement by two spaces	2023-05-13 10:16:26 -03:00
gendoc.sh	apps: graphics: Jose Pablo Carballo: update licenses to Apache	2022-03-08 01:44:49 +08:00
README.md	Rewritten READMEs to Markdown	2020-07-25 01:01:51 -07:00

README.md

Graphics / `nxwm` NxWM / Doxygen

This directory contains the documentation automatically generated by Doxygen.

Contents

Installing the necessary packages in Ubuntu
Generating documentation
References

Installing the necessary packages in Ubuntu

Install the following packages.

$ sudo aptitude install doxygen doxygen-doc doxygen-gui dot2tex graphviz

(Optional) Install Doxygen from the latest sourcode.

The Ubuntu package is outdated. The newer the version of Doxygen, the better the documentation looks.

Place yourself in some temporary folder where you can download the source, and run [1]:
```
$ svn co https://doxygen.svn.sourceforge.net/svnroot/doxygen/trunk doxygen-svn
$ cd doxygen-svn
$ ./configure
$ make
$ make install
```

Generating documentation

Two ways described here:

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
```
Using the Doxyfile directly:

The file Doxyfile contains the configuration of the Doxygen settings for the run, edit only if necessary.

To generate the documentation type:
```
$ cd /path/to/nuttx/trunk/NXWidgets/Doxygen/
$ doxygen Doxyfile
```

References

[1] http://www.stack.nl/~dimitri/doxygen/download.html