Changeset 3327 for pjproject/trunk/pjmedia/include/pjmedia-codec/amr_helper.h

Timestamp:

Sep 30, 2010 4:23:27 AM (14 years ago)

Author:

bennylp

Message:

Re #1134 (misc fixes): fixed various doxygen warnings, as well as added overview section in pjmedia documentation

File:

• pjproject/trunk/pjmedia/include/pjmedia-codec/amr_helper.h (modified) (4 diffs)

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

@@ -598 +598 @@
 
 /**
- * This structure describes AMR frame info, to be fitted into @pjmedia_frame 
+ * This structure describes AMR frame info, to be fitted into #pjmedia_frame
  * bit info.
  */
@@ -713 +713 @@
  * - align left the start bit (make the start_bit to be 0).
  *
- * @param amr_nb    Set PJ_TRUE for AMR-NB and PJ_FALSE for AMR-WB.
  * @param in        Input frame.
- * @param setting   Settings, see @pjmedia_codec_amr_pack_setting.
+ * @param setting   Settings, see #pjmedia_codec_amr_pack_setting.
  * @param out       Output frame.
  *
@@ -853 +852 @@
  * @param frames    AMR frames to be packed.
  * @param nframes   Number of frames to be packed.
- * @param setting   Settings, see @pjmedia_codec_amr_pack_setting.
+ * @param setting   Settings, see #pjmedia_codec_amr_pack_setting.
  * @param pkt       Payload.
  * @param pkt_size  Payload size, as input this specifies payload maximum size,
@@ -1070 +1069 @@
  * @param pkt_size  Payload size.
  * @param ts        Base timestamp.
- * @param setting   Settings, see @pjmedia_codec_amr_pack_setting.
+ * @param setting   Settings, see #pjmedia_codec_amr_pack_setting.
  * @param frames    Frames parsed.
  * @param nframes   Number of frames parsed.