diff options
| author | Jamie Bullock <jamie@postlude.co.uk> | 2006-10-10 12:29:39 +0000 |
|---|---|---|
| committer | Jamie Bullock <jamie@postlude.co.uk> | 2006-10-10 12:29:39 +0000 |
| commit | 937e5f416cc49418c5286550eb6cb227fb953cf3 (patch) | |
| tree | 99aa560bcb4e0e42ad2dca26383fdcc2eb72a054 /xtract/xtract_vector.h | |
| parent | 2d9ae1f9a04d7c9dceef2099f12b5f54482fe4e7 (diff) | |
| download | LibXtract-937e5f416cc49418c5286550eb6cb227fb953cf3.tar.gz LibXtract-937e5f416cc49418c5286550eb6cb227fb953cf3.tar.bz2 LibXtract-937e5f416cc49418c5286550eb6cb227fb953cf3.zip | |
Improved doxygen documentation
Diffstat (limited to 'xtract/xtract_vector.h')
| -rw-r--r-- | xtract/xtract_vector.h | 11 |
1 files changed, 10 insertions, 1 deletions
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 |