From 1e3b83e9244308e791d9c1fc0e81d418e7543b84 Mon Sep 17 00:00:00 2001 From: Silfurion Date: Thu, 18 Aug 2022 14:50:23 +0200 Subject: [PATCH] Correction of documentation errors --- Include/dsp/support_functions.h | 10 +++++----- Source/SupportFunctions/arm_f64_to_float.c | 3 --- Source/SupportFunctions/arm_f64_to_q15.c | 2 +- Source/SupportFunctions/arm_f64_to_q31.c | 2 +- Source/SupportFunctions/arm_f64_to_q7.c | 2 +- Source/SupportFunctions/arm_q15_to_f64.c | 2 +- Source/SupportFunctions/arm_q31_to_f64.c | 4 ++-- Source/SupportFunctions/arm_q7_to_f64.c | 3 ++- 8 files changed, 13 insertions(+), 15 deletions(-) diff --git a/Include/dsp/support_functions.h b/Include/dsp/support_functions.h index f5d5bacd..5358d28d 100755 --- a/Include/dsp/support_functions.h +++ b/Include/dsp/support_functions.h @@ -55,7 +55,7 @@ extern "C" uint32_t blockSize); /** - * @brief Converts the elements of the 64 bit floating-point vector to floating-point vector. + * @brief Converts the elements of the 64 bit floating-point vector to Q31 vector. * @param[in] pSrc points to the floating-point 64 input vector * @param[out] pDst points to the Q31 output vector * @param[in] blockSize length of the input vector @@ -66,7 +66,7 @@ extern "C" uint32_t blockSize); /** - * @brief Converts the elements of the 64 bit floating-point vector to floating-point vector. + * @brief Converts the elements of the 64 bit floating-point vector to Q15 vector. * @param[in] pSrc points to the floating-point 64 input vector * @param[out] pDst points to the Q15 output vector * @param[in] blockSize length of the input vector @@ -77,7 +77,7 @@ extern "C" uint32_t blockSize); /** - * @brief Converts the elements of the 64 bit floating-point vector to floating-point vector. + * @brief Converts the elements of the 64 bit floating-point vector to Q7 vector. * @param[in] pSrc points to the floating-point 64 input vector * @param[out] pDst points to the Q7 output vector * @param[in] blockSize length of the input vector @@ -91,8 +91,8 @@ extern "C" /** * @brief Converts the elements of the floating-point vector to 64 bit floating-point vector. - * @param[in] pSrc points to the floating-point 64 input vector - * @param[out] pDst points to the floating-point output vector + * @param[in] pSrc points to the floating-point input vector + * @param[out] pDst points to the 64 bit floating-point output vector * @param[in] blockSize length of the input vector */ void arm_float_to_f64( diff --git a/Source/SupportFunctions/arm_f64_to_float.c b/Source/SupportFunctions/arm_f64_to_float.c index 981543f8..37dc2761 100644 --- a/Source/SupportFunctions/arm_f64_to_float.c +++ b/Source/SupportFunctions/arm_f64_to_float.c @@ -32,9 +32,6 @@ @ingroup groupSupport */ -/** - * @defgroup f64_to_x Convert 64-bit floating point value - */ /** @addtogroup f64_to_x diff --git a/Source/SupportFunctions/arm_f64_to_q15.c b/Source/SupportFunctions/arm_f64_to_q15.c index 93ddca15..faefb3ec 100644 --- a/Source/SupportFunctions/arm_f64_to_q15.c +++ b/Source/SupportFunctions/arm_f64_to_q15.c @@ -38,7 +38,7 @@ */ /** - @brief Converts the elements of the floating-point vector to Q15 vector. + @brief Converts the elements of the 64 bit floating-point vector to Q15 vector. @param[in] pSrc points to the 64 bit floating-point input vector @param[out] pDst points to the Q15 output vector @param[in] blockSize number of samples in each vector diff --git a/Source/SupportFunctions/arm_f64_to_q31.c b/Source/SupportFunctions/arm_f64_to_q31.c index e6b4afee..5e2db8ff 100644 --- a/Source/SupportFunctions/arm_f64_to_q31.c +++ b/Source/SupportFunctions/arm_f64_to_q31.c @@ -39,7 +39,7 @@ */ /** - @brief Converts the elements of the floating-point vector to Q31 vector. + @brief Converts the elements of the 64 bit floating-point vector to Q31 vector. @param[in] pSrc points to the 64 bit floating-point input vector @param[out] pDst points to the Q31 output vector @param[in] blockSize number of samples in each vector diff --git a/Source/SupportFunctions/arm_f64_to_q7.c b/Source/SupportFunctions/arm_f64_to_q7.c index bc3bba56..9e57c5a8 100644 --- a/Source/SupportFunctions/arm_f64_to_q7.c +++ b/Source/SupportFunctions/arm_f64_to_q7.c @@ -38,7 +38,7 @@ */ /** - * @brief Converts the elements of the floating-point vector to Q7 vector. + * @brief Converts the elements of the 64 bit floating-point vector to Q7 vector. * @param[in] *pSrc points to the 64 bit floating-point input vector * @param[out] *pDst points to the Q7 output vector * @param[in] blockSize length of the input vector diff --git a/Source/SupportFunctions/arm_q15_to_f64.c b/Source/SupportFunctions/arm_q15_to_f64.c index 38c0ace8..ba563ec3 100644 --- a/Source/SupportFunctions/arm_q15_to_f64.c +++ b/Source/SupportFunctions/arm_q15_to_f64.c @@ -42,7 +42,7 @@ */ /** - @brief Converts the elements of the Q15 vector to floating-point vector. + @brief Converts the elements of the Q15 vector to 64 bit floating-point vector. @param[in] pSrc points to the Q15 input vector @param[out] pDst points to the 64 bit floating-point output vector @param[in] blockSize number of samples in each vector diff --git a/Source/SupportFunctions/arm_q31_to_f64.c b/Source/SupportFunctions/arm_q31_to_f64.c index 5ed921d4..47f6ad08 100644 --- a/Source/SupportFunctions/arm_q31_to_f64.c +++ b/Source/SupportFunctions/arm_q31_to_f64.c @@ -42,9 +42,9 @@ */ /** - @brief Converts the elements of the Q31 vector to floating-point vector. + @brief Converts the elements of the Q31 vector to 64 bit floating-point vector. @param[in] pSrc points to the Q31 input vector - @param[out] pDst points to the floating-point output vector + @param[out] pDst points to the 64 bit floating-point output vector @param[in] blockSize number of samples in each vector @return none diff --git a/Source/SupportFunctions/arm_q7_to_f64.c b/Source/SupportFunctions/arm_q7_to_f64.c index 5d2837f6..ab993896 100644 --- a/Source/SupportFunctions/arm_q7_to_f64.c +++ b/Source/SupportFunctions/arm_q7_to_f64.c @@ -42,7 +42,7 @@ */ /** - @brief Converts the elements of the Q7 vector to floating-point vector. + @brief Converts the elements of the Q7 vector to 64 bit floating-point vector. @param[in] pSrc points to the Q7 input vector @param[out] pDst points to the 64 bit floating-point output vector @param[in] blockSize number of samples in each vector @@ -108,3 +108,4 @@ void arm_q7_to_f64( /** @} end of q7_to_x group */ + \ No newline at end of file