Update NxWidgets Doxygen support

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4527 42af7a65-404d-4744-a932-0658087f49c3

3 files changed, 79 insertions, 6 deletions

diff --git a/NxWidgets/ChangeLog.txt b/NxWidgets/ChangeLog.txt
index 5a2806fcd..c9c1bc8a5 100755
--- a/NxWidgets/ChangeLog.txt
+++ b/NxWidgets/ChangeLog.txt
@@ -3,3 +3,7 @@
 * The initial release of the NxWidgets package

 

 1.1 2012-xx-xx Gregory Nutt <gnutt@nuttx.org>

+

+* Updated and verified the NxWidgets DOxygen documentation.  Contributed

+  by Jose Pablo Carballo.

+

diff --git a/NxWidgets/Doxygen/README.txt b/NxWidgets/Doxygen/README.txt
index 4546d4903..26d76ce4b 100644
--- a/NxWidgets/Doxygen/README.txt
+++ b/NxWidgets/Doxygen/README.txt
@@ -8,6 +8,7 @@ Contents
 
   o Installing the necessary packages in Ubuntu
   o Generating documentation
+  o References
 
 Installing the necessary packages in Ubuntu
 ===========================================
@@ -16,13 +17,13 @@ Installing the necessary packages in Ubuntu
 
   $ sudo aptitude install doxygen doxygen-doc doxygen-gui dot2tex graphviz
 
-2. (Optional) Install from the latest sourcode.
+2. (Optional) Install Doxygen from the latest sourcode.
 
-  The Ubuntu package is outdated. The newer the version of Doxygen, the cooler
+  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 (http://www.stack.nl/~dimitri/doxygen/download.html):
+  and run [1]:
 
   $ svn co https://doxygen.svn.sourceforge.net/svnroot/doxygen/trunk doxygen-svn
   $ cd doxygen-svn
@@ -33,13 +34,31 @@ Installing the necessary packages in Ubuntu
 Generating documentation
 ========================
 
-1. Position the shell into this folder:
+Two ways described here:
 
-   misc/NXWidgets/Doxygen
+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:
 
-   $ doxygen Doxyfile
+    $ cd /path/to/nuttx/trunk/NXWidgets/Doxygen/
+    $ doxygen Doxyfile
+
+References
+==========
+
+[1] http://www.stack.nl/~dimitri/doxygen/download.html
diff --git a/NxWidgets/libnxwidgets/doc/mainpage.h b/NxWidgets/libnxwidgets/doc/mainpage.h
new file mode 100644
index 000000000..9eb5ded83
--- /dev/null
+++ b/NxWidgets/libnxwidgets/doc/mainpage.h
@@ -0,0 +1,50 @@
+/*! \mainpage NXWidgets Documentation
+ *
+ * In order to better support NuttX based platforms, a special graphical user
+ * interface has been created called NXWidgets. NXWidgets is written in C++
+ * and integrates seamlessly with the NuttX NX graphics subystem in order to
+ * provide graphic objects, or "widgets", in the <a title="NX Graphics
+ * Subsystem" href="http://nuttx.sourceforge.net/NXGraphicsSubsystem.html">
+ * NX Graphics Subsystem</a>.
+ *
+ * \section feature Features
+ *
+ * \subsection conservative_cxx Conservative C++
+ *
+ * Written entirely in C++ but using only selected "embedded
+ * friendly" C++ constructs that are fully supported under NuttX. No
+ * additional C++ support libraries are required.
+ *
+ * \subsection nx_integration NX Integration
+ *
+ * Integrates seamlessly with the NX graphics subsytem. Think of the X
+ * server under Linux... the NX graphics subsystem is like a tiny X server
+ * that provides windowing under NuttX. By adding NXWidgets, you can
+ * support graphic objects like buttons and text boxes in the NX windows
+ * and toolbars.
+ *
+ * \subsection small_footprint Small Footprint
+ *
+ * Tailored for use MCUs in embedded applications. It is ideally suited for
+ * mid- and upper-range of most MCU families. A complete NXWidgets is
+ * possible in as little as 40Kb of FLASH and maybe 4Kb of SRAM.
+ *
+ * \subsection output_devices Output Devices
+ *
+ * NXWidgets will work on the high-end fram buffer devices as well as on
+ * LCDs connected via serial or parallel port to a small MCU.
+ *
+ * \subsection input_devices Input Devices
+ *
+ * NXWidgets will accept position and selection inputs from a mouse or a
+ * touchscreen. It will also support character input from a keyboard such
+ * as a USB keyboard. NXWidgets supports a very special widget called
+ * CKeypad that will provide keyboard input via on-screen keypad that can
+ * be operated via mouse or touchscreen inputs.
+ *
+ * \subsection many_graphic_objects Many Graphic Objects\
+ *
+ * Some of the graphic objects supported by NXWidgets include labels,
+ * buttons, text boxes, button arrays, check boxes, cycle buttons, images,
+ * sliders, scrollable list boxes, progress bars, and more.
+ */