Browse code

Fix doxy that refers to the wrong variable.

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

Michael Niedermayer authored on 2010/07/28 00:54:26
Showing 6 changed files
... ...
@@ -28,18 +28,18 @@
28 28
 #include "cga_data.h"
29 29
 #include <libavutil/lfg.h>
30 30
 
31
-#define ATTR_BOLD         0x01  /** Bold/Bright-foreground (mode 1) */
32
-#define ATTR_FAINT        0x02  /** Faint (mode 2) */
33
-#define ATTR_UNDERLINE    0x08  /** Underline (mode 4) */
34
-#define ATTR_BLINK        0x10  /** Blink/Bright-background (mode 5) */
35
-#define ATTR_REVERSE      0x40  /** Reverse (mode 7) */
36
-#define ATTR_CONCEALED    0x80  /** Concealed (mode 8) */
31
+#define ATTR_BOLD         0x01  /**< Bold/Bright-foreground (mode 1) */
32
+#define ATTR_FAINT        0x02  /**< Faint (mode 2) */
33
+#define ATTR_UNDERLINE    0x08  /**< Underline (mode 4) */
34
+#define ATTR_BLINK        0x10  /**< Blink/Bright-background (mode 5) */
35
+#define ATTR_REVERSE      0x40  /**< Reverse (mode 7) */
36
+#define ATTR_CONCEALED    0x80  /**< Concealed (mode 8) */
37 37
 
38
-#define DEFAULT_FG_COLOR     7  /** CGA color index */
38
+#define DEFAULT_FG_COLOR     7  /**< CGA color index */
39 39
 #define DEFAULT_BG_COLOR     0
40
-#define DEFAULT_SCREEN_MODE  3  /** 80x25 */
40
+#define DEFAULT_SCREEN_MODE  3  /**< 80x25 */
41 41
 
42
-#define FONT_WIDTH           8  /** Font width */
42
+#define FONT_WIDTH           8  /**< Font width */
43 43
 
44 44
 /** map ansi color index to cga palette index */
45 45
 static const uint8_t ansi_to_cga[16] = {
... ...
@@ -48,12 +48,15 @@ static const uint8_t ansi_to_cga[16] = {
48 48
 
49 49
 typedef struct {
50 50
     AVFrame frame;
51
-    int x, y;             /** cursor position (pixels) */
52
-    int sx, sy;           /** saved cursor position (pixels) */
53
-    const uint8_t* font;  /** font */
54
-    int font_height;      /** font height */
55
-    int attributes;       /** attribute flags */
56
-    int fg, bg;           /** foreground and background color */
51
+    int x;                /**< x cursor position (pixels) */
52
+    int y;                /**< y cursor position (pixels) */
53
+    int sx;               /**< saved x cursor position (pixels) */
54
+    int sy;               /**< saved y cursor position (pixels) */
55
+    const uint8_t* font;  /**< font */
56
+    int font_height;      /**< font height */
57
+    int attributes;       /**< attribute flags */
58
+    int fg;               /**< foreground color */
59
+    int bg;               /**< background color */
57 60
 
58 61
     /* ansi parser state machine */
59 62
     enum {
... ...
@@ -64,7 +67,7 @@ typedef struct {
64 64
     } state;
65 65
 #define MAX_NB_ARGS 4
66 66
     int args[MAX_NB_ARGS];
67
-    int nb_args;          /** number of arguments (may exceed MAX_NB_ARGS) */
67
+    int nb_args;          /**< number of arguments (may exceed MAX_NB_ARGS) */
68 68
 } AnsiContext;
69 69
 
70 70
 static av_cold int decode_init(AVCodecContext *avctx)
... ...
@@ -52,27 +52,28 @@ int has_altivec(void);
52 52
  * This stores all the private context for the codec.
53 53
  */
54 54
 struct xvid_context {
55
-    void *encoder_handle;          /** Handle for Xvid encoder */
56
-    int xsize, ysize;              /** Frame size */
57
-    int vop_flags;                 /** VOP flags for Xvid encoder */
58
-    int vol_flags;                 /** VOL flags for Xvid encoder */
59
-    int me_flags;                  /** Motion Estimation flags */
60
-    int qscale;                    /** Do we use constant scale? */
61
-    int quicktime_format;          /** Are we in a QT-based format? */
62
-    AVFrame encoded_picture;       /** Encoded frame information */
63
-    char *twopassbuffer;           /** Character buffer for two-pass */
64
-    char *old_twopassbuffer;       /** Old character buffer (two-pass) */
65
-    char *twopassfile;             /** second pass temp file name */
66
-    unsigned char *intra_matrix;   /** P-Frame Quant Matrix */
67
-    unsigned char *inter_matrix;   /** I-Frame Quant Matrix */
55
+    void *encoder_handle;          /**< Handle for Xvid encoder */
56
+    int xsize;                     /**< Frame x size */
57
+    int ysize;                     /**< Frame y size */
58
+    int vop_flags;                 /**< VOP flags for Xvid encoder */
59
+    int vol_flags;                 /**< VOL flags for Xvid encoder */
60
+    int me_flags;                  /**< Motion Estimation flags */
61
+    int qscale;                    /**< Do we use constant scale? */
62
+    int quicktime_format;          /**< Are we in a QT-based format? */
63
+    AVFrame encoded_picture;       /**< Encoded frame information */
64
+    char *twopassbuffer;           /**< Character buffer for two-pass */
65
+    char *old_twopassbuffer;       /**< Old character buffer (two-pass) */
66
+    char *twopassfile;             /**< second pass temp file name */
67
+    unsigned char *intra_matrix;   /**< P-Frame Quant Matrix */
68
+    unsigned char *inter_matrix;   /**< I-Frame Quant Matrix */
68 69
 };
69 70
 
70 71
 /**
71 72
  * Structure for the private first-pass plugin.
72 73
  */
73 74
 struct xvid_ff_pass1 {
74
-    int     version;                /** Xvid version */
75
-    struct xvid_context *context;        /** Pointer to private context */
75
+    int     version;                /**< Xvid version */
76
+    struct xvid_context *context;   /**< Pointer to private context */
76 77
 };
77 78
 
78 79
 /* Prototypes - See function implementation for details */
... ...
@@ -1168,7 +1168,7 @@ typedef struct Mpeg1Context {
1168 1168
     MpegEncContext mpeg_enc_ctx;
1169 1169
     int mpeg_enc_ctx_allocated; /* true if decoding context allocated */
1170 1170
     int repeat_field; /* true if we must repeat the field */
1171
-    AVPanScan pan_scan; /** some temporary storage for the panscan */
1171
+    AVPanScan pan_scan;              /**< some temporary storage for the panscan */
1172 1172
     int slice_count;
1173 1173
     int swap_uv;//indicate VCR2
1174 1174
     int save_aspect_info;
... ...
@@ -508,11 +508,11 @@ static int decode_subframe_length(WMAProDecodeCtx *s, int offset)
508 508
  */
509 509
 static int decode_tilehdr(WMAProDecodeCtx *s)
510 510
 {
511
-    uint16_t num_samples[WMAPRO_MAX_CHANNELS];        /** sum of samples for all currently known subframes of a channel */
512
-    uint8_t  contains_subframe[WMAPRO_MAX_CHANNELS];  /** flag indicating if a channel contains the current subframe */
513
-    int channels_for_cur_subframe = s->num_channels;  /** number of channels that contain the current subframe */
514
-    int fixed_channel_layout = 0;                     /** flag indicating that all channels use the same subframe offsets and sizes */
515
-    int min_channel_len = 0;                          /** smallest sum of samples (channels with this length will be processed first) */
511
+    uint16_t num_samples[WMAPRO_MAX_CHANNELS];        /**< sum of samples for all currently known subframes of a channel */
512
+    uint8_t  contains_subframe[WMAPRO_MAX_CHANNELS];  /**< flag indicating if a channel contains the current subframe */
513
+    int channels_for_cur_subframe = s->num_channels;  /**< number of channels that contain the current subframe */
514
+    int fixed_channel_layout = 0;                     /**< flag indicating that all channels use the same subframe offsets and sizes */
515
+    int min_channel_len = 0;                          /**< smallest sum of samples (channels with this length will be processed first) */
516 516
     int c;
517 517
 
518 518
     /* Should never consume more than 3073 bits (256 iterations for the
... ...
@@ -34,13 +34,13 @@ typedef struct {
34 34
 } Page;
35 35
 
36 36
 typedef struct {
37
-    unsigned int nb_pages;    /** total pages in file */
38
-    unsigned int nb_records;  /** total records in file */
37
+    unsigned int nb_pages;    /**< total pages in file */
38
+    unsigned int nb_records;  /**< total records in file */
39 39
     int page_table_offset;
40
-#define MAX_PAGES  256        /** Deluxe Paint hardcoded value */
41
-    Page pt[MAX_PAGES];       /** page table */
42
-    int page;                 /** current page (or AVERROR_xxx code) */
43
-    int record;               /** current record (with in page) */
40
+#define MAX_PAGES  256        /**< Deluxe Paint hardcoded value */
41
+    Page pt[MAX_PAGES];       /**< page table */
42
+    int page;                 /**< current page (or AVERROR_xxx code) */
43
+    int record;               /**< current record (with in page) */
44 44
 } AnmDemuxContext;
45 45
 
46 46
 #define LPF_TAG  MKTAG('L','P','F',' ')
... ...
@@ -34,7 +34,7 @@
34 34
 
35 35
 typedef struct {
36 36
     int chars_per_frame;
37
-    uint64_t fsize;  /** file size less metadata buffer */
37
+    uint64_t fsize;  /**< file size less metadata buffer */
38 38
 } TtyDemuxContext;
39 39
 
40 40
 /**