Fix doxy that refers to the wrong variable.
authorMichael Niedermayer <michaelni@gmx.at>
Tue, 27 Jul 2010 15:54:26 +0000 (15:54 +0000)
committerMichael Niedermayer <michaelni@gmx.at>
Tue, 27 Jul 2010 15:54:26 +0000 (15:54 +0000)
Originally committed as revision 24549 to svn://svn.ffmpeg.org/ffmpeg/trunk

libavcodec/ansi.c
libavcodec/libxvidff.c
libavcodec/mpeg12.c
libavcodec/wmaprodec.c
libavformat/anm.c
libavformat/tty.c

index 6fa62cc..cec9cb1 100644 (file)
 #include "cga_data.h"
 #include <libavutil/lfg.h>
 
-#define ATTR_BOLD         0x01  /** Bold/Bright-foreground (mode 1) */
-#define ATTR_FAINT        0x02  /** Faint (mode 2) */
-#define ATTR_UNDERLINE    0x08  /** Underline (mode 4) */
-#define ATTR_BLINK        0x10  /** Blink/Bright-background (mode 5) */
-#define ATTR_REVERSE      0x40  /** Reverse (mode 7) */
-#define ATTR_CONCEALED    0x80  /** Concealed (mode 8) */
+#define ATTR_BOLD         0x01  /**< Bold/Bright-foreground (mode 1) */
+#define ATTR_FAINT        0x02  /**< Faint (mode 2) */
+#define ATTR_UNDERLINE    0x08  /**< Underline (mode 4) */
+#define ATTR_BLINK        0x10  /**< Blink/Bright-background (mode 5) */
+#define ATTR_REVERSE      0x40  /**< Reverse (mode 7) */
+#define ATTR_CONCEALED    0x80  /**< Concealed (mode 8) */
 
-#define DEFAULT_FG_COLOR     7  /** CGA color index */
+#define DEFAULT_FG_COLOR     7  /**< CGA color index */
 #define DEFAULT_BG_COLOR     0
-#define DEFAULT_SCREEN_MODE  3  /** 80x25 */
+#define DEFAULT_SCREEN_MODE  3  /**< 80x25 */
 
-#define FONT_WIDTH           8  /** Font width */
+#define FONT_WIDTH           8  /**< Font width */
 
 /** map ansi color index to cga palette index */
 static const uint8_t ansi_to_cga[16] = {
@@ -48,12 +48,15 @@ static const uint8_t ansi_to_cga[16] = {
 
 typedef struct {
     AVFrame frame;
-    int x, y;             /** cursor position (pixels) */
-    int sx, sy;           /** saved cursor position (pixels) */
-    const uint8_t* font;  /** font */
-    int font_height;      /** font height */
-    int attributes;       /** attribute flags */
-    int fg, bg;           /** foreground and background color */
+    int x;                /**< x cursor position (pixels) */
+    int y;                /**< y cursor position (pixels) */
+    int sx;               /**< saved x cursor position (pixels) */
+    int sy;               /**< saved y cursor position (pixels) */
+    const uint8_t* font;  /**< font */
+    int font_height;      /**< font height */
+    int attributes;       /**< attribute flags */
+    int fg;               /**< foreground color */
+    int bg;               /**< background color */
 
     /* ansi parser state machine */
     enum {
@@ -64,7 +67,7 @@ typedef struct {
     } state;
 #define MAX_NB_ARGS 4
     int args[MAX_NB_ARGS];
-    int nb_args;          /** number of arguments (may exceed MAX_NB_ARGS) */
+    int nb_args;          /**< number of arguments (may exceed MAX_NB_ARGS) */
 } AnsiContext;
 
 static av_cold int decode_init(AVCodecContext *avctx)
index 140848f..37f6161 100644 (file)
@@ -52,27 +52,28 @@ int has_altivec(void);
  * This stores all the private context for the codec.
  */
 struct xvid_context {
-    void *encoder_handle;          /** Handle for Xvid encoder */
-    int xsize, ysize;              /** Frame size */
-    int vop_flags;                 /** VOP flags for Xvid encoder */
-    int vol_flags;                 /** VOL flags for Xvid encoder */
-    int me_flags;                  /** Motion Estimation flags */
-    int qscale;                    /** Do we use constant scale? */
-    int quicktime_format;          /** Are we in a QT-based format? */
-    AVFrame encoded_picture;       /** Encoded frame information */
-    char *twopassbuffer;           /** Character buffer for two-pass */
-    char *old_twopassbuffer;       /** Old character buffer (two-pass) */
-    char *twopassfile;             /** second pass temp file name */
-    unsigned char *intra_matrix;   /** P-Frame Quant Matrix */
-    unsigned char *inter_matrix;   /** I-Frame Quant Matrix */
+    void *encoder_handle;          /**< Handle for Xvid encoder */
+    int xsize;                     /**< Frame x size */
+    int ysize;                     /**< Frame y size */
+    int vop_flags;                 /**< VOP flags for Xvid encoder */
+    int vol_flags;                 /**< VOL flags for Xvid encoder */
+    int me_flags;                  /**< Motion Estimation flags */
+    int qscale;                    /**< Do we use constant scale? */
+    int quicktime_format;          /**< Are we in a QT-based format? */
+    AVFrame encoded_picture;       /**< Encoded frame information */
+    char *twopassbuffer;           /**< Character buffer for two-pass */
+    char *old_twopassbuffer;       /**< Old character buffer (two-pass) */
+    char *twopassfile;             /**< second pass temp file name */
+    unsigned char *intra_matrix;   /**< P-Frame Quant Matrix */
+    unsigned char *inter_matrix;   /**< I-Frame Quant Matrix */
 };
 
 /**
  * Structure for the private first-pass plugin.
  */
 struct xvid_ff_pass1 {
-    int     version;                /** Xvid version */
-    struct xvid_context *context;        /** Pointer to private context */
+    int     version;                /**< Xvid version */
+    struct xvid_context *context;   /**< Pointer to private context */
 };
 
 /* Prototypes - See function implementation for details */
index 0af24ad..6a331eb 100644 (file)
@@ -1168,7 +1168,7 @@ typedef struct Mpeg1Context {
     MpegEncContext mpeg_enc_ctx;
     int mpeg_enc_ctx_allocated; /* true if decoding context allocated */
     int repeat_field; /* true if we must repeat the field */
-    AVPanScan pan_scan; /** some temporary storage for the panscan */
+    AVPanScan pan_scan;              /**< some temporary storage for the panscan */
     int slice_count;
     int swap_uv;//indicate VCR2
     int save_aspect_info;
index 3eca101..8c43e46 100644 (file)
@@ -508,11 +508,11 @@ static int decode_subframe_length(WMAProDecodeCtx *s, int offset)
  */
 static int decode_tilehdr(WMAProDecodeCtx *s)
 {
-    uint16_t num_samples[WMAPRO_MAX_CHANNELS];        /** sum of samples for all currently known subframes of a channel */
-    uint8_t  contains_subframe[WMAPRO_MAX_CHANNELS];  /** flag indicating if a channel contains the current subframe */
-    int channels_for_cur_subframe = s->num_channels;  /** number of channels that contain the current subframe */
-    int fixed_channel_layout = 0;                     /** flag indicating that all channels use the same subframe offsets and sizes */
-    int min_channel_len = 0;                          /** smallest sum of samples (channels with this length will be processed first) */
+    uint16_t num_samples[WMAPRO_MAX_CHANNELS];        /**< sum of samples for all currently known subframes of a channel */
+    uint8_t  contains_subframe[WMAPRO_MAX_CHANNELS];  /**< flag indicating if a channel contains the current subframe */
+    int channels_for_cur_subframe = s->num_channels;  /**< number of channels that contain the current subframe */
+    int fixed_channel_layout = 0;                     /**< flag indicating that all channels use the same subframe offsets and sizes */
+    int min_channel_len = 0;                          /**< smallest sum of samples (channels with this length will be processed first) */
     int c;
 
     /* Should never consume more than 3073 bits (256 iterations for the
index ba77e18..82430e5 100644 (file)
@@ -34,13 +34,13 @@ typedef struct {
 } Page;
 
 typedef struct {
-    unsigned int nb_pages;    /** total pages in file */
-    unsigned int nb_records;  /** total records in file */
+    unsigned int nb_pages;    /**< total pages in file */
+    unsigned int nb_records;  /**< total records in file */
     int page_table_offset;
-#define MAX_PAGES  256        /** Deluxe Paint hardcoded value */
-    Page pt[MAX_PAGES];       /** page table */
-    int page;                 /** current page (or AVERROR_xxx code) */
-    int record;               /** current record (with in page) */
+#define MAX_PAGES  256        /**< Deluxe Paint hardcoded value */
+    Page pt[MAX_PAGES];       /**< page table */
+    int page;                 /**< current page (or AVERROR_xxx code) */
+    int record;               /**< current record (with in page) */
 } AnmDemuxContext;
 
 #define LPF_TAG  MKTAG('L','P','F',' ')
index 9a40fec..e4ed22d 100644 (file)
@@ -34,7 +34,7 @@
 
 typedef struct {
     int chars_per_frame;
-    uint64_t fsize;  /** file size less metadata buffer */
+    uint64_t fsize;  /**< file size less metadata buffer */
 } TtyDemuxContext;
 
 /**