dengzhihao
/
CMSIS-DSP
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

CMSIS-DSP: Corrected Doxygen issues

Browse Source 
Issues with documentation of elementwise functions;
Issues with sorting functions;
Issues with splines functions.
pull/19/head
Christophe Favergeon 6 years ago
parent efd47b9da6
commit c5339c7910
23 changed files with 101 additions and 24 deletions
Show Stats Download Patch File Download Diff File

4
Source/BasicMathFunctions/arm_and_q15.c
Unescape Escape View File

@ -28,10 +28,12 @@
#include "arm_math.h"
/**
@ingroup groupSupport
@ingroup groupMath
*/
/**
@defgroup And Vector bitwise AND

3
Source/BasicMathFunctions/arm_and_q31.c
Unescape Escape View File

@ -28,8 +28,9 @@
#include "arm_math.h"
/**
@ingroup groupSupport
@ingroup groupMath
*/
/**

4
Source/BasicMathFunctions/arm_and_q7.c
Unescape Escape View File

@ -28,10 +28,12 @@
#include "arm_math.h"
/**
@ingroup groupSupport
@ingroup groupMath
*/
/**
@addtogroup And
@{

4
Source/BasicMathFunctions/arm_not_q15.c
Unescape Escape View File

@ -28,10 +28,12 @@
#include "arm_math.h"
/**
@ingroup groupSupport
@ingroup groupMath
*/
/**
@defgroup Not Vector bitwise NOT

4
Source/BasicMathFunctions/arm_not_q31.c
Unescape Escape View File

@ -28,10 +28,12 @@
#include "arm_math.h"
/**
@ingroup groupSupport
@ingroup groupMath
*/
/**
@addtogroup Not
@{

4
Source/BasicMathFunctions/arm_not_q7.c
Unescape Escape View File

@ -28,10 +28,12 @@
#include "arm_math.h"
/**
@ingroup groupSupport
@ingroup groupMath
*/
/**
@addtogroup Not
@{

4
Source/BasicMathFunctions/arm_or_q15.c
Unescape Escape View File

@ -28,10 +28,12 @@
#include "arm_math.h"
/**
@ingroup groupSupport
@ingroup groupMath
*/
/**
@defgroup Or Vector bitwise inclusive OR

4
Source/BasicMathFunctions/arm_or_q31.c
Unescape Escape View File

@ -28,10 +28,12 @@
#include "arm_math.h"
/**
@ingroup groupSupport
@ingroup groupMath
*/
/**
@addtogroup Or
@{

4
Source/BasicMathFunctions/arm_or_q7.c
Unescape Escape View File

@ -28,10 +28,12 @@
#include "arm_math.h"
/**
@ingroup groupSupport
@ingroup groupMath
*/
/**
@addtogroup Or
@{

3
Source/BasicMathFunctions/arm_xor_q15.c
Unescape Escape View File

@ -26,8 +26,9 @@
* limitations under the License.
*/
/**
@ingroup groupSupport
@ingroup groupMath
*/
/**

4
Source/BasicMathFunctions/arm_xor_q31.c
Unescape Escape View File

@ -26,10 +26,12 @@
* limitations under the License.
*/
/**
@ingroup groupSupport
@ingroup groupMath
*/
/**
@addtogroup Xor
@{

4
Source/BasicMathFunctions/arm_xor_q7.c
Unescape Escape View File

@ -26,10 +26,12 @@
* limitations under the License.
*/
/**
@ingroup groupSupport
@ingroup groupMath
*/
/**
@addtogroup Xor
@{

1
Source/SupportFunctions/arm_bitonic_sort_f32.c
Unescape Escape View File

@ -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

1
Source/SupportFunctions/arm_bubble_sort_f32.c
Unescape Escape View File

@ -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

1
Source/SupportFunctions/arm_heap_sort_f32.c
Unescape Escape View File

@ -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

1
Source/SupportFunctions/arm_insertion_sort_f32.c
Unescape Escape View File

@ -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

18
Source/SupportFunctions/arm_merge_sort_init_f32.c
Unescape Escape View File

@ -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
*/

1
Source/SupportFunctions/arm_quick_sort_f32.c
Unescape Escape View File

@ -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

1
Source/SupportFunctions/arm_selection_sort_f32.c
Unescape Escape View File

@ -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

8
Source/SupportFunctions/arm_sort_f32.c
Unescape Escape View File

@ -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
*/

19
Source/SupportFunctions/arm_sort_init_f32.c
Unescape Escape View File

@ -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
*/

22
Source/SupportFunctions/arm_spline_interp_f32.c
Unescape Escape View File

@ -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
*/

6
Source/SupportFunctions/arm_spline_interp_init_f32.c
Unescape Escape View File

@ -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
*/

Write Preview
Loading…
Cancel
Save