From c5339c79109fa6a26883b48a8464add12e9b47ba Mon Sep 17 00:00:00 2001 From: Christophe Favergeon Date: Fri, 31 Jan 2020 14:34:11 +0100 Subject: [PATCH] CMSIS-DSP: Corrected Doxygen issues Issues with documentation of elementwise functions; Issues with sorting functions; Issues with splines functions. --- Source/BasicMathFunctions/arm_and_q15.c | 4 +++- Source/BasicMathFunctions/arm_and_q31.c | 3 ++- Source/BasicMathFunctions/arm_and_q7.c | 4 +++- Source/BasicMathFunctions/arm_not_q15.c | 4 +++- Source/BasicMathFunctions/arm_not_q31.c | 4 +++- Source/BasicMathFunctions/arm_not_q7.c | 4 +++- Source/BasicMathFunctions/arm_or_q15.c | 4 +++- Source/BasicMathFunctions/arm_or_q31.c | 4 +++- Source/BasicMathFunctions/arm_or_q7.c | 4 +++- Source/BasicMathFunctions/arm_xor_q15.c | 3 ++- Source/BasicMathFunctions/arm_xor_q31.c | 4 +++- Source/BasicMathFunctions/arm_xor_q7.c | 4 +++- .../SupportFunctions/arm_bitonic_sort_f32.c | 1 + Source/SupportFunctions/arm_bubble_sort_f32.c | 1 + Source/SupportFunctions/arm_heap_sort_f32.c | 1 + .../SupportFunctions/arm_insertion_sort_f32.c | 1 + .../arm_merge_sort_init_f32.c | 18 +++++++++++++++ Source/SupportFunctions/arm_quick_sort_f32.c | 1 + .../SupportFunctions/arm_selection_sort_f32.c | 1 + Source/SupportFunctions/arm_sort_f32.c | 8 ++++++- Source/SupportFunctions/arm_sort_init_f32.c | 19 ++++++++++++++++ .../SupportFunctions/arm_spline_interp_f32.c | 22 +++++++++++-------- .../arm_spline_interp_init_f32.c | 6 +++-- 23 files changed, 101 insertions(+), 24 deletions(-) diff --git a/Source/BasicMathFunctions/arm_and_q15.c b/Source/BasicMathFunctions/arm_and_q15.c index e53706f0..b8395fad 100644 --- a/Source/BasicMathFunctions/arm_and_q15.c +++ b/Source/BasicMathFunctions/arm_and_q15.c @@ -28,10 +28,12 @@ #include "arm_math.h" + /** - @ingroup groupSupport + @ingroup groupMath */ + /** @defgroup And Vector bitwise AND diff --git a/Source/BasicMathFunctions/arm_and_q31.c b/Source/BasicMathFunctions/arm_and_q31.c index 0348a590..5e13d828 100644 --- a/Source/BasicMathFunctions/arm_and_q31.c +++ b/Source/BasicMathFunctions/arm_and_q31.c @@ -28,8 +28,9 @@ #include "arm_math.h" + /** - @ingroup groupSupport + @ingroup groupMath */ /** diff --git a/Source/BasicMathFunctions/arm_and_q7.c b/Source/BasicMathFunctions/arm_and_q7.c index 97734a86..e072f87c 100644 --- a/Source/BasicMathFunctions/arm_and_q7.c +++ b/Source/BasicMathFunctions/arm_and_q7.c @@ -28,10 +28,12 @@ #include "arm_math.h" + /** - @ingroup groupSupport + @ingroup groupMath */ + /** @addtogroup And @{ diff --git a/Source/BasicMathFunctions/arm_not_q15.c b/Source/BasicMathFunctions/arm_not_q15.c index 7cfe07e2..5cabc5fc 100644 --- a/Source/BasicMathFunctions/arm_not_q15.c +++ b/Source/BasicMathFunctions/arm_not_q15.c @@ -28,10 +28,12 @@ #include "arm_math.h" + /** - @ingroup groupSupport + @ingroup groupMath */ + /** @defgroup Not Vector bitwise NOT diff --git a/Source/BasicMathFunctions/arm_not_q31.c b/Source/BasicMathFunctions/arm_not_q31.c index c6b08bdf..0768d76a 100644 --- a/Source/BasicMathFunctions/arm_not_q31.c +++ b/Source/BasicMathFunctions/arm_not_q31.c @@ -28,10 +28,12 @@ #include "arm_math.h" + /** - @ingroup groupSupport + @ingroup groupMath */ + /** @addtogroup Not @{ diff --git a/Source/BasicMathFunctions/arm_not_q7.c b/Source/BasicMathFunctions/arm_not_q7.c index 46baf2c5..5629f3e7 100644 --- a/Source/BasicMathFunctions/arm_not_q7.c +++ b/Source/BasicMathFunctions/arm_not_q7.c @@ -28,10 +28,12 @@ #include "arm_math.h" + /** - @ingroup groupSupport + @ingroup groupMath */ + /** @addtogroup Not @{ diff --git a/Source/BasicMathFunctions/arm_or_q15.c b/Source/BasicMathFunctions/arm_or_q15.c index d0920716..b50fdd43 100644 --- a/Source/BasicMathFunctions/arm_or_q15.c +++ b/Source/BasicMathFunctions/arm_or_q15.c @@ -28,10 +28,12 @@ #include "arm_math.h" + /** - @ingroup groupSupport + @ingroup groupMath */ + /** @defgroup Or Vector bitwise inclusive OR diff --git a/Source/BasicMathFunctions/arm_or_q31.c b/Source/BasicMathFunctions/arm_or_q31.c index 749165a9..9be5333e 100644 --- a/Source/BasicMathFunctions/arm_or_q31.c +++ b/Source/BasicMathFunctions/arm_or_q31.c @@ -28,10 +28,12 @@ #include "arm_math.h" + /** - @ingroup groupSupport + @ingroup groupMath */ + /** @addtogroup Or @{ diff --git a/Source/BasicMathFunctions/arm_or_q7.c b/Source/BasicMathFunctions/arm_or_q7.c index 1b563d2d..35ace39f 100644 --- a/Source/BasicMathFunctions/arm_or_q7.c +++ b/Source/BasicMathFunctions/arm_or_q7.c @@ -28,10 +28,12 @@ #include "arm_math.h" + /** - @ingroup groupSupport + @ingroup groupMath */ + /** @addtogroup Or @{ diff --git a/Source/BasicMathFunctions/arm_xor_q15.c b/Source/BasicMathFunctions/arm_xor_q15.c index d0a6a72b..f23f6524 100644 --- a/Source/BasicMathFunctions/arm_xor_q15.c +++ b/Source/BasicMathFunctions/arm_xor_q15.c @@ -26,8 +26,9 @@ * limitations under the License. */ + /** - @ingroup groupSupport + @ingroup groupMath */ /** diff --git a/Source/BasicMathFunctions/arm_xor_q31.c b/Source/BasicMathFunctions/arm_xor_q31.c index 51cba237..0726ad4f 100644 --- a/Source/BasicMathFunctions/arm_xor_q31.c +++ b/Source/BasicMathFunctions/arm_xor_q31.c @@ -26,10 +26,12 @@ * limitations under the License. */ + /** - @ingroup groupSupport + @ingroup groupMath */ + /** @addtogroup Xor @{ diff --git a/Source/BasicMathFunctions/arm_xor_q7.c b/Source/BasicMathFunctions/arm_xor_q7.c index 4c75e222..09da4089 100644 --- a/Source/BasicMathFunctions/arm_xor_q7.c +++ b/Source/BasicMathFunctions/arm_xor_q7.c @@ -26,10 +26,12 @@ * limitations under the License. */ + /** - @ingroup groupSupport + @ingroup groupMath */ + /** @addtogroup Xor @{ diff --git a/Source/SupportFunctions/arm_bitonic_sort_f32.c b/Source/SupportFunctions/arm_bitonic_sort_f32.c index 10267056..ca8a3f93 100644 --- a/Source/SupportFunctions/arm_bitonic_sort_f32.c +++ b/Source/SupportFunctions/arm_bitonic_sort_f32.c @@ -903,6 +903,7 @@ static float32x4x2_t arm_bitonic_sort_8_f32(float32x4_t a, float32x4_t b, uint8_ */ /** + * @private * @param[in] S points to an instance of the sorting structure. * @param[in] pSrc points to the block of input data. * @param[out] pDst points to the block of output data diff --git a/Source/SupportFunctions/arm_bubble_sort_f32.c b/Source/SupportFunctions/arm_bubble_sort_f32.c index fcc4ceb3..12579984 100644 --- a/Source/SupportFunctions/arm_bubble_sort_f32.c +++ b/Source/SupportFunctions/arm_bubble_sort_f32.c @@ -39,6 +39,7 @@ */ /** + * @private * @param[in] S points to an instance of the sorting structure. * @param[in] pSrc points to the block of input data. * @param[out] pDst points to the block of output data diff --git a/Source/SupportFunctions/arm_heap_sort_f32.c b/Source/SupportFunctions/arm_heap_sort_f32.c index 4b81be33..3fc594af 100644 --- a/Source/SupportFunctions/arm_heap_sort_f32.c +++ b/Source/SupportFunctions/arm_heap_sort_f32.c @@ -65,6 +65,7 @@ static void arm_heapify(float32_t * pSrc, uint32_t n, uint32_t i, uint8_t dir) */ /** + * @private * @param[in] S points to an instance of the sorting structure. * @param[in] pSrc points to the block of input data. * @param[out] pDst points to the block of output data diff --git a/Source/SupportFunctions/arm_insertion_sort_f32.c b/Source/SupportFunctions/arm_insertion_sort_f32.c index 92394c9a..f253d72b 100644 --- a/Source/SupportFunctions/arm_insertion_sort_f32.c +++ b/Source/SupportFunctions/arm_insertion_sort_f32.c @@ -39,6 +39,7 @@ */ /** + * @private * @param[in] S points to an instance of the sorting structure. * @param[in] pSrc points to the block of input data. * @param[out] pDst points to the block of output data diff --git a/Source/SupportFunctions/arm_merge_sort_init_f32.c b/Source/SupportFunctions/arm_merge_sort_init_f32.c index 3a2ff07c..31431f31 100644 --- a/Source/SupportFunctions/arm_merge_sort_init_f32.c +++ b/Source/SupportFunctions/arm_merge_sort_init_f32.c @@ -28,8 +28,26 @@ #include "arm_math.h" +/** + @ingroup groupSupport + */ + +/** + @addtogroup Sorting + @{ + */ + + + /** + * @param[in,out] S points to an instance of the sorting structure. + * @param[in] dir Sorting order. + * @param[in] buffer Working buffer. + */ void arm_merge_sort_init_f32(arm_merge_sort_instance_f32 * S, arm_sort_dir dir, float32_t * buffer) { S->dir = dir; S->buffer = buffer; } +/** + @} end of Sorting group + */ diff --git a/Source/SupportFunctions/arm_quick_sort_f32.c b/Source/SupportFunctions/arm_quick_sort_f32.c index 19773e33..04290f7e 100644 --- a/Source/SupportFunctions/arm_quick_sort_f32.c +++ b/Source/SupportFunctions/arm_quick_sort_f32.c @@ -119,6 +119,7 @@ static void arm_quick_sort_core_f32(float32_t *pSrc, uint32_t first, uint32_t la */ /** + * @private * @param[in] S points to an instance of the sorting structure. * @param[in] pSrc points to the block of input data. * @param[out] pDst points to the block of output data diff --git a/Source/SupportFunctions/arm_selection_sort_f32.c b/Source/SupportFunctions/arm_selection_sort_f32.c index 4821696e..9819570c 100644 --- a/Source/SupportFunctions/arm_selection_sort_f32.c +++ b/Source/SupportFunctions/arm_selection_sort_f32.c @@ -39,6 +39,7 @@ */ /** + * @private * @param[in] S points to an instance of the sorting structure. * @param[in] pSrc points to the block of input data. * @param[out] pDst points to the block of output data diff --git a/Source/SupportFunctions/arm_sort_f32.c b/Source/SupportFunctions/arm_sort_f32.c index bb1cf7e4..1e73f5a7 100644 --- a/Source/SupportFunctions/arm_sort_f32.c +++ b/Source/SupportFunctions/arm_sort_f32.c @@ -33,6 +33,12 @@ @ingroup groupSupport */ +/** + @addtogroup Sorting + @{ + */ + + /** * @brief Generic sorting function * @@ -77,5 +83,5 @@ void arm_sort_f32( } /** - * @} end of groupSupport group + @} end of Sorting group */ diff --git a/Source/SupportFunctions/arm_sort_init_f32.c b/Source/SupportFunctions/arm_sort_init_f32.c index 80f10a5b..264b5c38 100644 --- a/Source/SupportFunctions/arm_sort_init_f32.c +++ b/Source/SupportFunctions/arm_sort_init_f32.c @@ -29,8 +29,27 @@ #include "arm_math.h" #include "arm_sorting.h" +/** + @ingroup groupSupport + */ + +/** + @addtogroup Sorting + @{ + */ + + + /** + * @param[in,out] S points to an instance of the sorting structure. + * @param[in] alg Selected algorithm. + * @param[in] dir Sorting order. + */ void arm_sort_init_f32(arm_sort_instance_f32 * S, arm_sort_alg alg, arm_sort_dir dir) { S->alg = alg; S->dir = dir; } + +/** + @} end of Sorting group + */ diff --git a/Source/SupportFunctions/arm_spline_interp_f32.c b/Source/SupportFunctions/arm_spline_interp_f32.c index 2954b570..b486f25a 100644 --- a/Source/SupportFunctions/arm_spline_interp_f32.c +++ b/Source/SupportFunctions/arm_spline_interp_f32.c @@ -28,10 +28,20 @@ #include "arm_math.h" +/* + +Temporary fix because some arrays are defined on the stack. +They should be passed as additional arguments to the function. + +*/ +#define MAX_DATA_POINTS 40 + /** - * @ingroup groupInterpolation + @ingroup groupSupport */ + + /** @defgroup SplineInterpolate Cubic Spline Interpolation @@ -149,13 +159,7 @@ * @param[in] blockSize number of samples of output data. */ -/* - -Temporary fix because some arrays are defined on the stack. -They should be passed as additional arguments to the function. -*/ -#define MAX_DATA_POINTS 40 void arm_spline_f32( arm_spline_instance_f32 * S, @@ -355,5 +359,5 @@ void arm_spline_f32( } /** - * @} end of SplineInterpolate group - * */ + @} end of SplineInterpolate group + */ diff --git a/Source/SupportFunctions/arm_spline_interp_init_f32.c b/Source/SupportFunctions/arm_spline_interp_init_f32.c index 43f9e63b..ed7cc812 100644 --- a/Source/SupportFunctions/arm_spline_interp_init_f32.c +++ b/Source/SupportFunctions/arm_spline_interp_init_f32.c @@ -29,9 +29,10 @@ #include "arm_math.h" /** - * @ingroup groupInterpolation + @ingroup groupSupport */ + /** @addtogroup SplineInterpolate @{ @@ -61,5 +62,6 @@ void arm_spline_init_f32( } /** - * @} end of SplineInterpolate group + @} end of SplineInterpolate group */ +