Further documentation fixes

pull/39/head
Jean-Baptiste Rolland 3 years ago
parent 133e39401e
commit fceb49ed5d

@ -40,7 +40,7 @@
/**
@brief Initialization function for the floating-point FIR filter.
@param[in,out] S points to an instance of the floating-point FIR filter structure
@param[in] numTaps number of filter coefficients in the filter
@param[in] numTaps number of filter coefficients in the filter
@param[in] pCoeffs points to the filter coefficients buffer
@param[in] pState points to the state buffer
@param[in] blockSize number of samples processed per call

@ -67,14 +67,6 @@
*/
#if defined(ARM_MATH_NEON)
/**
* @brief Floating-point matrix multiplication.
* @param[in] *pSrcA points to the first input matrix structure
* @param[in] *pSrcB points to the second input matrix structure
* @param[out] *pDst points to output matrix structure
* @return The function returns either
* <code>ARM_MATH_SIZE_MISMATCH</code> or <code>ARM_MATH_SUCCESS</code> based on the outcome of size checking.
*/
arm_status arm_mat_mult_f64(
const arm_matrix_instance_f64 * pSrcA,
const arm_matrix_instance_f64 * pSrcB,

@ -31,20 +31,20 @@
/**
@ingroup groupStats
@ingroup groupStats
*/
/**
@addtogroup AbsMax
@{
@addtogroup AbsMax
@{
*/
/**
@brief Maximum value of absolute values of a floating-point vector.
@param[in] pSrc points to the input vector
@param[in] blockSize number of samples in input vector
@param[out] pResult maximum value returned here
@return none
@brief Maximum value of absolute values of a floating-point vector.
@param[in] pSrc points to the input vector
@param[in] blockSize number of samples in input vector
@param[out] pResult maximum value returned here
@return none
*/
#if defined(ARM_MATH_NEON)
@ -151,5 +151,5 @@ void arm_absmax_no_idx_f64(
#endif
/**
@} end of AbsMax group
@} end of AbsMax group
*/

@ -29,21 +29,21 @@
#include "dsp/statistics_functions.h"
/**
@ingroup groupStats
@ingroup groupStats
*/
/**
@addtogroup Max
@{
@addtogroup Max
@{
*/
/**
@brief Maximum value of a floating-point vector.
@param[in] pSrc points to the input vector
@param[in] blockSize number of samples in input vector
@param[out] pResult maximum value returned here
@return none
@brief Maximum value of a floating-point vector.
@param[in] pSrc points to the input vector
@param[in] blockSize number of samples in input vector
@param[out] pResult maximum value returned here
@return none
*/
#if defined(ARM_MATH_NEON)
void arm_max_no_idx_f64(
@ -136,5 +136,5 @@ void arm_max_no_idx_f64(
#endif
/**
@} end of Max group
@} end of Max group
*/

@ -29,21 +29,21 @@
#include "dsp/statistics_functions.h"
/**
@ingroup groupStats
@ingroup groupStats
*/
/**
@addtogroup mean
@{
@addtogroup mean
@{
*/
/**
@brief Mean value of a floating-point vector.
@param[in] pSrc points to the input vector.
@param[in] blockSize number of samples in input vector.
@param[out] pResult mean value returned here.
@return none
@brief Mean value of a floating-point vector.
@param[in] pSrc points to the input vector.
@param[in] blockSize number of samples in input vector.
@param[out] pResult mean value returned here.
@return none
*/
#if defined(ARM_MATH_NEON)
@ -114,5 +114,5 @@ void arm_mean_f64(
}
#endif
/**
@} end of mean group
@} end of mean group
*/

@ -29,21 +29,21 @@
#include "dsp/statistics_functions.h"
/**
@ingroup groupStats
@ingroup groupStats
*/
/**
@addtogroup MSE
@{
@addtogroup MSE
@{
*/
/**
@brief Mean square error between two double floating point vectors.
@param[in] pSrcA points to the first input vector
@param[in] pSrcB points to the second input vector
@param[in] blockSize number of samples in input vector
@param[out] result mean square error
@return none
@brief Mean square error between two double floating point vectors.
@param[in] pSrcA points to the first input vector
@param[in] pSrcB points to the second input vector
@param[in] blockSize number of samples in input vector
@param[out] result mean square error
@return none
*/
void arm_mse_f64(
@ -130,5 +130,5 @@ void arm_mse_f64(
/**
@} end of MSE group
@} end of MSE group
*/

@ -29,20 +29,20 @@
#include "dsp/statistics_functions.h"
/**
@ingroup groupStats
@ingroup groupStats
*/
/**
@addtogroup power
@{
@addtogroup power
@{
*/
/**
@brief Sum of the squares of the elements of a floating-point vector.
@param[in] pSrc points to the input vector
@param[in] blockSize number of samples in input vector
@param[out] pResult sum of the squares value returned here
@return none
@brief Sum of the squares of the elements of a floating-point vector.
@param[in] pSrc points to the input vector
@param[in] blockSize number of samples in input vector
@param[out] pResult sum of the squares value returned here
@return none
*/
#if defined(ARM_MATH_NEON)
void arm_power_f64(
@ -124,5 +124,5 @@ void arm_power_f64(
}
#endif
/**
@} end of power group
@} end of power group
*/

@ -98,5 +98,5 @@ void arm_var_f64(
}
/**
@} end of variance group
@} end of variance group
*/

Loading…
Cancel
Save