Browse code

doxygen: eliminate Qt-style doxygen syntax

Diego Biurrun authored on 2011/10/31 02:27:33
Showing 10 changed files
... ...
@@ -653,7 +653,7 @@ static void decode_gains(AMRContext *p, const AMRNBSubframe *amr_subframe,
653 653
 static void apply_ir_filter(float *out, const AMRFixed *in,
654 654
                             const float *filter)
655 655
 {
656
-    float filter1[AMR_SUBFRAME_SIZE],     //!< filters at pitch lag*1 and *2
656
+    float filter1[AMR_SUBFRAME_SIZE],     ///< filters at pitch lag*1 and *2
657 657
           filter2[AMR_SUBFRAME_SIZE];
658 658
     int   lag = in->pitch_lag;
659 659
     float fac = in->pitch_fac;
... ...
@@ -51,7 +51,7 @@ typedef struct {
51 51
                             /// or "7" for custom one
52 52
     VLC         *tab;       /// pointer to the table associated with tab_sel
53 53
 
54
-    //! the following are used only when tab_sel == 7
54
+    /// the following are used only when tab_sel == 7
55 55
     IVIHuffDesc cust_desc;  /// custom Huffman codebook descriptor
56 56
     VLC         cust_tab;   /// vlc table for custom codebook
57 57
 } IVIHuffTab;
... ...
@@ -45,35 +45,35 @@ static const char* sample_message =
45 45
     "a sample of this file.";
46 46
 
47 47
 typedef struct SubStream {
48
-    //! Set if a valid restart header has been read. Otherwise the substream cannot be decoded.
48
+    /// Set if a valid restart header has been read. Otherwise the substream cannot be decoded.
49 49
     uint8_t     restart_seen;
50 50
 
51 51
     //@{
52 52
     /** restart header data */
53
-    //! The type of noise to be used in the rematrix stage.
53
+    /// The type of noise to be used in the rematrix stage.
54 54
     uint16_t    noise_type;
55 55
 
56
-    //! The index of the first channel coded in this substream.
56
+    /// The index of the first channel coded in this substream.
57 57
     uint8_t     min_channel;
58
-    //! The index of the last channel coded in this substream.
58
+    /// The index of the last channel coded in this substream.
59 59
     uint8_t     max_channel;
60
-    //! The number of channels input into the rematrix stage.
60
+    /// The number of channels input into the rematrix stage.
61 61
     uint8_t     max_matrix_channel;
62
-    //! For each channel output by the matrix, the output channel to map it to
62
+    /// For each channel output by the matrix, the output channel to map it to
63 63
     uint8_t     ch_assign[MAX_CHANNELS];
64 64
 
65
-    //! Channel coding parameters for channels in the substream
65
+    /// Channel coding parameters for channels in the substream
66 66
     ChannelParams channel_params[MAX_CHANNELS];
67 67
 
68
-    //! The left shift applied to random noise in 0x31ea substreams.
68
+    /// The left shift applied to random noise in 0x31ea substreams.
69 69
     uint8_t     noise_shift;
70
-    //! The current seed value for the pseudorandom noise generator(s).
70
+    /// The current seed value for the pseudorandom noise generator(s).
71 71
     uint32_t    noisegen_seed;
72 72
 
73
-    //! Set if the substream contains extra info to check the size of VLC blocks.
73
+    /// Set if the substream contains extra info to check the size of VLC blocks.
74 74
     uint8_t     data_check_present;
75 75
 
76
-    //! Bitmask of which parameter sets are conveyed in a decoding parameter block.
76
+    /// Bitmask of which parameter sets are conveyed in a decoding parameter block.
77 77
     uint8_t     param_presence_flags;
78 78
 #define PARAM_BLOCKSIZE     (1 << 7)
79 79
 #define PARAM_MATRIX        (1 << 6)
... ...
@@ -88,32 +88,32 @@ typedef struct SubStream {
88 88
     //@{
89 89
     /** matrix data */
90 90
 
91
-    //! Number of matrices to be applied.
91
+    /// Number of matrices to be applied.
92 92
     uint8_t     num_primitive_matrices;
93 93
 
94
-    //! matrix output channel
94
+    /// matrix output channel
95 95
     uint8_t     matrix_out_ch[MAX_MATRICES];
96 96
 
97
-    //! Whether the LSBs of the matrix output are encoded in the bitstream.
97
+    /// Whether the LSBs of the matrix output are encoded in the bitstream.
98 98
     uint8_t     lsb_bypass[MAX_MATRICES];
99
-    //! Matrix coefficients, stored as 2.14 fixed point.
99
+    /// Matrix coefficients, stored as 2.14 fixed point.
100 100
     int32_t     matrix_coeff[MAX_MATRICES][MAX_CHANNELS];
101
-    //! Left shift to apply to noise values in 0x31eb substreams.
101
+    /// Left shift to apply to noise values in 0x31eb substreams.
102 102
     uint8_t     matrix_noise_shift[MAX_MATRICES];
103 103
     //@}
104 104
 
105
-    //! Left shift to apply to Huffman-decoded residuals.
105
+    /// Left shift to apply to Huffman-decoded residuals.
106 106
     uint8_t     quant_step_size[MAX_CHANNELS];
107 107
 
108
-    //! number of PCM samples in current audio block
108
+    /// number of PCM samples in current audio block
109 109
     uint16_t    blocksize;
110
-    //! Number of PCM samples decoded so far in this frame.
110
+    /// Number of PCM samples decoded so far in this frame.
111 111
     uint16_t    blockpos;
112 112
 
113
-    //! Left shift to apply to decoded PCM values to get final 24-bit output.
113
+    /// Left shift to apply to decoded PCM values to get final 24-bit output.
114 114
     int8_t      output_shift[MAX_CHANNELS];
115 115
 
116
-    //! Running XOR of all output samples.
116
+    /// Running XOR of all output samples.
117 117
     int32_t     lossless_check_data;
118 118
 
119 119
 } SubStream;
... ...
@@ -122,21 +122,21 @@ typedef struct MLPDecodeContext {
122 122
     AVCodecContext *avctx;
123 123
     AVFrame     frame;
124 124
 
125
-    //! Current access unit being read has a major sync.
125
+    /// Current access unit being read has a major sync.
126 126
     int         is_major_sync_unit;
127 127
 
128
-    //! Set if a valid major sync block has been read. Otherwise no decoding is possible.
128
+    /// Set if a valid major sync block has been read. Otherwise no decoding is possible.
129 129
     uint8_t     params_valid;
130 130
 
131
-    //! Number of substreams contained within this stream.
131
+    /// Number of substreams contained within this stream.
132 132
     uint8_t     num_substreams;
133 133
 
134
-    //! Index of the last substream to decode - further substreams are skipped.
134
+    /// Index of the last substream to decode - further substreams are skipped.
135 135
     uint8_t     max_decoded_substream;
136 136
 
137
-    //! number of PCM samples contained in each frame
137
+    /// number of PCM samples contained in each frame
138 138
     int         access_unit_size;
139
-    //! next power of two above the number of samples in each frame
139
+    /// next power of two above the number of samples in each frame
140 140
     int         access_unit_size_pow2;
141 141
 
142 142
     SubStream   substream[MAX_SUBSTREAMS];
... ...
@@ -40,16 +40,16 @@
40 40
 typedef struct {
41 41
 /// @name QCELP excitation codebook parameters
42 42
 /// @{
43
-    uint8_t cbsign[16]; ///!< sign of the codebook gain for each codebook subframe
44
-    uint8_t cbgain[16]; ///!< unsigned codebook gain for each codebook subframe
45
-    uint8_t cindex[16]; ///!< codebook index for each codebook subframe
43
+    uint8_t cbsign[16]; ///< sign of the codebook gain for each codebook subframe
44
+    uint8_t cbgain[16]; ///< unsigned codebook gain for each codebook subframe
45
+    uint8_t cindex[16]; ///< codebook index for each codebook subframe
46 46
 /// @}
47 47
 
48 48
 /// @name QCELP pitch prediction parameters
49 49
 /// @{
50
-    uint8_t plag[4];    ///!< pitch lag for each pitch subframe
51
-    uint8_t pfrac[4];   ///!< fractional pitch lag for each pitch subframe
52
-    uint8_t pgain[4];   ///!< pitch gain for each pitch subframe
50
+    uint8_t plag[4];    ///< pitch lag for each pitch subframe
51
+    uint8_t pfrac[4];   ///< fractional pitch lag for each pitch subframe
52
+    uint8_t pgain[4];   ///< pitch gain for each pitch subframe
53 53
 /// @}
54 54
 
55 55
     /**
... ...
@@ -266,7 +266,7 @@ static const QCELPBitmap qcelp_rate_octave_bitmap[] = {
266 266
  * the QCELPContext
267 267
  */
268 268
 static const QCELPBitmap * const qcelp_unpacking_bitmaps_per_rate[5] = {
269
-    NULL,                     ///!< for SILENCE rate
269
+    NULL,                     ///< for SILENCE rate
270 270
     qcelp_rate_octave_bitmap,
271 271
     qcelp_rate_quarter_bitmap,
272 272
     qcelp_rate_half_bitmap,
... ...
@@ -274,7 +274,7 @@ static const QCELPBitmap * const qcelp_unpacking_bitmaps_per_rate[5] = {
274 274
 };
275 275
 
276 276
 static const uint16_t qcelp_unpacking_bitmaps_lengths[5] = {
277
-    0, ///!< for SILENCE rate
277
+    0, ///< for SILENCE rate
278 278
     FF_ARRAY_ELEMS(qcelp_rate_octave_bitmap),
279 279
     FF_ARRAY_ELEMS(qcelp_rate_quarter_bitmap),
280 280
     FF_ARRAY_ELEMS(qcelp_rate_half_bitmap),
... ...
@@ -27,7 +27,7 @@
27 27
     i = scan[coeff--]; \
28 28
     block[i] = (c) * quant[i];
29 29
 
30
-//! aligns the bitstream to the give power of two
30
+/// aligns the bitstream to the given power of two
31 31
 #define ALIGN(a) \
32 32
     n = (-get_bits_count(gb)) & (a - 1); \
33 33
     if (n) {skip_bits(gb, n);}
... ...
@@ -293,7 +293,7 @@ typedef struct AVFormatParameters {
293 293
 #endif
294 294
 } AVFormatParameters;
295 295
 
296
-//! Demuxer will use avio_open, no opened file should be provided by the caller.
296
+/// Demuxer will use avio_open, no opened file should be provided by the caller.
297 297
 #define AVFMT_NOFILE        0x0001
298 298
 #define AVFMT_NEEDNUMBER    0x0002 /**< Needs '%d' in filename. */
299 299
 #define AVFMT_SHOW_IDS      0x0008 /**< Show format stream IDs numbers. */
... ...
@@ -47,7 +47,7 @@ static int nuv_probe(AVProbeData *p) {
47 47
     return 0;
48 48
 }
49 49
 
50
-//! little macro to sanitize packet size
50
+/// little macro to sanitize packet size
51 51
 #define PKTSIZE(s) (s &  0xffffff)
52 52
 
53 53
 /**
... ...
@@ -21,14 +21,14 @@
21 21
 
22 22
 #include "avutil.h"
23 23
 #include "common.h"
24
-//! Avoid e.g. MPlayers fast_memcpy, it slows things down here.
24
+/// Avoid e.g. MPlayers fast_memcpy, it slows things down here.
25 25
 #undef memcpy
26 26
 #include <string.h>
27 27
 #include "lzo.h"
28 28
 
29
-//! Define if we may write up to 12 bytes beyond the output buffer.
29
+/// Define if we may write up to 12 bytes beyond the output buffer.
30 30
 #define OUTBUF_PADDED 1
31
-//! Define if we may read up to 8 bytes beyond the input buffer.
31
+/// Define if we may read up to 8 bytes beyond the input buffer.
32 32
 #define INBUF_PADDED 1
33 33
 typedef struct LZOContext {
34 34
     const uint8_t *in, *in_end;
... ...
@@ -33,13 +33,13 @@
33 33
 
34 34
 /** @name Error flags returned by av_lzo1x_decode
35 35
   * \{ */
36
-//! end of the input buffer reached before decoding finished
36
+/// end of the input buffer reached before decoding finished
37 37
 #define AV_LZO_INPUT_DEPLETED 1
38
-//! decoded data did not fit into output buffer
38
+/// decoded data did not fit into output buffer
39 39
 #define AV_LZO_OUTPUT_FULL 2
40
-//! a reference to previously decoded data was wrong
40
+/// a reference to previously decoded data was wrong
41 41
 #define AV_LZO_INVALID_BACKPTR 4
42
-//! a non-specific error in the compressed bitstream
42
+/// a non-specific error in the compressed bitstream
43 43
 #define AV_LZO_ERROR 8
44 44
 /** \} */
45 45
 
... ...
@@ -644,7 +644,7 @@ static inline void postProcess(const uint8_t src[], int srcStride, uint8_t dst[]
644 644
 #endif
645 645
             postProcess_C(src, srcStride, dst, dstStride, width, height, QPs, QPStride, isColor, c);
646 646
 #endif
647
-#else //CONFIG_RUNTIME_CPUDETECT
647
+#else /* CONFIG_RUNTIME_CPUDETECT */
648 648
 #if   HAVE_MMX2
649 649
             postProcess_MMX2(src, srcStride, dst, dstStride, width, height, QPs, QPStride, isColor, c);
650 650
 #elif HAVE_AMD3DNOW
... ...
@@ -656,7 +656,7 @@ static inline void postProcess(const uint8_t src[], int srcStride, uint8_t dst[]
656 656
 #else
657 657
             postProcess_C(src, srcStride, dst, dstStride, width, height, QPs, QPStride, isColor, c);
658 658
 #endif
659
-#endif //!CONFIG_RUNTIME_CPUDETECT
659
+#endif /* !CONFIG_RUNTIME_CPUDETECT */
660 660
 }
661 661
 
662 662
 //static void postProcess(uint8_t src[], int srcStride, uint8_t dst[], int dstStride, int width, int height,