Changeset 518 for pjproject/trunk/pjmedia/include/pjmedia/g711.h

Timestamp:

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

Author:

bennylp

Message:

Updated doxygen documentation to all headers in PJMEDIA

File:

• pjproject/trunk/pjmedia/include/pjmedia/g711.h (modified) (2 diffs)

pjproject/trunk/pjmedia/include/pjmedia/g711.h

@@ -20 +20 @@
 #define __PJMEDIA_G711_H__
 
+/**
+ * @file g711.h
+ * @brief G711 Codec
+ */
+
 #include <pjmedia-codec/types.h>
 
+/**
+ * @defgroup PJMED_G711 G711
+ * @ingroup PJMEDIA_CODEC
+ * @brief Standard G.711/PCMA and PCMU codec.
+ * @{
+ * This section describes functions to register and register G.711 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 +62 @@
 PJ_END_DECL
 
+/**
+ * @}
+ */
 
 #endif  /* __PJMEDIA_G711_H__ */