Browse code

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

Originally committed as revision 23979 to svn://svn.ffmpeg.org/ffmpeg/trunk

Diego Biurrun authored on 2010/07/02 20:44:58
Showing 6 changed files
... ...
@@ -44,8 +44,8 @@ typedef struct {
44 44
  * Parse AAC frame header.
45 45
  * Parse the ADTS frame header to the end of the variable header, which is
46 46
  * the first 54 bits.
47
- * @param gbc[in] BitContext containing the first 54 bits of the frame.
48
- * @param hdr[out] Pointer to struct where header info is written.
47
+ * @param gbc BitContext containing the first 54 bits of the frame.
48
+ * @param hdr Pointer to struct where header info is written.
49 49
  * @return Returns 0 on success, -1 if there is a sync word mismatch,
50 50
  * -2 if the version element is invalid, -3 if the sample rate
51 51
  * element is invalid, or -4 if the bit rate element is invalid.
... ...
@@ -30,8 +30,8 @@
30 30
  * Parse AC-3 frame header.
31 31
  * Parse the header up to the lfeon element, which is the first 52 or 54 bits
32 32
  * depending on the audio coding mode.
33
- * @param gbc[in] BitContext containing the first 54 bits of the frame.
34
- * @param hdr[out] Pointer to struct where header info is written.
33
+ * @param gbc BitContext containing the first 54 bits of the frame.
34
+ * @param hdr Pointer to struct where header info is written.
35 35
  * @return Returns 0 on success, -1 if there is a sync word mismatch,
36 36
  * -2 if the bsid (version) element is invalid, -3 if the fscod (sample rate)
37 37
  * element is invalid, or -4 if the frmsizecod (bit rate) element is invalid.
... ...
@@ -43,8 +43,8 @@ int ff_ac3_parse_header(GetBitContext *gbc, AC3HeaderInfo *hdr);
43 43
  * Parse the header up to the lfeon (channel_map in E-AC-3)
44 44
  * element, which is the first 52, 54 or 104 bits depending
45 45
  * on the audio coding mode.
46
- * @param gbc[in] BitContext containing the first 54 bits of the frame.
47
- * @param hdr[out] Pointer to struct where header info is written.
46
+ * @param gbc BitContext containing the first 54 bits of the frame.
47
+ * @param hdr Pointer to struct where header info is written.
48 48
  * @return value returned by ff_ac3_parse_header
49 49
  */
50 50
 int ff_ac3_parse_header_full(GetBitContext *gbc, AC3HeaderInfo *hdr);
... ...
@@ -46,7 +46,7 @@ void ff_acelp_reorder_lsf(int16_t* lsfq, int lsfq_min_distance, int lsfq_min, in
46 46
  * Omitting this step creates audible distortion on the sinusoidal sweep
47 47
  * test vectors in 3GPP TS 26.074.
48 48
  *
49
- * @param[in,out] lsf    LSFs in Hertz
49
+ * @param lsf            [in,out] LSFs in Hertz
50 50
  * @param min_spacing    minimum distance between two consecutive lsf values
51 51
  */
52 52
 void ff_set_min_dist_lsf(float *lsf, double min_spacing, int order);
... ...
@@ -1028,7 +1028,7 @@ static av_always_inline int diamond_search(MpegEncContext * s, int *best, int dm
1028 1028
 }
1029 1029
 
1030 1030
 /*!
1031
-   \param P[10][2] a list of candidate mvs to check before starting the
1031
+   \param P a list of candidate mvs to check before starting the
1032 1032
    iterative search. If one of the candidates is close to the optimal mv, then
1033 1033
    it takes fewer iterations. And it increases the chance that we find the
1034 1034
    optimal mv.
... ...
@@ -747,8 +747,7 @@ static void decode_mb_mode(VP8Context *s, VP8Macroblock *mb, int mb_x, int mb_y,
747 747
  * @param i initial coeff index, 0 unless a separate DC block is coded
748 748
  * @param zero_nhood the initial prediction context for number of surrounding
749 749
  *                   all-zero blocks (only left/top, so 0-2)
750
- * @param qmul[0] dc dequant factor
751
- * @param qmul[1] ac dequant factor
750
+ * @param qmul array holding the dc/ac dequant factor at position 0/1
752 751
  * @return 0 if no coeffs were decoded
753 752
  *         otherwise, the index of the last coeff decoded plus one
754 753
  */
... ...
@@ -55,7 +55,7 @@ static inline unsigned int av_mlfg_get(AVLFG *c){
55 55
  * Get the next two numbers generated by a Box-Muller Gaussian
56 56
  * generator using the random numbers issued by lfg.
57 57
  *
58
- * @param out[2] array where are placed the two generated numbers
58
+ * @param out array where the two generated numbers are placed
59 59
  */
60 60
 void av_bmg_get(AVLFG *lfg, double out[2]);
61 61