Changeset 518 for pjproject/trunk/pjmedia/include/pjmedia-codec/l16.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/l16.h (modified) (1 diff)

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

@@ -22 +22 @@
 #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