Updated doxygen documentation to all headers in PJMEDIA

git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@518 74dad513-b988-da41-8d7b-12977e46ad98

3 files changed, 54 insertions, 5 deletions

diff --git a/pjmedia/include/pjmedia-codec/gsm.h b/pjmedia/include/pjmedia-codec/gsm.h
index abcc9fbb..04f526ad 100644
--- a/pjmedia/include/pjmedia-codec/gsm.h
+++ b/pjmedia/include/pjmedia-codec/gsm.h
@@ -19,8 +19,22 @@
 #ifndef __PJMEDIA_CODEC_GSM_H__
 #define __PJMEDIA_CODEC_GSM_H__
 
+/**
+ * @file pjmedia-codec/gsm.h
+ * @brief GSM 06.10 codec.
+ */
+
 #include <pjmedia-codec/types.h>
 
+/**
+ * @defgroup PJMED_GSM GSM 06.10
+ * @ingroup PJMEDIA_CODEC
+ * @brief Implementation of GSM FR based on GSM 06.10 library
+ * @{
+ * This section describes functions to register and register GSM codec
+ * factory to the codec manager. After the codec factory has been registered,
+ * application can use @ref PJMEDIA_CODEC API to manipulate the codec.
+ */
 
 PJ_BEGIN_DECL
 
@@ -48,5 +62,9 @@ PJ_DECL(pj_status_t) pjmedia_codec_gsm_deinit(void);
 PJ_END_DECL
 
 
+/**
+ * @}
+ */
+
 #endif	/* __PJMEDIA_CODEC_GSM_H__ */
 
diff --git a/pjmedia/include/pjmedia-codec/l16.h b/pjmedia/include/pjmedia-codec/l16.h
index be2bf26a..225c0929 100644
--- a/pjmedia/include/pjmedia-codec/l16.h
+++ b/pjmedia/include/pjmedia-codec/l16.h
@@ -22,6 +22,20 @@
 #include <pjmedia-codec/types.h>
 
 
+/**
+ * @defgroup PJMED_L16 L16 Family
+ * @ingroup PJMEDIA_CODEC
+ * @brief 16bit linear codecs (useful for debugging)
+ * @{
+ * This section describes functions to register and register L16 codec
+ * factory to the codec manager. After the codec factory has been registered,
+ * application can use @ref PJMEDIA_CODEC API to manipulate the codec.
+ *
+ * Note that the L16 codec factory registers several (about fourteen!) 
+ * L16 codec types to codec manager (different combinations of clock
+ * rate and number of channels).
+ */
+
 PJ_BEGIN_DECL
 
 
diff --git a/pjmedia/include/pjmedia-codec/speex.h b/pjmedia/include/pjmedia-codec/speex.h
index a6e76808..a773b39e 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 @@ PJ_DECL(pj_status_t) pjmedia_codec_speex_init( pjmedia_endpt *endpt,
  * 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_DECL(pj_status_t) pjmedia_codec_speex_deinit(void);
 
 PJ_END_DECL
 
+/**
+ * @}
+ */
 
 #endif	/* __PJMEDIA_CODEC_SPEEX_H__ */