Browse code

doxygen: Consistently use '@' instead of '\' for Doxygen markup.

Signed-off-by: Diego Biurrun <diego@biurrun.de>

Diego Biurrun authored on 2011/06/24 05:41:54
Showing 38 changed files
... ...
@@ -30,11 +30,11 @@
30 30
 #define PITCH_DELAY_MAX             143
31 31
 
32 32
 /**
33
- * \brief Decode pitch delay of the first subframe encoded by 8 bits with 1/3
33
+ * @brief Decode pitch delay of the first subframe encoded by 8 bits with 1/3
34 34
  *        resolution.
35
- * \param ac_index adaptive codebook index (8 bits)
35
+ * @param ac_index adaptive codebook index (8 bits)
36 36
  *
37
- * \return pitch delay in 1/3 units
37
+ * @return pitch delay in 1/3 units
38 38
  *
39 39
  * Pitch delay is coded:
40 40
  *    with 1/3 resolution, 19  < pitch_delay <  85
... ...
@@ -43,18 +43,18 @@
43 43
 int ff_acelp_decode_8bit_to_1st_delay3(int ac_index);
44 44
 
45 45
 /**
46
- * \brief Decode pitch delay of the second subframe encoded by 5 or 6 bits
46
+ * @brief Decode pitch delay of the second subframe encoded by 5 or 6 bits
47 47
  *        with 1/3 precision.
48
- * \param ac_index adaptive codebook index (5 or 6 bits)
49
- * \param pitch_delay_min lower bound (integer) of pitch delay interval
48
+ * @param ac_index adaptive codebook index (5 or 6 bits)
49
+ * @param pitch_delay_min lower bound (integer) of pitch delay interval
50 50
  *                      for second subframe
51 51
  *
52
- * \return pitch delay in 1/3 units
52
+ * @return pitch delay in 1/3 units
53 53
  *
54 54
  * Pitch delay is coded:
55 55
  *    with 1/3 resolution, -6 < pitch_delay - int(prev_pitch_delay) < 5
56 56
  *
57
- * \remark The routine is used in G.729 @@8k, AMR @@10.2k, AMR @@7.95k,
57
+ * @remark The routine is used in G.729 @@8k, AMR @@10.2k, AMR @@7.95k,
58 58
  *         AMR @@7.4k for the second subframe.
59 59
  */
60 60
 int ff_acelp_decode_5_6_bit_to_2nd_delay3(
... ...
@@ -62,19 +62,19 @@ int ff_acelp_decode_5_6_bit_to_2nd_delay3(
62 62
         int pitch_delay_min);
63 63
 
64 64
 /**
65
- * \brief Decode pitch delay with 1/3 precision.
66
- * \param ac_index adaptive codebook index (4 bits)
67
- * \param pitch_delay_min lower bound (integer) of pitch delay interval for
65
+ * @brief Decode pitch delay with 1/3 precision.
66
+ * @param ac_index adaptive codebook index (4 bits)
67
+ * @param pitch_delay_min lower bound (integer) of pitch delay interval for
68 68
  *                      second subframe
69 69
  *
70
- * \return pitch delay in 1/3 units
70
+ * @return pitch delay in 1/3 units
71 71
  *
72 72
  * Pitch delay is coded:
73 73
  *    integers only,          -6  < pitch_delay - int(prev_pitch_delay) <= -2
74 74
  *    with 1/3 resolution,    -2  < pitch_delay - int(prev_pitch_delay) <  1
75 75
  *    integers only,           1 <= pitch_delay - int(prev_pitch_delay) <  5
76 76
  *
77
- * \remark The routine is used in G.729 @@6.4k, AMR @@6.7k, AMR @@5.9k,
77
+ * @remark The routine is used in G.729 @@6.4k, AMR @@6.7k, AMR @@5.9k,
78 78
  *         AMR @@5.15k, AMR @@4.75k for the second subframe.
79 79
  */
80 80
 int ff_acelp_decode_4bit_to_2nd_delay3(
... ...
@@ -82,44 +82,44 @@ int ff_acelp_decode_4bit_to_2nd_delay3(
82 82
         int pitch_delay_min);
83 83
 
84 84
 /**
85
- * \brief Decode pitch delay of the first subframe encoded by 9 bits
85
+ * @brief Decode pitch delay of the first subframe encoded by 9 bits
86 86
  *        with 1/6 precision.
87
- * \param ac_index adaptive codebook index (9 bits)
87
+ * @param ac_index adaptive codebook index (9 bits)
88 88
  *
89
- * \return pitch delay in 1/6 units
89
+ * @return pitch delay in 1/6 units
90 90
  *
91 91
  * Pitch delay is coded:
92 92
  *    with 1/6 resolution,  17  < pitch_delay <  95
93 93
  *    integers only,        95 <= pitch_delay <= 143
94 94
  *
95
- * \remark The routine is used in AMR @@12.2k for the first and third subframes.
95
+ * @remark The routine is used in AMR @@12.2k for the first and third subframes.
96 96
  */
97 97
 int ff_acelp_decode_9bit_to_1st_delay6(int ac_index);
98 98
 
99 99
 /**
100
- * \brief Decode pitch delay of the second subframe encoded by 6 bits
100
+ * @brief Decode pitch delay of the second subframe encoded by 6 bits
101 101
  *        with 1/6 precision.
102
- * \param ac_index adaptive codebook index (6 bits)
103
- * \param pitch_delay_min lower bound (integer) of pitch delay interval for
102
+ * @param ac_index adaptive codebook index (6 bits)
103
+ * @param pitch_delay_min lower bound (integer) of pitch delay interval for
104 104
  *                      second subframe
105 105
  *
106
- * \return pitch delay in 1/6 units
106
+ * @return pitch delay in 1/6 units
107 107
  *
108 108
  * Pitch delay is coded:
109 109
  *    with 1/6 resolution, -6 < pitch_delay - int(prev_pitch_delay) < 5
110 110
  *
111
- * \remark The routine is used in AMR @@12.2k for the second and fourth subframes.
111
+ * @remark The routine is used in AMR @@12.2k for the second and fourth subframes.
112 112
  */
113 113
 int ff_acelp_decode_6bit_to_2nd_delay6(
114 114
         int ac_index,
115 115
         int pitch_delay_min);
116 116
 
117 117
 /**
118
- * \brief Update past quantized energies
119
- * \param[in,out]  quant_energy  past quantized energies (5.10)
120
- * \param gain_corr_factor gain correction factor
121
- * \param log2_ma_pred_order log2() of MA prediction order
122
- * \param erasure frame erasure flag
118
+ * @brief Update past quantized energies
119
+ * @param[in,out]  quant_energy  past quantized energies (5.10)
120
+ * @param gain_corr_factor gain correction factor
121
+ * @param log2_ma_pred_order log2() of MA prediction order
122
+ * @param erasure frame erasure flag
123 123
  *
124 124
  * If frame erasure flag is not equal to zero, memory is updated with
125 125
  * averaged energy, attenuated by 4dB:
... ...
@@ -128,7 +128,7 @@ int ff_acelp_decode_6bit_to_2nd_delay6(
128 128
  * In normal mode memory is updated with
129 129
  *     Er - Ep = 20 * log10(gain_corr_factor)
130 130
  *
131
- * \remark The routine is used in G.729 and AMR (all modes).
131
+ * @remark The routine is used in G.729 and AMR (all modes).
132 132
  */
133 133
 void ff_acelp_update_past_gain(
134 134
         int16_t* quant_energy,
... ...
@@ -137,16 +137,16 @@ void ff_acelp_update_past_gain(
137 137
         int erasure);
138 138
 
139 139
 /**
140
- * \brief Decode the adaptive codebook gain and add
140
+ * @brief Decode the adaptive codebook gain and add
141 141
  *        correction (4.1.5 and 3.9.1 of G.729).
142
- * \param dsp initialized dsputil context
143
- * \param gain_corr_factor gain correction factor (2.13)
144
- * \param fc_v fixed-codebook vector (2.13)
145
- * \param mr_energy mean innovation energy and fixed-point correction (7.13)
146
- * \param[in,out]  quant_energy  past quantized energies (5.10)
147
- * \param subframe_size length of subframe
142
+ * @param dsp initialized dsputil context
143
+ * @param gain_corr_factor gain correction factor (2.13)
144
+ * @param fc_v fixed-codebook vector (2.13)
145
+ * @param mr_energy mean innovation energy and fixed-point correction (7.13)
146
+ * @param[in,out]  quant_energy  past quantized energies (5.10)
147
+ * @param subframe_size length of subframe
148 148
  *
149
- * \return quantized fixed-codebook gain (14.1)
149
+ * @return quantized fixed-codebook gain (14.1)
150 150
  *
151 151
  * The routine implements equations 69, 66 and 71 of the G.729 specification (3.9.1)
152 152
  *
... ...
@@ -205,7 +205,7 @@ void ff_acelp_update_past_gain(
205 205
  *
206 206
  *        mr_energy = Em + 10log(N) + 10log(2^26)
207 207
  *
208
- * \remark The routine is used in G.729 and AMR (all modes).
208
+ * @remark The routine is used in G.729 and AMR (all modes).
209 209
  */
210 210
 int16_t ff_acelp_decode_gain_code(
211 211
     DSPContext *dsp,
... ...
@@ -3255,7 +3255,7 @@ void av_resample_close(struct AVResampleContext *c);
3255 3255
 /**
3256 3256
  * Allocate memory for a picture.  Call avpicture_free() to free it.
3257 3257
  *
3258
- * \see avpicture_fill()
3258
+ * @see avpicture_fill()
3259 3259
  *
3260 3260
  * @param picture the picture to be filled in
3261 3261
  * @param pix_fmt the format of the picture
... ...
@@ -3302,7 +3302,7 @@ int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3302 3302
  * The data is stored compactly, without any gaps for alignment or padding
3303 3303
  * which may be applied by avpicture_fill().
3304 3304
  *
3305
- * \see avpicture_get_size()
3305
+ * @see avpicture_get_size()
3306 3306
  *
3307 3307
  * @param[in] src AVPicture containing image data
3308 3308
  * @param[in] pix_fmt The format in which the picture data is stored.
... ...
@@ -3896,7 +3896,7 @@ typedef struct AVCodecParserContext {
3896 3896
     int64_t offset;      ///< byte offset from starting packet start
3897 3897
     int64_t cur_frame_end[AV_PARSER_PTS_NB];
3898 3898
 
3899
-    /*!
3899
+    /**
3900 3900
      * Set by parser to 1 for key frames and 0 for non-key frames.
3901 3901
      * It is initialized to -1, so if the parser doesn't set this flag,
3902 3902
      * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
... ...
@@ -34,7 +34,7 @@
34 34
  *
35 35
  *  fc_out[n] = sum(i,0,len-1){ fc_in[i] * filter[(len + n - i)%len] }
36 36
  *
37
- * \note fc_in and fc_out should not overlap!
37
+ * @note fc_in and fc_out should not overlap!
38 38
  */
39 39
 void ff_celp_convolve_circ(int16_t *fc_out, const int16_t *fc_in,
40 40
                            const int16_t *filter, int len);
... ...
@@ -119,7 +119,7 @@ extern COSTABLE_CONST FFTSample* const FFT_NAME(ff_cos_tabs)[17];
119 119
 
120 120
 /**
121 121
  * Initialize the cosine table in ff_cos_tabs[index]
122
- * \param index index in ff_cos_tabs array of the table to initialize
122
+ * @param index index in ff_cos_tabs array of the table to initialize
123 123
  */
124 124
 void ff_init_ff_cos_tabs(int index);
125 125
 
... ...
@@ -116,7 +116,7 @@ static const G729FormatDescription format_g729d_6k4 = {
116 116
 };
117 117
 
118 118
 /**
119
- * \brief pseudo random number generator
119
+ * @brief pseudo random number generator
120 120
  */
121 121
 static inline uint16_t g729_prng(uint16_t value)
122 122
 {
... ...
@@ -97,7 +97,7 @@ found:
97 97
     return i-(state&5);
98 98
 }
99 99
 
100
-/*!
100
+/**
101 101
  * Parse NAL units of found picture and decode some basic information.
102 102
  *
103 103
  * @param s parser context.
... ...
@@ -32,25 +32,25 @@
32 32
 #include "lagarithrac.h"
33 33
 
34 34
 enum LagarithFrameType {
35
-    FRAME_RAW           = 1,    /*!< uncompressed */
36
-    FRAME_U_RGB24       = 2,    /*!< unaligned RGB24 */
37
-    FRAME_ARITH_YUY2    = 3,    /*!< arithmetic coded YUY2 */
38
-    FRAME_ARITH_RGB24   = 4,    /*!< arithmetic coded RGB24 */
39
-    FRAME_SOLID_GRAY    = 5,    /*!< solid grayscale color frame */
40
-    FRAME_SOLID_COLOR   = 6,    /*!< solid non-grayscale color frame */
41
-    FRAME_OLD_ARITH_RGB = 7,    /*!< obsolete arithmetic coded RGB (no longer encoded by upstream since version 1.1.0) */
42
-    FRAME_ARITH_RGBA    = 8,    /*!< arithmetic coded RGBA */
43
-    FRAME_SOLID_RGBA    = 9,    /*!< solid RGBA color frame */
44
-    FRAME_ARITH_YV12    = 10,   /*!< arithmetic coded YV12 */
45
-    FRAME_REDUCED_RES   = 11,   /*!< reduced resolution YV12 frame */
35
+    FRAME_RAW           = 1,    /**< uncompressed */
36
+    FRAME_U_RGB24       = 2,    /**< unaligned RGB24 */
37
+    FRAME_ARITH_YUY2    = 3,    /**< arithmetic coded YUY2 */
38
+    FRAME_ARITH_RGB24   = 4,    /**< arithmetic coded RGB24 */
39
+    FRAME_SOLID_GRAY    = 5,    /**< solid grayscale color frame */
40
+    FRAME_SOLID_COLOR   = 6,    /**< solid non-grayscale color frame */
41
+    FRAME_OLD_ARITH_RGB = 7,    /**< obsolete arithmetic coded RGB (no longer encoded by upstream since version 1.1.0) */
42
+    FRAME_ARITH_RGBA    = 8,    /**< arithmetic coded RGBA */
43
+    FRAME_SOLID_RGBA    = 9,    /**< solid RGBA color frame */
44
+    FRAME_ARITH_YV12    = 10,   /**< arithmetic coded YV12 */
45
+    FRAME_REDUCED_RES   = 11,   /**< reduced resolution YV12 frame */
46 46
 };
47 47
 
48 48
 typedef struct LagarithContext {
49 49
     AVCodecContext *avctx;
50 50
     AVFrame picture;
51 51
     DSPContext dsp;
52
-    int zeros;                  /*!< number of consecutive zero bytes encountered */
53
-    int zeros_rem;              /*!< number of zero bytes remaining to output */
52
+    int zeros;                  /**< number of consecutive zero bytes encountered */
53
+    int zeros_rem;              /**< number of zero bytes remaining to output */
54 54
 } LagarithContext;
55 55
 
56 56
 /**
... ...
@@ -40,15 +40,15 @@ typedef struct lag_rac {
40 40
     AVCodecContext *avctx;
41 41
     unsigned low;
42 42
     unsigned range;
43
-    unsigned scale;             /*!< Number of bits of precision in range. */
44
-    unsigned hash_shift;        /*!< Number of bits to shift to calculate hash for radix search. */
43
+    unsigned scale;             /**< Number of bits of precision in range. */
44
+    unsigned hash_shift;        /**< Number of bits to shift to calculate hash for radix search. */
45 45
 
46
-    const uint8_t *bytestream_start;  /*!< Start of input bytestream. */
47
-    const uint8_t *bytestream;        /*!< Current position in input bytestream. */
48
-    const uint8_t *bytestream_end;    /*!< End position of input bytestream. */
46
+    const uint8_t *bytestream_start;  /**< Start of input bytestream. */
47
+    const uint8_t *bytestream;        /**< Current position in input bytestream. */
48
+    const uint8_t *bytestream_end;    /**< End position of input bytestream. */
49 49
 
50
-    uint32_t prob[258];         /*!< Table of cumulative probability for each symbol. */
51
-    uint8_t  range_hash[256];   /*!< Hash table mapping upper byte to approximate symbol. */
50
+    uint32_t prob[258];         /**< Table of cumulative probability for each symbol. */
51
+    uint8_t  range_hash[256];   /**< Hash table mapping upper byte to approximate symbol. */
52 52
 } lag_rac;
53 53
 
54 54
 void lag_rac_init(lag_rac *l, GetBitContext *gb, int length);
... ...
@@ -73,8 +73,8 @@ typedef struct LclDecContext {
73 73
 
74 74
 
75 75
 /**
76
- * \param srcptr compressed source buffer, must be padded with at least 5 extra bytes
77
- * \param destptr must be padded sufficiently for av_memcpy_backptr
76
+ * @param srcptr compressed source buffer, must be padded with at least 5 extra bytes
77
+ * @param destptr must be padded sufficiently for av_memcpy_backptr
78 78
  */
79 79
 static unsigned int mszh_decomp(const unsigned char * srcptr, int srclen, unsigned char * destptr, unsigned int destsize)
80 80
 {
... ...
@@ -119,11 +119,11 @@ static unsigned int mszh_decomp(const unsigned char * srcptr, int srclen, unsign
119 119
 
120 120
 #if CONFIG_ZLIB_DECODER
121 121
 /**
122
- * \brief decompress a zlib-compressed data block into decomp_buf
123
- * \param src compressed input buffer
124
- * \param src_len data length in input buffer
125
- * \param offset offset in decomp_buf
126
- * \param expected expected decompressed length
122
+ * @brief decompress a zlib-compressed data block into decomp_buf
123
+ * @param src compressed input buffer
124
+ * @param src_len data length in input buffer
125
+ * @param offset offset in decomp_buf
126
+ * @param expected expected decompressed length
127 127
  */
128 128
 static int zlib_decomp(AVCodecContext *avctx, const uint8_t *src, int src_len, int offset, int expected)
129 129
 {
... ...
@@ -74,9 +74,9 @@ void ff_acelp_lsf2lspd(double *lsp, const float *lsf, int lp_order)
74 74
 }
75 75
 
76 76
 /**
77
- * \brief decodes polynomial coefficients from LSP
78
- * \param f [out] decoded polynomial coefficients (-0x20000000 <= (3.22) <= 0x1fffffff)
79
- * \param lsp LSP coefficients (-0x8000 <= (0.15) <= 0x7fff)
77
+ * @brief decodes polynomial coefficients from LSP
78
+ * @param f [out] decoded polynomial coefficients (-0x20000000 <= (3.22) <= 0x1fffffff)
79
+ * @param lsp LSP coefficients (-0x8000 <= (0.15) <= 0x7fff)
80 80
  */
81 81
 static void lsp2poly(int* f, const int16_t* lsp, int lp_half_order)
82 82
 {
... ...
@@ -30,12 +30,12 @@
30 30
 */
31 31
 
32 32
 /**
33
- * \brief ensure a minimum distance between LSFs
34
- * \param[in,out] lsfq LSF to check and adjust
35
- * \param lsfq_min_distance minimum distance between LSFs
36
- * \param lsfq_min minimum allowed LSF value
37
- * \param lsfq_max maximum allowed LSF value
38
- * \param lp_order LP filter order
33
+ * @brief ensure a minimum distance between LSFs
34
+ * @param[in,out] lsfq LSF to check and adjust
35
+ * @param lsfq_min_distance minimum distance between LSFs
36
+ * @param lsfq_min minimum allowed LSF value
37
+ * @param lsfq_max maximum allowed LSF value
38
+ * @param lp_order LP filter order
39 39
  */
40 40
 void ff_acelp_reorder_lsf(int16_t* lsfq, int lsfq_min_distance, int lsfq_min, int lsfq_max, int lp_order);
41 41
 
... ...
@@ -53,12 +53,12 @@ void ff_acelp_reorder_lsf(int16_t* lsfq, int lsfq_min_distance, int lsfq_min, in
53 53
 void ff_set_min_dist_lsf(float *lsf, double min_spacing, int size);
54 54
 
55 55
 /**
56
- * \brief Convert LSF to LSP
57
- * \param[out] lsp LSP coefficients (-0x8000 <= (0.15) < 0x8000)
58
- * \param lsf normalized LSF coefficients (0 <= (2.13) < 0x2000 * PI)
59
- * \param lp_order LP filter order
56
+ * @brief Convert LSF to LSP
57
+ * @param[out] lsp LSP coefficients (-0x8000 <= (0.15) < 0x8000)
58
+ * @param lsf normalized LSF coefficients (0 <= (2.13) < 0x2000 * PI)
59
+ * @param lp_order LP filter order
60 60
  *
61
- * \remark It is safe to pass the same array into the lsf and lsp parameters.
61
+ * @remark It is safe to pass the same array into the lsf and lsp parameters.
62 62
  */
63 63
 void ff_acelp_lsf2lsp(int16_t *lsp, const int16_t *lsf, int lp_order);
64 64
 
... ...
@@ -68,10 +68,10 @@ void ff_acelp_lsf2lsp(int16_t *lsp, const int16_t *lsf, int lp_order);
68 68
 void ff_acelp_lsf2lspd(double *lsp, const float *lsf, int lp_order);
69 69
 
70 70
 /**
71
- * \brief LSP to LP conversion (3.2.6 of G.729)
72
- * \param[out] lp decoded LP coefficients (-0x8000 <= (3.12) < 0x8000)
73
- * \param lsp LSP coefficients (-0x8000 <= (0.15) < 0x8000)
74
- * \param lp_half_order LP filter order, divided by 2
71
+ * @brief LSP to LP conversion (3.2.6 of G.729)
72
+ * @param[out] lp decoded LP coefficients (-0x8000 <= (3.12) < 0x8000)
73
+ * @param lsp LSP coefficients (-0x8000 <= (0.15) < 0x8000)
74
+ * @param lp_half_order LP filter order, divided by 2
75 75
  */
76 76
 void ff_acelp_lsp2lpc(int16_t* lp, const int16_t* lsp, int lp_half_order);
77 77
 
... ...
@@ -81,12 +81,12 @@ void ff_acelp_lsp2lpc(int16_t* lp, const int16_t* lsp, int lp_half_order);
81 81
 void ff_amrwb_lsp2lpc(const double *lsp, float *lp, int lp_order);
82 82
 
83 83
 /**
84
- * \brief Interpolate LSP for the first subframe and convert LSP -> LP for both subframes (3.2.5 and 3.2.6 of G.729)
85
- * \param[out] lp_1st decoded LP coefficients for first subframe  (-0x8000 <= (3.12) < 0x8000)
86
- * \param[out] lp_2nd decoded LP coefficients for second subframe (-0x8000 <= (3.12) < 0x8000)
87
- * \param lsp_2nd LSP coefficients of the second subframe (-0x8000 <= (0.15) < 0x8000)
88
- * \param lsp_prev LSP coefficients from the second subframe of the previous frame (-0x8000 <= (0.15) < 0x8000)
89
- * \param lp_order LP filter order
84
+ * @brief Interpolate LSP for the first subframe and convert LSP -> LP for both subframes (3.2.5 and 3.2.6 of G.729)
85
+ * @param[out] lp_1st decoded LP coefficients for first subframe  (-0x8000 <= (3.12) < 0x8000)
86
+ * @param[out] lp_2nd decoded LP coefficients for second subframe (-0x8000 <= (3.12) < 0x8000)
87
+ * @param lsp_2nd LSP coefficients of the second subframe (-0x8000 <= (0.15) < 0x8000)
88
+ * @param lsp_prev LSP coefficients from the second subframe of the previous frame (-0x8000 <= (0.15) < 0x8000)
89
+ * @param lp_order LP filter order
90 90
  */
91 91
 void ff_acelp_lp_decode(int16_t* lp_1st, int16_t* lp_2nd, const int16_t* lsp_2nd, const int16_t* lsp_prev, int lp_order);
92 92
 
... ...
@@ -248,7 +248,7 @@ static int cmp_internal(MpegEncContext *s, const int x, const int y, const int s
248 248
     }
249 249
 }
250 250
 
251
-/*! \brief compares a block (either a full macroblock or a partition thereof)
251
+/** @brief compares a block (either a full macroblock or a partition thereof)
252 252
     against a proposed motion-compensated prediction of that block
253 253
  */
254 254
 static av_always_inline int cmp(MpegEncContext *s, const int x, const int y, const int subx, const int suby,
... ...
@@ -990,8 +990,8 @@ static av_always_inline int diamond_search(MpegEncContext * s, int *best, int dm
990 990
         return   var_diamond_search(s, best, dmin, src_index, ref_index, penalty_factor, size, h, flags);
991 991
 }
992 992
 
993
-/*!
994
-   \param P[10][2] a list of candidate mvs to check before starting the
993
+/**
994
+   @param P[10][2] a list of candidate mvs to check before starting the
995 995
    iterative search. If one of the candidates is close to the optimal mv, then
996 996
    it takes fewer iterations. And it increases the chance that we find the
997 997
    optimal mv.
... ...
@@ -1001,12 +1001,12 @@ static av_always_inline int epzs_motion_search_internal(MpegEncContext * s, int
1001 1001
                              int ref_mv_scale, int flags, int size, int h)
1002 1002
 {
1003 1003
     MotionEstContext * const c= &s->me;
1004
-    int best[2]={0, 0};      /*!< x and y coordinates of the best motion vector.
1004
+    int best[2]={0, 0};      /**< x and y coordinates of the best motion vector.
1005 1005
                                i.e. the difference between the position of the
1006 1006
                                block currently being encoded and the position of
1007 1007
                                the block chosen to predict it from. */
1008 1008
     int d;                   ///< the score (cmp + penalty) of any given mv
1009
-    int dmin;                /*!< the best value of d, i.e. the score
1009
+    int dmin;                /**< the best value of d, i.e. the score
1010 1010
                                corresponding to the mv stored in best[]. */
1011 1011
     int map_generation;
1012 1012
     int penalty_factor;
... ...
@@ -154,7 +154,7 @@ typedef struct MotionEstContext{
154 154
     uint32_t *score_map;               ///< map to store the scores
155 155
     int map_generation;
156 156
     int pre_penalty_factor;
157
-    int penalty_factor;                /*!< an estimate of the bits required to
157
+    int penalty_factor;                /**< an estimate of the bits required to
158 158
                                         code a given mv value, e.g. (1,0) takes
159 159
                                         more bits than (0,0). We have to
160 160
                                         estimate whether any reduction in
... ...
@@ -63,11 +63,11 @@ static const uint8_t fallback_cquant[] = {
63 63
 };
64 64
 
65 65
 /**
66
- * \brief copy frame data from buffer to AVFrame, handling stride.
67
- * \param f destination AVFrame
68
- * \param src source buffer, does not use any line-stride
69
- * \param width width of the video frame
70
- * \param height height of the video frame
66
+ * @brief copy frame data from buffer to AVFrame, handling stride.
67
+ * @param f destination AVFrame
68
+ * @param src source buffer, does not use any line-stride
69
+ * @param width width of the video frame
70
+ * @param height height of the video frame
71 71
  */
72 72
 static void copy_frame(AVFrame *f, const uint8_t *src,
73 73
                        int width, int height) {
... ...
@@ -77,7 +77,7 @@ static void copy_frame(AVFrame *f, const uint8_t *src,
77 77
 }
78 78
 
79 79
 /**
80
- * \brief extract quantization tables from codec data into our context
80
+ * @brief extract quantization tables from codec data into our context
81 81
  */
82 82
 static int get_quant(AVCodecContext *avctx, NuvContext *c,
83 83
                      const uint8_t *buf, int size) {
... ...
@@ -94,7 +94,7 @@ static int get_quant(AVCodecContext *avctx, NuvContext *c,
94 94
 }
95 95
 
96 96
 /**
97
- * \brief set quantization tables from a quality value
97
+ * @brief set quantization tables from a quality value
98 98
  */
99 99
 static void get_quant_quality(NuvContext *c, int quality) {
100 100
     int i;
... ...
@@ -74,9 +74,9 @@ typedef struct {
74 74
 static const float qcelp_hammsinc_table[4] = { -0.006822,  0.041249, -0.143459,  0.588863};
75 75
 
76 76
 typedef struct {
77
-    uint8_t index;  /*!< index into the QCELPContext structure */
78
-    uint8_t bitpos; /*!< position of the lowest bit in the value's byte */
79
-    uint8_t bitlen; /*!< number of bits to read */
77
+    uint8_t index;  /**< index into the QCELPContext structure */
78
+    uint8_t bitpos; /**< position of the lowest bit in the value's byte */
79
+    uint8_t bitlen; /**< number of bits to read */
80 80
 } QCELPBitmap;
81 81
 
82 82
 #define QCELP_OF(variable, bit, len) {offsetof(QCELPFrame, variable), bit, len}
... ...
@@ -46,7 +46,7 @@
46 46
 
47 47
 typedef enum
48 48
 {
49
-    I_F_Q = -1,    /*!< insufficient frame quality */
49
+    I_F_Q = -1,    /**< insufficient frame quality */
50 50
     SILENCE,
51 51
     RATE_OCTAVE,
52 52
     RATE_QUARTER,
... ...
@@ -58,12 +58,12 @@ typedef struct
58 58
 {
59 59
     GetBitContext     gb;
60 60
     qcelp_packet_rate bitrate;
61
-    QCELPFrame        frame;    /*!< unpacked data frame */
61
+    QCELPFrame        frame;    /**< unpacked data frame */
62 62
 
63 63
     uint8_t  erasure_count;
64
-    uint8_t  octave_count;      /*!< count the consecutive RATE_OCTAVE frames */
64
+    uint8_t  octave_count;      /**< count the consecutive RATE_OCTAVE frames */
65 65
     float    prev_lspf[10];
66
-    float    predictor_lspf[10];/*!< LSP predictor for RATE_OCTAVE and I_F_Q */
66
+    float    predictor_lspf[10];/**< LSP predictor for RATE_OCTAVE and I_F_Q */
67 67
     float    pitch_synthesis_filter_mem[303];
68 68
     float    pitch_pre_filter_mem[303];
69 69
     float    rnd_fir_filter_mem[180];
... ...
@@ -33,12 +33,12 @@
33 33
     if (n) {skip_bits(gb, n);}
34 34
 
35 35
 /**
36
- * \brief read one block from stream
37
- * \param gb contains stream data
38
- * \param block where data is written to
39
- * \param scan array containing the mapping stream address -> block position
40
- * \param quant quantization factors
41
- * \return 0 means the block is not coded, < 0 means an error occurred.
36
+ * @brief read one block from stream
37
+ * @param gb contains stream data
38
+ * @param block where data is written to
39
+ * @param scan array containing the mapping stream address -> block position
40
+ * @param quant quantization factors
41
+ * @return 0 means the block is not coded, < 0 means an error occurred.
42 42
  *
43 43
  * Note: GetBitContext is used to make the code simpler, since all data is
44 44
  * aligned this could be done faster in a different way, e.g. as it is done
... ...
@@ -96,13 +96,13 @@ static inline int get_block(GetBitContext *gb, DCTELEM *block, const uint8_t *sc
96 96
 }
97 97
 
98 98
 /**
99
- * \brief decode one rtjpeg YUV420 frame
100
- * \param c context, must be initialized via rtjpeg_decode_init
101
- * \param f AVFrame to place decoded frame into. If parts of the frame
99
+ * @brief decode one rtjpeg YUV420 frame
100
+ * @param c context, must be initialized via rtjpeg_decode_init
101
+ * @param f AVFrame to place decoded frame into. If parts of the frame
102 102
  *          are not coded they are left unchanged, so consider initializing it
103
- * \param buf buffer containing input data
104
- * \param buf_size length of input data in bytes
105
- * \return number of bytes consumed from the input buffer
103
+ * @param buf buffer containing input data
104
+ * @param buf_size length of input data in bytes
105
+ * @return number of bytes consumed from the input buffer
106 106
  */
107 107
 int rtjpeg_decode_frame_yuv420(RTJpegContext *c, AVFrame *f,
108 108
                                const uint8_t *buf, int buf_size) {
... ...
@@ -143,15 +143,15 @@ int rtjpeg_decode_frame_yuv420(RTJpegContext *c, AVFrame *f,
143 143
 }
144 144
 
145 145
 /**
146
- * \brief initialize an RTJpegContext, may be called multiple times
147
- * \param c context to initialize
148
- * \param dsp specifies the idct to use for decoding
149
- * \param width width of image, will be rounded down to the nearest multiple
146
+ * @brief initialize an RTJpegContext, may be called multiple times
147
+ * @param c context to initialize
148
+ * @param dsp specifies the idct to use for decoding
149
+ * @param width width of image, will be rounded down to the nearest multiple
150 150
  *              of 16 for decoding
151
- * \param height height of image, will be rounded down to the nearest multiple
151
+ * @param height height of image, will be rounded down to the nearest multiple
152 152
  *              of 16 for decoding
153
- * \param lquant luma quantization table to use
154
- * \param cquant chroma quantization table to use
153
+ * @param lquant luma quantization table to use
154
+ * @param cquant chroma quantization table to use
155 155
  */
156 156
 void rtjpeg_decode_init(RTJpegContext *c, DSPContext *dsp,
157 157
                         int width, int height,
... ...
@@ -56,7 +56,7 @@ void write_##type##_2d_array(const void *arg, int len, int len2)\
56 56
 }
57 57
 
58 58
 /**
59
- * \defgroup printfuncs Predefined functions for printing tables
59
+ * @defgroup printfuncs Predefined functions for printing tables
60 60
  *
61 61
  * \{
62 62
  */
... ...
@@ -411,7 +411,7 @@ static inline float mulawinv(float y, float clip, float mu)
411 411
  * a*b == 200 and the nearest integer is ill-defined, use a table to emulate
412 412
  * the following broken float-based implementation used by the binary decoder:
413 413
  *
414
- * \code
414
+ * @code
415 415
  * static int very_broken_op(int a, int b)
416 416
  * {
417 417
  *    static float test; // Ugh, force gcc to do the division first...
... ...
@@ -419,7 +419,7 @@ static inline float mulawinv(float y, float clip, float mu)
419 419
  *    test = a/400.;
420 420
  *    return b * test +  0.5;
421 421
  * }
422
- * \endcode
422
+ * @endcode
423 423
  *
424 424
  * @note if this function is replaced by just ROUNDED_DIV(a*b,400.), the stddev
425 425
  * between the original file (before encoding with Yamaha encoder) and the
... ...
@@ -938,14 +938,14 @@ static void permutate_in_line(int16_t *tab, int num_vect, int num_blocks,
938 938
 /**
939 939
  * Interpret the input data as in the following table:
940 940
  *
941
- * \verbatim
941
+ * @verbatim
942 942
  *
943 943
  * abcdefgh
944 944
  * ijklmnop
945 945
  * qrstuvw
946 946
  * x123456
947 947
  *
948
- * \endverbatim
948
+ * @endverbatim
949 949
  *
950 950
  * and transpose it, giving the output
951 951
  * aiqxbjr1cks2dlt3emu4fvn5gow6hp
... ...
@@ -24,7 +24,7 @@
24 24
 #include "vaapi_internal.h"
25 25
 
26 26
 /**
27
- * \addtogroup VAAPI_Decoding
27
+ * @addtogroup VAAPI_Decoding
28 28
  *
29 29
  * @{
30 30
  */
... ...
@@ -27,8 +27,8 @@
27 27
 #include <stdint.h>
28 28
 
29 29
 /**
30
- * \defgroup VAAPI_Decoding VA API Decoding
31
- * \ingroup Decoder
30
+ * @defgroup VAAPI_Decoding VA API Decoding
31
+ * @ingroup Decoder
32 32
  * @{
33 33
  */
34 34
 
... ...
@@ -30,7 +30,7 @@
30 30
 #include "mpegvideo.h"
31 31
 
32 32
 /**
33
- * \addtogroup VAAPI_Decoding
33
+ * @addtogroup VAAPI_Decoding
34 34
  *
35 35
  * @{
36 36
  */
... ...
@@ -33,7 +33,7 @@
33 33
 #include "vdpau_internal.h"
34 34
 
35 35
 /**
36
- * \addtogroup VDPAU_Decoding
36
+ * @addtogroup VDPAU_Decoding
37 37
  *
38 38
  * @{
39 39
  */
... ...
@@ -25,7 +25,7 @@
25 25
 #define AVCODEC_VDPAU_H
26 26
 
27 27
 /**
28
- * \defgroup Decoder VDPAU Decoder and Renderer
28
+ * @defgroup Decoder VDPAU Decoder and Renderer
29 29
  *
30 30
  * VDPAU hardware acceleration has two modules
31 31
  * - VDPAU decoding
... ...
@@ -38,25 +38,25 @@
38 38
  * and rendering (API calls) are done as part of the VDPAU
39 39
  * presentation (vo_vdpau.c) module.
40 40
  *
41
- * \defgroup  VDPAU_Decoding VDPAU Decoding
42
- * \ingroup Decoder
41
+ * @defgroup  VDPAU_Decoding VDPAU Decoding
42
+ * @ingroup Decoder
43 43
  * @{
44 44
  */
45 45
 
46 46
 #include <vdpau/vdpau.h>
47 47
 #include <vdpau/vdpau_x11.h>
48 48
 
49
-/** \brief The videoSurface is used for rendering. */
49
+/** @brief The videoSurface is used for rendering. */
50 50
 #define FF_VDPAU_STATE_USED_FOR_RENDER 1
51 51
 
52 52
 /**
53
- * \brief The videoSurface is needed for reference/prediction.
53
+ * @brief The videoSurface is needed for reference/prediction.
54 54
  * The codec manipulates this.
55 55
  */
56 56
 #define FF_VDPAU_STATE_USED_FOR_REFERENCE 2
57 57
 
58 58
 /**
59
- * \brief This structure is used as a callback between the Libav
59
+ * @brief This structure is used as a callback between the Libav
60 60
  * decoder (vd_) and presentation (vo_) module.
61 61
  * This is used for defining a video frame containing surface,
62 62
  * picture parameter, bitstream information etc which are passed
... ...
@@ -43,7 +43,7 @@
43 43
 #include "idct_xvid.h"
44 44
 #include "dsputil_mmx.h"
45 45
 
46
-/*!
46
+/**
47 47
  * @file
48 48
  * @brief SSE2 idct compatible with xvidmmx
49 49
  */
... ...
@@ -18,7 +18,7 @@
18 18
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 19
  */
20 20
 
21
-/*!
21
+/**
22 22
  * @file
23 23
  * header for Xvid IDCT functions
24 24
  */
... ...
@@ -36,8 +36,8 @@
36 36
 
37 37
 /**
38 38
  * Encode a single color run. At most 16 bits will be used.
39
- * \param len   length of the run, values > 255 mean "until end of line", may not be < 0.
40
- * \param color color to encode, only the lowest two bits are used and all others must be 0.
39
+ * @param len   length of the run, values > 255 mean "until end of line", may not be < 0.
40
+ * @param color color to encode, only the lowest two bits are used and all others must be 0.
41 41
  */
42 42
 static void put_xsub_rle(PutBitContext *pb, int len, int color)
43 43
 {
... ...
@@ -28,9 +28,9 @@
28 28
 #include "asfcrypt.h"
29 29
 
30 30
 /**
31
- * \brief find multiplicative inverse modulo 2 ^ 32
32
- * \param v number to invert, must be odd!
33
- * \return number so that result * v = 1 (mod 2^32)
31
+ * @brief find multiplicative inverse modulo 2 ^ 32
32
+ * @param v number to invert, must be odd!
33
+ * @return number so that result * v = 1 (mod 2^32)
34 34
  */
35 35
 static uint32_t inverse(uint32_t v) {
36 36
     // v ^ 3 gives the inverse (mod 16), could also be implemented
... ...
@@ -45,9 +45,9 @@ static uint32_t inverse(uint32_t v) {
45 45
 }
46 46
 
47 47
 /**
48
- * \brief read keys from keybuf into keys
49
- * \param keybuf buffer containing the keys
50
- * \param keys output key array containing the keys for encryption in
48
+ * @brief read keys from keybuf into keys
49
+ * @param keybuf buffer containing the keys
50
+ * @param keys output key array containing the keys for encryption in
51 51
  *             native endianness
52 52
  */
53 53
 static void multiswap_init(const uint8_t keybuf[48], uint32_t keys[12]) {
... ...
@@ -57,9 +57,9 @@ static void multiswap_init(const uint8_t keybuf[48], uint32_t keys[12]) {
57 57
 }
58 58
 
59 59
 /**
60
- * \brief invert the keys so that encryption become decryption keys and
60
+ * @brief invert the keys so that encryption become decryption keys and
61 61
  *        the other way round.
62
- * \param keys key array of ints to invert
62
+ * @param keys key array of ints to invert
63 63
  */
64 64
 static void multiswap_invert_keys(uint32_t keys[12]) {
65 65
     int i;
... ...
@@ -92,12 +92,12 @@ static uint32_t multiswap_inv_step(const uint32_t keys[12], uint32_t v) {
92 92
 }
93 93
 
94 94
 /**
95
- * \brief "MultiSwap" encryption
96
- * \param keys 32 bit numbers in machine endianness,
95
+ * @brief "MultiSwap" encryption
96
+ * @param keys 32 bit numbers in machine endianness,
97 97
  *             0-4 and 6-10 must be inverted from decryption
98
- * \param key another key, this one must be the same for the decryption
99
- * \param data data to encrypt
100
- * \return encrypted data
98
+ * @param key another key, this one must be the same for the decryption
99
+ * @param data data to encrypt
100
+ * @return encrypted data
101 101
  */
102 102
 static uint64_t multiswap_enc(const uint32_t keys[12], uint64_t key, uint64_t data) {
103 103
     uint32_t a = data;
... ...
@@ -114,12 +114,12 @@ static uint64_t multiswap_enc(const uint32_t keys[12], uint64_t key, uint64_t da
114 114
 }
115 115
 
116 116
 /**
117
- * \brief "MultiSwap" decryption
118
- * \param keys 32 bit numbers in machine endianness,
117
+ * @brief "MultiSwap" decryption
118
+ * @param keys 32 bit numbers in machine endianness,
119 119
  *             0-4 and 6-10 must be inverted from encryption
120
- * \param key another key, this one must be the same as for the encryption
121
- * \param data data to decrypt
122
- * \return decrypted data
120
+ * @param key another key, this one must be the same as for the encryption
121
+ * @param data data to decrypt
122
+ * @return decrypted data
123 123
  */
124 124
 static uint64_t multiswap_dec(const uint32_t keys[12], uint64_t key, uint64_t data) {
125 125
     uint32_t a;
... ...
@@ -32,11 +32,11 @@ struct gxf_stream_info {
32 32
 };
33 33
 
34 34
 /**
35
- * \brief parses a packet header, extracting type and length
36
- * \param pb AVIOContext to read header from
37
- * \param type detected packet type is stored here
38
- * \param length detected packet length, excluding header is stored here
39
- * \return 0 if header not found or contains invalid data, 1 otherwise
35
+ * @brief parses a packet header, extracting type and length
36
+ * @param pb AVIOContext to read header from
37
+ * @param type detected packet type is stored here
38
+ * @param length detected packet length, excluding header is stored here
39
+ * @return 0 if header not found or contains invalid data, 1 otherwise
40 40
  */
41 41
 static int parse_packet_header(AVIOContext *pb, GXFPktType *type, int *length) {
42 42
     if (avio_rb32(pb))
... ...
@@ -58,7 +58,7 @@ static int parse_packet_header(AVIOContext *pb, GXFPktType *type, int *length) {
58 58
 }
59 59
 
60 60
 /**
61
- * \brief check if file starts with a PKT_MAP header
61
+ * @brief check if file starts with a PKT_MAP header
62 62
  */
63 63
 static int gxf_probe(AVProbeData *p) {
64 64
     static const uint8_t startcode[] = {0, 0, 0, 0, 1, 0xbc}; // start with map packet
... ...
@@ -70,10 +70,10 @@ static int gxf_probe(AVProbeData *p) {
70 70
 }
71 71
 
72 72
 /**
73
- * \brief gets the stream index for the track with the specified id, creates new
73
+ * @brief gets the stream index for the track with the specified id, creates new
74 74
  *        stream if not found
75
- * \param id     id of stream to find / add
76
- * \param format stream format identifier
75
+ * @param id     id of stream to find / add
76
+ * @param format stream format identifier
77 77
  */
78 78
 static int get_sindex(AVFormatContext *s, int id, int format) {
79 79
     int i;
... ...
@@ -153,9 +153,9 @@ static int get_sindex(AVFormatContext *s, int id, int format) {
153 153
 }
154 154
 
155 155
 /**
156
- * \brief filters out interesting tags from material information.
157
- * \param len length of tag section, will be adjusted to contain remaining bytes
158
- * \param si struct to store collected information into
156
+ * @brief filters out interesting tags from material information.
157
+ * @param len length of tag section, will be adjusted to contain remaining bytes
158
+ * @param si struct to store collected information into
159 159
  */
160 160
 static void gxf_material_tags(AVIOContext *pb, int *len, struct gxf_stream_info *si) {
161 161
     si->first_field = AV_NOPTS_VALUE;
... ...
@@ -179,9 +179,9 @@ static void gxf_material_tags(AVIOContext *pb, int *len, struct gxf_stream_info
179 179
 }
180 180
 
181 181
 /**
182
- * \brief convert fps tag value to AVRational fps
183
- * \param fps fps value from tag
184
- * \return fps as AVRational, or 0 / 0 if unknown
182
+ * @brief convert fps tag value to AVRational fps
183
+ * @param fps fps value from tag
184
+ * @return fps as AVRational, or 0 / 0 if unknown
185 185
  */
186 186
 static AVRational fps_tag2avr(int32_t fps) {
187 187
     extern const AVRational ff_frame_rate_tab[];
... ...
@@ -190,9 +190,9 @@ static AVRational fps_tag2avr(int32_t fps) {
190 190
 }
191 191
 
192 192
 /**
193
- * \brief convert UMF attributes flags to AVRational fps
194
- * \param flags UMF flags to convert
195
- * \return fps as AVRational, or 0 / 0 if unknown
193
+ * @brief convert UMF attributes flags to AVRational fps
194
+ * @param flags UMF flags to convert
195
+ * @return fps as AVRational, or 0 / 0 if unknown
196 196
  */
197 197
 static AVRational fps_umf2avr(uint32_t flags) {
198 198
     static const AVRational map[] = {{50, 1}, {60000, 1001}, {24, 1},
... ...
@@ -202,9 +202,9 @@ static AVRational fps_umf2avr(uint32_t flags) {
202 202
 }
203 203
 
204 204
 /**
205
- * \brief filters out interesting tags from track information.
206
- * \param len length of tag section, will be adjusted to contain remaining bytes
207
- * \param si struct to store collected information into
205
+ * @brief filters out interesting tags from track information.
206
+ * @param len length of tag section, will be adjusted to contain remaining bytes
207
+ * @param si struct to store collected information into
208 208
  */
209 209
 static void gxf_track_tags(AVIOContext *pb, int *len, struct gxf_stream_info *si) {
210 210
     si->frames_per_second = (AVRational){0, 0};
... ...
@@ -228,7 +228,7 @@ static void gxf_track_tags(AVIOContext *pb, int *len, struct gxf_stream_info *si
228 228
 }
229 229
 
230 230
 /**
231
- * \brief read index from FLT packet into stream 0 av_index
231
+ * @brief read index from FLT packet into stream 0 av_index
232 232
  */
233 233
 static void gxf_read_index(AVFormatContext *s, int pkt_len) {
234 234
     AVIOContext *pb = s->pb;
... ...
@@ -374,11 +374,11 @@ static int gxf_header(AVFormatContext *s, AVFormatParameters *ap) {
374 374
     }
375 375
 
376 376
 /**
377
- * \brief resync the stream on the next media packet with specified properties
378
- * \param max_interval how many bytes to search for matching packet at most
379
- * \param track track id the media packet must belong to, -1 for any
380
- * \param timestamp minimum timestamp (== field number) the packet must have, -1 for any
381
- * \return timestamp of packet found
377
+ * @brief resync the stream on the next media packet with specified properties
378
+ * @param max_interval how many bytes to search for matching packet at most
379
+ * @param track track id the media packet must belong to, -1 for any
380
+ * @param timestamp minimum timestamp (== field number) the packet must have, -1 for any
381
+ * @return timestamp of packet found
382 382
  */
383 383
 static int64_t gxf_resync_media(AVFormatContext *s, uint64_t max_interval, int track, int timestamp) {
384 384
     uint32_t tmp;
... ...
@@ -221,11 +221,11 @@ static void add_pid_to_pmt(MpegTSContext *ts, unsigned int programid, unsigned i
221 221
 }
222 222
 
223 223
 /**
224
- * \brief discard_pid() decides if the pid is to be discarded according
224
+ * @brief discard_pid() decides if the pid is to be discarded according
225 225
  *                      to caller's programs selection
226
- * \param ts    : - TS context
227
- * \param pid   : - pid
228
- * \return 1 if the pid is only comprised in programs that have .discard=AVDISCARD_ALL
226
+ * @param ts    : - TS context
227
+ * @param pid   : - pid
228
+ * @return 1 if the pid is only comprised in programs that have .discard=AVDISCARD_ALL
229 229
  *         0 otherwise
230 230
  */
231 231
 static int discard_pid(MpegTSContext *ts, unsigned int pid)
... ...
@@ -49,11 +49,11 @@ static int nuv_probe(AVProbeData *p) {
49 49
 #define PKTSIZE(s) (s &  0xffffff)
50 50
 
51 51
 /**
52
- * \brief read until we found all data needed for decoding
53
- * \param vst video stream of which to change parameters
54
- * \param ast video stream of which to change parameters
55
- * \param myth set if this is a MythTVVideo format file
56
- * \return 1 if all required codec data was found
52
+ * @brief read until we found all data needed for decoding
53
+ * @param vst video stream of which to change parameters
54
+ * @param ast video stream of which to change parameters
55
+ * @param myth set if this is a MythTVVideo format file
56
+ * @return 1 if all required codec data was found
57 57
  */
58 58
 static int get_codec_data(AVIOContext *pb, AVStream *vst,
59 59
                           AVStream *ast, int myth) {
... ...
@@ -268,16 +268,16 @@ static av_always_inline av_const int av_popcount_c(uint32_t x)
268 268
         }\
269 269
     }\
270 270
 
271
-/*!
272
- * \def PUT_UTF8(val, tmp, PUT_BYTE)
271
+/**
272
+ * @def PUT_UTF8(val, tmp, PUT_BYTE)
273 273
  * Convert a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
274
- * \param val is an input-only argument and should be of type uint32_t. It holds
274
+ * @param val is an input-only argument and should be of type uint32_t. It holds
275 275
  * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If
276 276
  * val is given as a function it is executed only once.
277
- * \param tmp is a temporary variable and should be of type uint8_t. It
277
+ * @param tmp is a temporary variable and should be of type uint8_t. It
278 278
  * represents an intermediate value during conversion that is to be
279 279
  * output by PUT_BYTE.
280
- * \param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
280
+ * @param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
281 281
  * It could be a function or a statement, and uses tmp as the input byte.
282 282
  * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
283 283
  * executed up to 4 times for values in the valid UTF-8 range and up to
... ...
@@ -304,16 +304,16 @@ static av_always_inline av_const int av_popcount_c(uint32_t x)
304 304
         }\
305 305
     }
306 306
 
307
-/*!
308
- * \def PUT_UTF16(val, tmp, PUT_16BIT)
307
+/**
308
+ * @def PUT_UTF16(val, tmp, PUT_16BIT)
309 309
  * Convert a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes).
310
- * \param val is an input-only argument and should be of type uint32_t. It holds
310
+ * @param val is an input-only argument and should be of type uint32_t. It holds
311 311
  * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If
312 312
  * val is given as a function it is executed only once.
313
- * \param tmp is a temporary variable and should be of type uint16_t. It
313
+ * @param tmp is a temporary variable and should be of type uint16_t. It
314 314
  * represents an intermediate value during conversion that is to be
315 315
  * output by PUT_16BIT.
316
- * \param PUT_16BIT writes the converted UTF-16 data to any proper destination
316
+ * @param PUT_16BIT writes the converted UTF-16 data to any proper destination
317 317
  * in desired endianness. It could be a function or a statement, and uses tmp
318 318
  * as the input byte.  For example, PUT_BYTE could be "*output++ = tmp;"
319 319
  * PUT_BYTE will be executed 1 or 2 times depending on input character.
... ...
@@ -240,7 +240,7 @@ static uint32_t f_func(uint32_t r, uint64_t k) {
240 240
 }
241 241
 
242 242
 /**
243
- * \brief rotate the two halves of the expanded 56 bit key each 1 bit left
243
+ * @brief rotate the two halves of the expanded 56 bit key each 1 bit left
244 244
  *
245 245
  * Note: the specification calls this "shift", so I kept it although
246 246
  * it is confusing.
... ...
@@ -30,22 +30,22 @@ struct AVDES {
30 30
 };
31 31
 
32 32
 /**
33
- * \brief Initializes an AVDES context.
33
+ * @brief Initializes an AVDES context.
34 34
  *
35
- * \param key_bits must be 64 or 192
36
- * \param decrypt 0 for encryption, 1 for decryption
35
+ * @param key_bits must be 64 or 192
36
+ * @param decrypt 0 for encryption, 1 for decryption
37 37
  */
38 38
 int av_des_init(struct AVDES *d, const uint8_t *key, int key_bits, int decrypt);
39 39
 
40 40
 /**
41
- * \brief Encrypts / decrypts using the DES algorithm.
41
+ * @brief Encrypts / decrypts using the DES algorithm.
42 42
  *
43
- * \param count number of 8 byte blocks
44
- * \param dst destination array, can be equal to src, must be 8-byte aligned
45
- * \param src source array, can be equal to dst, must be 8-byte aligned, may be NULL
46
- * \param iv initialization vector for CBC mode, if NULL then ECB will be used,
43
+ * @param count number of 8 byte blocks
44
+ * @param dst destination array, can be equal to src, must be 8-byte aligned
45
+ * @param src source array, can be equal to dst, must be 8-byte aligned, may be NULL
46
+ * @param iv initialization vector for CBC mode, if NULL then ECB will be used,
47 47
  *           must be 8-byte aligned
48
- * \param decrypt 0 for encryption, 1 for decryption
48
+ * @param decrypt 0 for encryption, 1 for decryption
49 49
  */
50 50
 void av_des_crypt(struct AVDES *d, uint8_t *dst, const uint8_t *src, int count, uint8_t *iv, int decrypt);
51 51
 
... ...
@@ -37,8 +37,8 @@ typedef struct LZOContext {
37 37
 } LZOContext;
38 38
 
39 39
 /**
40
- * \brief Reads one byte from the input buffer, avoiding an overrun.
41
- * \return byte read
40
+ * @brief Reads one byte from the input buffer, avoiding an overrun.
41
+ * @return byte read
42 42
  */
43 43
 static inline int get_byte(LZOContext *c) {
44 44
     if (c->in < c->in_end)
... ...
@@ -54,10 +54,10 @@ static inline int get_byte(LZOContext *c) {
54 54
 #endif
55 55
 
56 56
 /**
57
- * \brief Decodes a length value in the coding used by lzo.
58
- * \param x previous byte value
59
- * \param mask bits used from x
60
- * \return decoded length value
57
+ * @brief Decodes a length value in the coding used by lzo.
58
+ * @param x previous byte value
59
+ * @param mask bits used from x
60
+ * @return decoded length value
61 61
  */
62 62
 static inline int get_len(LZOContext *c, int x, int mask) {
63 63
     int cnt = x & mask;
... ...
@@ -82,8 +82,8 @@ static inline int get_len(LZOContext *c, int x, int mask) {
82 82
 #endif
83 83
 
84 84
 /**
85
- * \brief Copies bytes from input to output buffer with checking.
86
- * \param cnt number of bytes to copy, must be >= 0
85
+ * @brief Copies bytes from input to output buffer with checking.
86
+ * @param cnt number of bytes to copy, must be >= 0
87 87
  */
88 88
 static inline void copy(LZOContext *c, int cnt) {
89 89
     register const uint8_t *src = c->in;
... ...
@@ -111,9 +111,9 @@ static inline void copy(LZOContext *c, int cnt) {
111 111
 static inline void memcpy_backptr(uint8_t *dst, int back, int cnt);
112 112
 
113 113
 /**
114
- * \brief Copies previously decoded bytes to current position.
115
- * \param back how many bytes back we start
116
- * \param cnt number of bytes to copy, must be >= 0
114
+ * @brief Copies previously decoded bytes to current position.
115
+ * @param back how many bytes back we start
116
+ * @param cnt number of bytes to copy, must be >= 0
117 117
  *
118 118
  * cnt > back is valid, this will copy the bytes we just copied,
119 119
  * thus creating a repeating pattern with a period length of back.
... ...
@@ -24,7 +24,7 @@
24 24
 
25 25
 #include <stdint.h>
26 26
 
27
-/** \defgroup errflags Error flags returned by av_lzo1x_decode
27
+/** @defgroup errflags Error flags returned by av_lzo1x_decode
28 28
   * \{ */
29 29
 //! end of the input buffer reached before decoding finished
30 30
 #define AV_LZO_INPUT_DEPLETED 1
... ...
@@ -40,12 +40,12 @@
40 40
 #define AV_LZO_OUTPUT_PADDING 12
41 41
 
42 42
 /**
43
- * \brief Decodes LZO 1x compressed data.
44
- * \param out output buffer
45
- * \param outlen size of output buffer, number of bytes left are returned here
46
- * \param in input buffer
47
- * \param inlen size of input buffer, number of bytes left are returned here
48
- * \return 0 on success, otherwise a combination of the error flags above
43
+ * @brief Decodes LZO 1x compressed data.
44
+ * @param out output buffer
45
+ * @param outlen size of output buffer, number of bytes left are returned here
46
+ * @param in input buffer
47
+ * @param inlen size of input buffer, number of bytes left are returned here
48
+ * @return 0 on success, otherwise a combination of the error flags above
49 49
  *
50 50
  * Make sure all buffers are appropriately padded, in must provide
51 51
  * AV_LZO_INPUT_PADDING, out must provide AV_LZO_OUTPUT_PADDING additional bytes.
... ...
@@ -53,10 +53,10 @@
53 53
 int av_lzo1x_decode(void *out, int *outlen, const void *in, int *inlen);
54 54
 
55 55
 /**
56
- * \brief deliberately overlapping memcpy implementation
57
- * \param dst destination buffer; must be padded with 12 additional bytes
58
- * \param back how many bytes back we start (the initial size of the overlapping window)
59
- * \param cnt number of bytes to copy, must be >= 0
56
+ * @brief deliberately overlapping memcpy implementation
57
+ * @param dst destination buffer; must be padded with 12 additional bytes
58
+ * @param back how many bytes back we start (the initial size of the overlapping window)
59
+ * @param cnt number of bytes to copy, must be >= 0
60 60
  *
61 61
  * cnt > back is valid, this will copy the bytes we just copied,
62 62
  * thus creating a repeating pattern with a period length of back.
... ...
@@ -29,21 +29,21 @@ struct AVRC4 {
29 29
 };
30 30
 
31 31
 /**
32
- * \brief Initializes an AVRC4 context.
32
+ * @brief Initializes an AVRC4 context.
33 33
  *
34
- * \param key_bits must be a multiple of 8
35
- * \param decrypt 0 for encryption, 1 for decryption, currently has no effect
34
+ * @param key_bits must be a multiple of 8
35
+ * @param decrypt 0 for encryption, 1 for decryption, currently has no effect
36 36
  */
37 37
 int av_rc4_init(struct AVRC4 *d, const uint8_t *key, int key_bits, int decrypt);
38 38
 
39 39
 /**
40
- * \brief Encrypts / decrypts using the RC4 algorithm.
40
+ * @brief Encrypts / decrypts using the RC4 algorithm.
41 41
  *
42
- * \param count number of bytes
43
- * \param dst destination array, can be equal to src
44
- * \param src source array, can be equal to dst, may be NULL
45
- * \param iv not (yet) used for RC4, should be NULL
46
- * \param decrypt 0 for encryption, 1 for decryption, not (yet) used
42
+ * @param count number of bytes
43
+ * @param dst destination array, can be equal to src
44
+ * @param src source array, can be equal to dst, may be NULL
45
+ * @param iv not (yet) used for RC4, should be NULL
46
+ * @param decrypt 0 for encryption, 1 for decryption, not (yet) used
47 47
  */
48 48
 void av_rc4_crypt(struct AVRC4 *d, uint8_t *dst, const uint8_t *src, int count, uint8_t *iv, int decrypt);
49 49