Changeset 518 for pjproject/trunk/pjmedia/include/pjmedia-codec/gsm.h

Timestamp:

Jun 18, 2006 2:02:36 AM (18 years ago)

Author:

bennylp

Message:

Updated doxygen documentation to all headers in PJMEDIA

File:

• pjproject/trunk/pjmedia/include/pjmedia-codec/gsm.h (modified) (2 diffs)

pjproject/trunk/pjmedia/include/pjmedia-codec/gsm.h

@@ -20 +20 @@
 #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
@@ -49 +63 @@
 
 
+/**
+ * @}
+ */
+
 #endif  /* __PJMEDIA_CODEC_GSM_H__ */