From ab7613e8cf8c148e6397be010df7c5cf14d70ca4 Mon Sep 17 00:00:00 2001
From: yang <yang.zhang@arm.com>
Date: Wed, 12 Dec 2012 16:35:53 +0800
Subject: [PATCH] build the frame work of documents with doxygen

---
 inc/NE10.h                                  | 33 ++++++++++++++++++++++++-----
 inc/NE10_math.h                             |  5 -----
 modules/dsp/NE10_fir.c                      |  2 +-
 modules/dsp/NE10_iir.c                      |  4 +---
 tools/doxygen/{doxygen.conf => doxygen.cfg} |  4 ++--
 5 files changed, 32 insertions(+), 16 deletions(-)
 rename tools/doxygen/{doxygen.conf => doxygen.cfg} (99%)

diff --git a/inc/NE10.h b/inc/NE10.h
index 3fb2565..d30092e 100644
--- a/inc/NE10.h
+++ b/inc/NE10.h
@@ -33,7 +33,7 @@
    \mainpage Ne10 Software Library
    *
    *
-   * <b>Introduction</b>
+   *\par Introduction
    *
    * Ne10 is a library of the most commonly used functions that have been heavily
    * optimized for ARM-based CPUs with NEON. These functions provide a consistent
@@ -45,18 +45,41 @@
    *
    * The Ne10 components are:
    *
-   * - math functions
-   * - DSP functions
+   * - @link groupMaths Math Functions@endlink
+   * - @link groupDSPs Signal Processing Functions@endlink
    * - Physics functions
    * - Image Processing functions
    * - Others
+   *\par
+   *\image html ne10_library.png "Ne10 Library Description"
    *
-   *
-   * <b>License</b>
+   *\par License
    *
    * The Ne10 is provided free of charge by ARM Limited and licensed under New BSD license.
    */
 
+
+/**
+ * @defgroup groupMaths Math Functions
+ *
+ *\par Introduction
+ *
+ * This set of functions provide vector/matrix algebra functions that include
+ * add, sub, multiply, div and so on. Currently, only the float (single precision)
+ * data type is supported.
+ */
+
+/**
+ * @defgroup groupDSPs Signal Processing Functions
+ *
+ *\par Introduction
+ *
+ * This set of functions provide some commonly used functions in signal processing,
+ * such as complex/real FFT/IFFT, FIR and IIR. Currently, only the float (single precision)
+ * data type is supported.
+ */
+
+
 #ifndef NE10_H
 #define NE10_H
 
diff --git a/inc/NE10_math.h b/inc/NE10_math.h
index 21a6fd7..720f1ef 100644
--- a/inc/NE10_math.h
+++ b/inc/NE10_math.h
@@ -29,11 +29,6 @@
  * NE10 Library : inc/NE10_math.h
  */
 
-/*! \file NE10_math.h
-    \brief All NE10 math routines declarations.
-
-    The routines that are provided by this library are all declared in this header file.
- */
 
 #include <NE10_types.h>
 
diff --git a/modules/dsp/NE10_fir.c b/modules/dsp/NE10_fir.c
index ed53d67..0c5cd78 100644
--- a/modules/dsp/NE10_fir.c
+++ b/modules/dsp/NE10_fir.c
@@ -32,7 +32,7 @@
 #include "NE10_types.h"
 
 /**
- * @ingroup groupFilters
+ * @ingroup groupDSPs
  */
 
 /**
diff --git a/modules/dsp/NE10_iir.c b/modules/dsp/NE10_iir.c
index 47d3438..b8c08a8 100644
--- a/modules/dsp/NE10_iir.c
+++ b/modules/dsp/NE10_iir.c
@@ -32,7 +32,7 @@
 #include "NE10_types.h"
 
 /**
- * @ingroup groupFilters
+ * @ingroup groupDSPs
  */
 
 /**
@@ -90,8 +90,6 @@
  * Set the values in the state buffer to zeros and then manually initialize the instance structure as follows:
  * <pre>
  *arm_iir_lattice_instance_f32 S = {numStages, pState, pkCoeffs, pvCoeffs};
- *arm_iir_lattice_instance_q31 S = {numStages, pState, pkCoeffs, pvCoeffs};
- *arm_iir_lattice_instance_q15 S = {numStages, pState, pkCoeffs, pvCoeffs};
  * </pre>
  * \par
  * where <code>numStages</code> is the number of stages in the filter; <code>pState</code> points to the state buffer array;
diff --git a/tools/doxygen/doxygen.conf b/tools/doxygen/doxygen.cfg
similarity index 99%
rename from tools/doxygen/doxygen.conf
rename to tools/doxygen/doxygen.cfg
index 3315289..8d886fa 100644
--- a/tools/doxygen/doxygen.conf
+++ b/tools/doxygen/doxygen.cfg
@@ -45,14 +45,14 @@ PROJECT_BRIEF          = "An Open Optimized Software Library Project for the ARM
 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
 # Doxygen will copy the logo to the output directory.
 
-PROJECT_LOGO           = ./image/ne10_logo.png 
+PROJECT_LOGO           = ./image/ne10_logo.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
 # base path where the generated documentation will be put.
 # If a relative path is entered, it will be relative to the location
 # where doxygen was started. If left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = 
+OUTPUT_DIRECTORY       =
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
 # 4096 sub-directories (in 2 levels) under the output directory of each output
-- 
2.7.4