diff options
| author | Andrew Latham <lathama@gmail.com> | 2012-09-22 20:43:30 +0000 |
|---|---|---|
| committer | Andrew Latham <lathama@gmail.com> | 2012-09-22 20:43:30 +0000 |
| commit | fd98835f1fb45d2b745bd273a590cf488b4c11dd (patch) | |
| tree | 6755c6c5fd972d7867a0595f4ac64d5d56acfdb8 /codecs | |
| parent | ca8aeeef1bead57973f91fce0e4ed239d73a00b3 (diff) | |
Doxygen Updates Janitor Work
* Whitespace, doc-blocks, spelling, case, missing and incorrect tags.
* Add cleanup to Makefile for the Doxygen configuration update
* Start updating Doxygen configuration for cleaner output
* Enable inclusion of configuration files into documentation
* remove mantisworkflow...
* update documentation README
* Add markup to Tilghman's email and talk with him about updating his email, he knows...
* no code changes on this commit other than the mentioned Makefile change
(issue ASTERISK-20259)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@373384 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'codecs')
| -rw-r--r-- | codecs/speex/speex_resampler.h | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/codecs/speex/speex_resampler.h b/codecs/speex/speex_resampler.h index bcf201538..5dead0e79 100644 --- a/codecs/speex/speex_resampler.h +++ b/codecs/speex/speex_resampler.h @@ -113,14 +113,15 @@ enum { struct SpeexResamplerState_; typedef struct SpeexResamplerState_ SpeexResamplerState; -/** Create a new resampler with integer input and output rates. - * @param nb_channels Number of channels to be processed - * @param in_rate Input sampling rate (integer number of Hz). - * @param out_rate Output sampling rate (integer number of Hz). - * @param quality Resampling quality between 0 and 10, where 0 has poor quality - * and 10 has very high quality. - * @return Newly created resampler state - * @retval NULL Error: not enough memory +/** \brief Create a new resampler with integer input and output rates. + * \param nb_channels Number of channels to be processed + * \param in_rate Input sampling rate (integer number of Hz). + * \param out_rate Output sampling rate (integer number of Hz). + * \param quality Resampling quality between 0 and 10, where 0 has poor quality + * and 10 has very high quality. + * \param err + * \return Newly created resampler state + * \retval NULL Error: not enough memory */ SpeexResamplerState *speex_resampler_init(spx_uint32_t nb_channels, spx_uint32_t in_rate, |