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

pjproject/trunk/pjmedia/include/pjmedia/jbuf.h

@@ -32 +32 @@
 /**
  * @defgroup PJMED_JBUF Adaptive jitter buffer
- * @ingroup PJMEDIA
+ * @ingroup PJMEDIA_FRAME_OP
  * @{
- *
+ * This section describes PJMEDIA's implementation of de-jitter buffer.
+ * The de-jitter buffer may be set to operate in adaptive mode or fixed
+ * delay mode.
+ *
+ * The jitter buffer is also able to report the status of the current
+ * frame (#pjmedia_jb_frame_type). This status is used for examply by
+ * @ref PJMED_STRM to invoke the codec's @ref PJMED_PLC algorithm.
  */