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
This commit is contained in:
Andrew Latham
2012-09-22 20:43:30 +00:00
parent ca8aeeef1b
commit fd98835f1f
30 changed files with 143 additions and 361 deletions

View File

@@ -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,