From 937e5f416cc49418c5286550eb6cb227fb953cf3 Mon Sep 17 00:00:00 2001 From: Jamie Bullock Date: Tue, 10 Oct 2006 12:29:39 +0000 Subject: Improved doxygen documentation --- xtract/xtract_vector.h | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) (limited to 'xtract/xtract_vector.h') diff --git a/xtract/xtract_vector.h b/xtract/xtract_vector.h index aa751a3..fc39aa7 100644 --- a/xtract/xtract_vector.h +++ b/xtract/xtract_vector.h @@ -26,6 +26,13 @@ #ifdef __cplusplus extern "C" { #endif + +/** + * \defgroup vector extraction functions + * + * Defines vectorr extraction functions, and their parameters. + * @{ + */ /** \brief Extract normalized (0-1) frequency domain magnitude spectrum from time domain signal * @@ -110,7 +117,9 @@ int xtract_dct(float *data, int N, void *argv, float *result); * \param *result: a pointer to an array of size N, containing N/2 freqs and N/2 amplitudes, amplitudes are on a decibel scale with dbFS = 0 */ int xtract_peaks(float *data, int N, void *argv, float *result); - + +/** @} */ + #ifdef __cplusplus } #endif -- cgit v1.2.3