Avoid square brackets in Doxygen comments; Doxygen chokes on them.
authorDiego Biurrun <diego@biurrun.de>
Fri, 2 Jul 2010 11:44:58 +0000 (11:44 +0000)
committerDiego Biurrun <diego@biurrun.de>
Fri, 2 Jul 2010 11:44:58 +0000 (11:44 +0000)
Originally committed as revision 23979 to svn://svn.ffmpeg.org/ffmpeg/trunk

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

index 76880095b952bcf587bd1eb9b75f248151389a1e..1e32cd84f413fe3d2e1e0af557d5bb2be3a38b9d 100644 (file)
@@ -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.
index 757cb1582c6a690a20896c75a304e92e3ce9b864..9226c90218d401b4692d8bdea45c0c7da7c00591 100644 (file)
@@ -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 *gbc, AC3HeaderInfo *hdr);
  * 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);
index 4e9171a94f0b1d4d920f49e6b5a76b15897b6f44..1da80e848748ba167bfcc591d3df8585b5025531 100644 (file)
@@ -46,7 +46,7 @@ void ff_acelp_reorder_lsf(int16_t* lsfq, int lsfq_min_distance, int lsfq_min, in
  * 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);
index 8f730ef14fd5a7b7b6c897d8298c48d28a4208c2..8334de2f83736dc6f265f5793098a1e83c3dc4ed 100644 (file)
@@ -1028,7 +1028,7 @@ static av_always_inline int diamond_search(MpegEncContext * s, int *best, int dm
 }
 
 /*!
-   \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.
index 33b26dba28f000ff9c8fc2165474fcaeef4ffb3d..3308676af7de867356ac57f471f1208084d62b69 100644 (file)
@@ -747,8 +747,7 @@ static void decode_mb_mode(VP8Context *s, VP8Macroblock *mb, int mb_x, int mb_y,
  * @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
  */
index 2867710c448c01a8f8bf067171fef7b465a95be4..854ffce737872c144545889dfc6f590c5bfa6822 100644 (file)
@@ -55,7 +55,7 @@ static inline unsigned int av_mlfg_get(AVLFG *c){
  * 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]);