瀏覽代碼

CMSIS-NN Doxygen formatting fixes

Fix doxygen warnings.

Change-Id: I3d2b985b3588c2323229d62951a81c3b774cf53d
Felix Johnny 5 年之前
父節點
當前提交
e94ddd691d

+ 11 - 6
CMSIS/NN/Include/arm_nnsupportfunctions.h

@@ -21,8 +21,8 @@
  * Title:        arm_nnsupportfunctions.h
  * Description:  Public header file of support functions for CMSIS NN Library
  *
- * $Date:        March 6, 2020
- * $Revision:    V.4.0.2
+ * $Date:        March 17, 2020
+ * $Revision:    V.4.0.3
  *
  * Target Processor:  Cortex-M cores
  * -------------------------------------------------------------------- */
@@ -375,7 +375,7 @@ arm_status arm_nn_vec_mat_mult_t_s8(const q7_t *lhs,
  * @param[in]      out_offset      Offset to be added to the output values. Range: -127 to 128
  * @param[in]      activation_min  Minimum value to clamp the output to. Range: int8
  * @param[in]      activation_max  Maximum value to clamp the output to. Range: int8
- * param[in]       row_x_col       (row_dimension * col_dimension) of LHS/RHS matrix
+ * @param[in]       row_x_col       (row_dimension * col_dimension) of LHS/RHS matrix
  * @param[in]      output_bias     Per channel output bias. Length of vector is equal to number of channels
  * @param[in]      out             Output pointer
  *
@@ -416,7 +416,7 @@ q7_t *arm_nn_depthwise_conv_nt_t_padded_s8(const q7_t *lhs,
  * @param[in]      out_offset      Offset to be added to the output values. Range: -127 to 128
  * @param[in]      activation_min  Minimum value to clamp the output to. Range: int8
  * @param[in]      activation_max  Maximum value to clamp the output to. Range: int8
- * param[in]       row_x_col       (row_dimension * col_dimension) of LHS/RHS matrix
+ * @param[in]       row_x_col       (row_dimension * col_dimension) of LHS/RHS matrix
  * @param[in]      output_bias     Per channel output bias. Length of vector is equal to number of channels.
  * @param[in]      out             Output pointer
  *
@@ -499,6 +499,13 @@ __STATIC_FORCEINLINE q31_t arm_nn_read_q7x4(const q7_t *in_q7)
   return (val);
 }
 
+/**
+ * @brief           memset optimized for MVE
+ * @param[in, out]  dst         Destination pointer
+ * @param[in]       val         Value to set
+ * @param[in]       block_size  Number of bytes to copy.
+ *
+ */
 __STATIC_FORCEINLINE void arm_memset_q7(q7_t *dst,
                                         const q7_t val,
                                         uint32_t block_size)
@@ -741,8 +748,6 @@ __STATIC_FORCEINLINE q31_t arm_nn_requantize(const q31_t val, const q31_t multip
  * @param[in]       src         Source pointer.
  * @param[in]       block_size  Number of bytes to copy.
  *
- * @return          None
- *
  */
 __STATIC_FORCEINLINE void arm_memcpy_q7(q7_t *__RESTRICT dst,
                                         const q7_t *__RESTRICT src,

+ 15 - 2
CMSIS/NN/Source/NNSupportFunctions/arm_nn_depthwise_conv_nt_t_padded_s8.c

@@ -21,8 +21,8 @@
  * Title:        arm_nn_depthwise_conv_nt_t_padded_s8.c
  * Description:  Depthwise convolution with padded matrices.
  *
- * $Date:        March 12, 2020
- * $Revision:    V.1.0.0
+ * $Date:        March 17, 2020
+ * $Revision:    V.1.0.1
  *
  * Target Processor:  Cortex-M processors with MVE extension
  * -------------------------------------------------------------------- */
@@ -30,6 +30,15 @@
 #include "arm_math.h"
 #include "arm_nnfunctions.h"
 
+/**
+ * @ingroup groupSupport
+ */
+
+/**
+ * @addtogroup NNBasicMath
+ * @{
+ */
+
 /*
    * Depthwise convolution of transposed rhs matrix with 4 lhs matrices. One or more of the rhs matrices are padded.
    * Dimensions are the same for lhs and rhs.
@@ -154,3 +163,7 @@ q7_t *arm_nn_depthwise_conv_nt_t_padded_s8(const q7_t *lhs,
     return NULL;
 #endif
 }
+
+/**
+ * @} end of NNBasicMath group
+ */

+ 15 - 2
CMSIS/NN/Source/NNSupportFunctions/arm_nn_depthwise_conv_nt_t_s8.c

@@ -21,8 +21,8 @@
  * Title:        arm_nn_depthwise_conv_nt_t_s8.c
  * Description:  Depthwise convolution on matrices with no padding.
  *
- * $Date:        March 12, 2020
- * $Revision:    V.1.0.0
+ * $Date:        March 17, 2020
+ * $Revision:    V.1.0.1
  *
  * Target Processor:  Cortex-M processors with MVE extension.
  * -------------------------------------------------------------------- */
@@ -30,6 +30,15 @@
 #include "arm_math.h"
 #include "arm_nnfunctions.h"
 
+/**
+ * @ingroup groupSupport
+ */
+
+/**
+ * @addtogroup NNBasicMath
+ * @{
+ */
+
 /*
    * Depthwise convolution of rhs matrix with 4 lhs matrices with no padding. Dimensions are the same for lhs and rhs.
    *
@@ -156,3 +165,7 @@ q7_t *arm_nn_depthwise_conv_nt_t_s8(const q7_t *lhs,
     return NULL;
 #endif
 }
+
+/**
+ * @} end of NNBasicMath group
+ */

+ 6 - 2
CMSIS/NN/Source/NNSupportFunctions/arm_nn_mat_mult_nt_t_s8.c

@@ -21,8 +21,8 @@
  * Title:        arm_nn_mat_mult_s8_nt_t_s8
  * Description:  Matrix multiplication support function with the right-hand-side (rhs) matrix transposed
  *
- * $Date:        7 February 2020
- * $Revision:    V.1.0.0
+ * $Date:        March 17 2020
+ * $Revision:    V.1.0.1
  *
  * Target Processor:  Cortex-M
  *
@@ -566,3 +566,7 @@ arm_status arm_nn_mat_mult_nt_t_s8(const q7_t *lhs,
 #endif
     return ARM_MATH_SUCCESS;
 }
+
+/**
+ * @} end of NNBasicMath group
+ */

+ 6 - 2
CMSIS/NN/Source/NNSupportFunctions/arm_nn_vec_mat_mult_t_s8.c

@@ -21,8 +21,8 @@
  * Title:        arm_nn_vec_mat_mult_t_s8
  * Description:  s8 vector by matrix (transposed) multiplication
  *
- * $Date:        30. January 2020
- * $Revision:    V.1.0.0
+ * $Date:        March 17, 2020
+ * $Revision:    V.1.0.1
  *
  * Target Processor:  Cortex-M
  *
@@ -350,3 +350,7 @@ arm_status arm_nn_vec_mat_mult_t_s8(const q7_t *lhs,
 
     return ARM_MATH_SUCCESS;
 }
+
+/**
+ * @} end of NNBasicMath group
+ */