nuttx-apps

History

Gregory Nutt dee7f14b49 Squashed commit of the following: apps/system/nxplayer: Fix some logical errors from recent comments. They broke the build of the nxplayer as a library vs. a task. apps/graphics/nxglyphs: Fix yet more namespace problems. graphics/nxwm/src/nxwm_main.cxx: Move from graphics/nxwidgets/UnitTests/nxwm/nxwm_main.cxx. apps/graphicx/nx*: Fixes numerous build issues mostly associated with include paths and namespaces. apps/nxglyphs: Decouple (mostly) from nxwidgets and nxwm so that they can be used elsewhere. Creates include/graphics/nxglyphs.h apps/graphics/nxglyphs: Put all NxWidgets and NxWM glyphs into a common directory where they can eventually be shared. Not very sharable at the moment due to header file entanglements. Need a separate nxglyps.hxx header file. Separate nxwidets and nxwm into separate directories. Remove old, common NxWidgets directory.		2019-04-04 18:53:29 -06:00
..
Doxyfile	Squashed commit of the following:	2019-04-04 18:53:29 -06:00
gendoc.sh	Squashed commit of the following:	2019-04-04 18:53:29 -06:00
README.txt	Squashed commit of the following:	2019-04-04 18:53:29 -06:00

README.txt

README
======

This directory contains the documentation automatically generated by Doxygen.

Contents
========

  o Installing the necessary packages in Ubuntu
  o Generating documentation
  o References

Installing the necessary packages in Ubuntu
===========================================

1. Install the following packages.

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

2. (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:

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:

   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