Correction of documentation errors

pull/40/head
Silfurion 3 years ago
parent e402e59dbd
commit 1e3b83e924

@ -55,7 +55,7 @@ extern "C"
uint32_t blockSize); 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[in] pSrc points to the floating-point 64 input vector
* @param[out] pDst points to the Q31 output vector * @param[out] pDst points to the Q31 output vector
* @param[in] blockSize length of the input vector * @param[in] blockSize length of the input vector
@ -66,7 +66,7 @@ extern "C"
uint32_t blockSize); 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[in] pSrc points to the floating-point 64 input vector
* @param[out] pDst points to the Q15 output vector * @param[out] pDst points to the Q15 output vector
* @param[in] blockSize length of the input vector * @param[in] blockSize length of the input vector
@ -77,7 +77,7 @@ extern "C"
uint32_t blockSize); 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[in] pSrc points to the floating-point 64 input vector
* @param[out] pDst points to the Q7 output vector * @param[out] pDst points to the Q7 output vector
* @param[in] blockSize length of the input 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. * @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[in] pSrc points to the floating-point 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 length of the input vector * @param[in] blockSize length of the input vector
*/ */
void arm_float_to_f64( void arm_float_to_f64(

@ -32,9 +32,6 @@
@ingroup groupSupport @ingroup groupSupport
*/ */
/**
* @defgroup f64_to_x Convert 64-bit floating point value
*/
/** /**
@addtogroup f64_to_x @addtogroup f64_to_x

@ -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[in] pSrc points to the 64 bit floating-point input vector
@param[out] pDst points to the Q15 output vector @param[out] pDst points to the Q15 output vector
@param[in] blockSize number of samples in each vector @param[in] blockSize number of samples in each vector

@ -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[in] pSrc points to the 64 bit floating-point input vector
@param[out] pDst points to the Q31 output vector @param[out] pDst points to the Q31 output vector
@param[in] blockSize number of samples in each vector @param[in] blockSize number of samples in each vector

@ -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[in] *pSrc points to the 64 bit floating-point input vector
* @param[out] *pDst points to the Q7 output vector * @param[out] *pDst points to the Q7 output vector
* @param[in] blockSize length of the input vector * @param[in] blockSize length of the input vector

@ -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[in] pSrc points to the Q15 input vector
@param[out] pDst points to the 64 bit 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 @param[in] blockSize number of samples in each vector

@ -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[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 @param[in] blockSize number of samples in each vector
@return none @return none

@ -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[in] pSrc points to the Q7 input vector
@param[out] pDst points to the 64 bit 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 @param[in] blockSize number of samples in each vector
@ -108,3 +108,4 @@ void arm_q7_to_f64(
/** /**
@} end of q7_to_x group @} end of q7_to_x group
*/ */
Loading…
Cancel
Save