Browse code

Use correct Doxygen syntax

Diego Biurrun authored on 2013/10/04 00:46:36
Showing 3 changed files
... ...
@@ -123,7 +123,7 @@ static float gain_tab1[16];
123 123
 static float gain_tab2[31];
124 124
 
125 125
 
126
-/*
126
+/**
127 127
  * Regular 512 points IMDCT without overlapping, with the exception of the
128 128
  * swapping of odd bands caused by the reverse spectra of the QMF.
129 129
  *
... ...
@@ -205,7 +205,7 @@ static av_cold int atrac3_decode_close(AVCodecContext *avctx)
205 205
     return 0;
206 206
 }
207 207
 
208
-/*
208
+/**
209 209
  * Mantissa decoding
210 210
  *
211 211
  * @param selector     which table the output values are coded with
... ...
@@ -267,7 +267,7 @@ static void read_quant_spectral_coeffs(GetBitContext *gb, int selector,
267 267
     }
268 268
 }
269 269
 
270
-/*
270
+/**
271 271
  * Restore the quantized band spectrum coefficients
272 272
  *
273 273
  * @return subband count, fix for broken specification/files
... ...
@@ -324,7 +324,7 @@ static int decode_spectrum(GetBitContext *gb, float *output)
324 324
     return num_subbands;
325 325
 }
326 326
 
327
-/*
327
+/**
328 328
  * Restore the quantized tonal components
329 329
  *
330 330
  * @param components tonal components
... ...
@@ -408,7 +408,7 @@ static int decode_tonal_components(GetBitContext *gb,
408 408
     return component_count;
409 409
 }
410 410
 
411
-/*
411
+/**
412 412
  * Decode gain parameters for the coded bands
413 413
  *
414 414
  * @param block      the gainblock for the current band
... ...
@@ -443,7 +443,7 @@ static int decode_gain_control(GetBitContext *gb, GainBlock *block,
443 443
     return 0;
444 444
 }
445 445
 
446
-/*
446
+/**
447 447
  * Apply gain parameters and perform the MDCT overlapping part
448 448
  *
449 449
  * @param input   input buffer
... ...
@@ -500,7 +500,7 @@ static void gain_compensate_and_overlap(float *input, float *prev,
500 500
     memcpy(prev, &input[256], 256 * sizeof(*prev));
501 501
 }
502 502
 
503
-/*
503
+/**
504 504
  * Combine the tonal band spectrum and regular band spectrum
505 505
  *
506 506
  * @param spectrum        output spectrum buffer
... ...
@@ -627,7 +627,7 @@ static void channel_weighting(float *su1, float *su2, int *p3)
627 627
     }
628 628
 }
629 629
 
630
-/*
630
+/**
631 631
  * Decode a Sound Unit
632 632
  *
633 633
  * @param snd           the channel unit to be used
... ...
@@ -54,9 +54,9 @@ typedef struct VideoDSPContext {
54 54
     /**
55 55
      * Prefetch memory into cache (if supported by hardware).
56 56
      *
57
-     * @buf pointer to buffer to prefetch memory from
58
-     * @stride distance between two lines of buf (in bytes)
59
-     * @h number of lines to prefetch
57
+     * @param buf    pointer to buffer to prefetch memory from
58
+     * @param stride distance between two lines of buf (in bytes)
59
+     * @param h      number of lines to prefetch
60 60
      */
61 61
     void (*prefetch)(uint8_t *buf, ptrdiff_t stride, int h);
62 62
 } VideoDSPContext;
... ...
@@ -122,7 +122,7 @@ typedef struct AVPixFmtDescriptor{
122 122
 
123 123
 #if FF_API_PIX_FMT
124 124
 /**
125
- * @deprecate use the AV_PIX_FMT_FLAG_* flags
125
+ * @deprecated use the AV_PIX_FMT_FLAG_* flags
126 126
  */
127 127
 #define PIX_FMT_BE        AV_PIX_FMT_FLAG_BE
128 128
 #define PIX_FMT_PAL       AV_PIX_FMT_FLAG_PAL