CMSIS-DSP: doxygen corrections

Include/arm_math.h

@@ -2846,8 +2846,8 @@ void arm_mat_init_f32(
   {
           q15_t A0;           /**< The derived gain, A0 = Kp + Ki + Kd . */
 #if !defined (ARM_MATH_DSP)
-          q15_t A1;
-          q15_t A2;
+          q15_t A1;           /**< The derived gain A1 = -Kp - 2Kd */
+          q15_t A2;           /**< The derived gain A1 = Kd. */
 #else
           q31_t A1;           /**< The derived gain A1 = -Kp - 2Kd | Kd.*/
 #endif

Source/DistanceFunctions/arm_boolean_distance_template.h

@@ -44,6 +44,12 @@
  */
 
 
+
+
+#define _FUNC(A,B) A##B 
+
+#define FUNC(EXT) _FUNC(arm_boolean_distance, EXT)
+
 /**
  * @brief        Elements of boolean distances
  *
@@ -52,17 +58,10 @@
  * @param[in]    pA              First vector of packed booleans
  * @param[in]    pB              Second vector of packed booleans
  * @param[in]    numberOfBools   Number of booleans
- * @param[out]   cTT             cTT value
- * @param[out]   cTF             cTF value
- * @param[out]   cFT             cFT value
  * @return None
  *
  */
 
-#define _FUNC(A,B) A##B 
-
-#define FUNC(EXT) _FUNC(arm_boolean_distance, EXT)
-
 #if defined(ARM_MATH_MVEI)
 
 #include "arm_common_tables.h"

Source/MatrixFunctions/arm_mat_mult_q7.c

@@ -41,7 +41,7 @@
  * @param[in]       *pSrcA points to the first input matrix structure
  * @param[in]       *pSrcB points to the second input matrix structure
  * @param[out]      *pDst points to output matrix structure
- * @param[in]       *pState points to the array for storing intermediate results (Unused)
+ * @param[in]       *pState points to the array for storing intermediate results (Unused in some versions)
  * @return          The function returns either
  * <code>ARM_MATH_SIZE_MISMATCH</code> or <code>ARM_MATH_SUCCESS</code> based on the outcome of size checking.
  *

Source/MatrixFunctions/arm_mat_vec_mult_f32.c

@@ -40,9 +40,9 @@
 
 /**
  * @brief Floating-point matrix and vector multiplication.
- * @param[in]       *pSrcMat points to the first input matrix structure
- * @param[in]       *pVec points to the second input matrix structure
- * @param[out]      *pDst points to output matrix structure
+ * @param[in]       *pSrcMat points to the input matrix structure
+ * @param[in]       *pVec points to input vector
+ * @param[out]      *pDst points to output vector
  */
 #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE)
 

Source/MatrixFunctions/arm_mat_vec_mult_q15.c

@@ -40,9 +40,9 @@
 
 /**
  * @brief Q15 matrix and vector multiplication.
- * @param[in]       *pSrcA points to the first input matrix structure
- * @param[in]       *pSrcB points to the second input matrix structure
- * @param[out]      *pDst points to output matrix structure
+ * @param[in]       *pSrcMat points to the input matrix structure
+ * @param[in]       *pVec points to input vector
+ * @param[out]      *pDst points to output vector
  */
 #if defined(ARM_MATH_MVEI)
 

Source/MatrixFunctions/arm_mat_vec_mult_q31.c

@@ -40,9 +40,9 @@
 
 /**
  * @brief Q31 matrix and vector multiplication.
- * @param[in]       *pSrcA points to the first input matrix structure
- * @param[in]       *pSrcB points to the second input matrix structure
- * @param[out]      *pDst points to output matrix structure
+ * @param[in]       *pSrcMat points to the input matrix structure
+ * @param[in]       *pVec points to the input vector
+ * @param[out]      *pDst points to the output vector
  */
 #if defined(ARM_MATH_MVEI)
 void arm_mat_vec_mult_q31(

Source/MatrixFunctions/arm_mat_vec_mult_q7.c

@@ -40,9 +40,9 @@
 
 /**
  * @brief Q7 matrix and vector multiplication.
- * @param[in]       *pSrcA points to the first input matrix structure
- * @param[in]       *pSrcB points to the second input matrix structure
- * @param[out]      *pDst points to output matrix structure
+ * @param[in]       *pSrcMat points to the input matrix structure
+ * @param[in]       *pVec points to the input vector
+ * @param[out]      *pDst points to the output vector
  */
 #if defined(ARM_MATH_MVEI)
 

Testing/CMakeLists.txt

@@ -455,6 +455,37 @@ endif()
 writeConfig(${CMAKE_CURRENT_BINARY_DIR}/currentConfig.csv)
 
 
+find_package(Doxygen)
 
+if(DOXYGEN_FOUND)
+
+  # exclude sqlite code
+  set(DOXYGEN_EXCLUDE_PATTERNS
+        */sqlite3/*
+  )
+  # doxygen settings can be set here, prefixed with "DOXYGEN_"
+  set(DOXYGEN_SOURCE_BROWSER NO)
+  set(DOXYGEN_EXTRACT_ALL YES)
+  set(DOXYGEN_EXTRACT_PRIVATE YES)
+  set(DOXYGEN_GENERATE_XML NO)
+  set(DOXYGEN_OPTIMIZE_OUTPUT_FOR_C YES)
+  set(DOXYGEN_EXTRACT_LOCAL_CLASSES NO)
+  set(DOXYGEN_TYPEDEF_HIDES_STRUCT YES)
+  set(DOXYGEN_PREDEFINED "__ALIGNED(x)=")
+  set(DOXYGEN_EXAMPLE_PATH "${ROOT}/CMSIS/DSP/Examples/ARM")
+  set(DOXYGEN_IMAGE_PATH "${ROOT}/CMSIS/DoxyGen/DSP/src/images")
+  set(DOXYGEN_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/docs")
+  # this target will only be built if specifically asked to.
+  # run "make api-docs" to create the doxygen documentation
+  doxygen_add_docs(
+    docs
+    ${ROOT}/CMSIS/DSP/Source
+    ${ROOT}/CMSIS/DSP/Examples/ARM
+    ${ROOT}/CMSIS/DSP/Include
+    ${ROOT}/CMSIS/DoxyGen/DSP/src/history.txt
+    COMMENT "Generate API-documents"
+  )
+
+endif(DOXYGEN_FOUND)