Updated doxygen documentation to all headers in PJMEDIA
git-svn-id: https://svn.pjsip.org/repos/pjproject/trunk@518 74dad513-b988-da41-8d7b-12977e46ad98
diff --git a/pjmedia/include/pjmedia-codec/speex.h b/pjmedia/include/pjmedia-codec/speex.h
index a6e7680..a773b39 100644
--- a/pjmedia/include/pjmedia-codec/speex.h
+++ b/pjmedia/include/pjmedia-codec/speex.h
@@ -19,8 +19,27 @@
#ifndef __PJMEDIA_CODEC_SPEEX_H__
#define __PJMEDIA_CODEC_SPEEX_H__
+/**
+ * @file speex.h
+ * @brief Speex codec header.
+ */
+
#include <pjmedia-codec/types.h>
+/**
+ * @defgroup PJMED_SPEEX Speex
+ * @ingroup PJMEDIA_CODEC
+ * @brief Implementation of Speex codecs (narrow/wide/ultrawide-band).
+ * @{
+ * This section describes functions to register and register speex codec
+ * factory to the codec manager. After the codec factory has been registered,
+ * application can use @ref PJMEDIA_CODEC API to manipulate the codec.
+ *
+ * By default, the speex codec factory registers three Speex codecs:
+ * "speex/8000" narrowband codec, "speex/16000" wideband codec, and
+ * "speex/32000" ultra-wideband codec. This behavior can be changed by
+ * specifying #pjmedia_speex_options flags during initialization.
+ */
PJ_BEGIN_DECL
@@ -59,11 +78,6 @@
* pjmedia endpoint.
*
* @param endpt The pjmedia endpoint.
- * @param options Bitmask of pjmedia_speex_options (default=0).
- * @param quality Specify encoding quality, or use -1 for default
- * (default=8).
- * @param complexity Specify encoding complexity , or use -1 for default
- * (default=8).
*
* @return PJ_SUCCESS on success.
*/
@@ -82,6 +96,9 @@
PJ_END_DECL
+/**
+ * @}
+ */
#endif /* __PJMEDIA_CODEC_SPEEX_H__ */