[FFmpeg-cvslog] r23979 - in trunk: libavcodec/aac_parser.h libavcodec/ac3_parser.h libavcodec/lsp.h libavcodec/motion_est_template.c libavcodec/vp8.c libavutil/lfg.h

[diego]

Author: diego
Date: Fri Jul  2 13:44:58 2010
New Revision: 23979

Log:
Avoid square brackets in Doxygen comments; Doxygen chokes on them.

Modified:
   trunk/libavcodec/aac_parser.h
   trunk/libavcodec/ac3_parser.h
   trunk/libavcodec/lsp.h
   trunk/libavcodec/motion_est_template.c
   trunk/libavcodec/vp8.c
   trunk/libavutil/lfg.h

Modified: trunk/libavcodec/aac_parser.h
==============================================================================
--- trunk/libavcodec/aac_parser.h	Fri Jul  2 13:41:13 2010	(r23978)
+++ trunk/libavcodec/aac_parser.h	Fri Jul  2 13:44:58 2010	(r23979)
@@ -44,8 +44,8 @@ typedef struct {
  * Parse AAC frame header.
  * Parse the ADTS frame header to the end of the variable header, which is
  * the first 54 bits.
- * @param gbc[in] BitContext containing the first 54 bits of the frame.
- * @param hdr[out] Pointer to struct where header info is written.
+ * @param gbc BitContext containing the first 54 bits of the frame.
+ * @param hdr Pointer to struct where header info is written.
  * @return Returns 0 on success, -1 if there is a sync word mismatch,
  * -2 if the version element is invalid, -3 if the sample rate
  * element is invalid, or -4 if the bit rate element is invalid.

Modified: trunk/libavcodec/ac3_parser.h
==============================================================================
--- trunk/libavcodec/ac3_parser.h	Fri Jul  2 13:41:13 2010	(r23978)
+++ trunk/libavcodec/ac3_parser.h	Fri Jul  2 13:44:58 2010	(r23979)
@@ -30,8 +30,8 @@
  * Parse AC-3 frame header.
  * Parse the header up to the lfeon element, which is the first 52 or 54 bits
  * depending on the audio coding mode.
- * @param gbc[in] BitContext containing the first 54 bits of the frame.
- * @param hdr[out] Pointer to struct where header info is written.
+ * @param gbc BitContext containing the first 54 bits of the frame.
+ * @param hdr Pointer to struct where header info is written.
  * @return Returns 0 on success, -1 if there is a sync word mismatch,
  * -2 if the bsid (version) element is invalid, -3 if the fscod (sample rate)
  * element is invalid, or -4 if the frmsizecod (bit rate) element is invalid.
@@ -43,8 +43,8 @@ int ff_ac3_parse_header(GetBitContext *g
  * Parse the header up to the lfeon (channel_map in E-AC-3)
  * element, which is the first 52, 54 or 104 bits depending
  * on the audio coding mode.
- * @param gbc[in] BitContext containing the first 54 bits of the frame.
- * @param hdr[out] Pointer to struct where header info is written.
+ * @param gbc BitContext containing the first 54 bits of the frame.
+ * @param hdr Pointer to struct where header info is written.
  * @return value returned by ff_ac3_parse_header
  */
 int ff_ac3_parse_header_full(GetBitContext *gbc, AC3HeaderInfo *hdr);

Modified: trunk/libavcodec/lsp.h
==============================================================================
--- trunk/libavcodec/lsp.h	Fri Jul  2 13:41:13 2010	(r23978)
+++ trunk/libavcodec/lsp.h	Fri Jul  2 13:44:58 2010	(r23979)
@@ -46,7 +46,7 @@ void ff_acelp_reorder_lsf(int16_t* lsfq,
  * Omitting this step creates audible distortion on the sinusoidal sweep
  * test vectors in 3GPP TS 26.074.
  *
- * @param[in,out] lsf    LSFs in Hertz
+ * @param lsf            [in,out] LSFs in Hertz
  * @param min_spacing    minimum distance between two consecutive lsf values
  */
 void ff_set_min_dist_lsf(float *lsf, double min_spacing, int order);

Modified: trunk/libavcodec/motion_est_template.c
==============================================================================
--- trunk/libavcodec/motion_est_template.c	Fri Jul  2 13:41:13 2010	(r23978)
+++ trunk/libavcodec/motion_est_template.c	Fri Jul  2 13:44:58 2010	(r23979)
@@ -1028,7 +1028,7 @@ static av_always_inline int diamond_sear
 }
 
 /*!
-   \param P[10][2] a list of candidate mvs to check before starting the
+   \param P a list of candidate mvs to check before starting the
    iterative search. If one of the candidates is close to the optimal mv, then
    it takes fewer iterations. And it increases the chance that we find the
    optimal mv.

Modified: trunk/libavcodec/vp8.c
==============================================================================
--- trunk/libavcodec/vp8.c	Fri Jul  2 13:41:13 2010	(r23978)
+++ trunk/libavcodec/vp8.c	Fri Jul  2 13:44:58 2010	(r23979)
@@ -747,8 +747,7 @@ static void decode_mb_mode(VP8Context *s
  * @param i initial coeff index, 0 unless a separate DC block is coded
  * @param zero_nhood the initial prediction context for number of surrounding
  *                   all-zero blocks (only left/top, so 0-2)
- * @param qmul[0] dc dequant factor
- * @param qmul[1] ac dequant factor
+ * @param qmul array holding the dc/ac dequant factor at position 0/1
  * @return 0 if no coeffs were decoded
  *         otherwise, the index of the last coeff decoded plus one
  */

Modified: trunk/libavutil/lfg.h
==============================================================================
--- trunk/libavutil/lfg.h	Fri Jul  2 13:41:13 2010	(r23978)
+++ trunk/libavutil/lfg.h	Fri Jul  2 13:44:58 2010	(r23979)
@@ -55,7 +55,7 @@ static inline unsigned int av_mlfg_get(A
  * Get the next two numbers generated by a Box-Muller Gaussian
  * generator using the random numbers issued by lfg.
  *
- * @param out[2] array where are placed the two generated numbers
+ * @param out array where the two generated numbers are placed
  */
 void av_bmg_get(AVLFG *lfg, double out[2]);