From 671adb174250d6b0fc7a562ac810680a6df155e7 Mon Sep 17 00:00:00 2001
From: Mark Cox <melbournemark+ffmpeg@gmail.com>
Date: Wed, 2 May 2007 09:13:47 +0000
Subject: [PATCH] patch so that the deprecated items show up correctly when
 building doxygen docs patch by mark cox melbournemark plus ffmpeg minus devel
 chez gmail dot com

Originally committed as revision 8866 to svn://svn.ffmpeg.org/ffmpeg/trunk
---
 libavcodec/avcodec.h   | 43 ++++++++++++++++++++++++++++++++++++++++---
 libavcodec/bitstream.c |  2 ++
 libavcodec/eval.h      |  3 +++
 libavformat/avformat.h |  7 +++++--
 libavformat/riff.h     | 20 ++++++++++++++++----
 5 files changed, 66 insertions(+), 9 deletions(-)

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 55a37ca..56ff663 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -2149,7 +2149,9 @@ typedef struct AVPicture {
  * AVPaletteControl
  * This structure defines a method for communicating palette changes
  * between and demuxer and a decoder.
- * This is totally broken, palette changes should be sent as AVPackets.
+ *
+ * @deprecated Use AVPacket to send palette changes instead.
+ * This is totally broken.
  */
 #define AVPALETTE_SIZE 1024
 #define AVPALETTE_COUNT 256
@@ -2464,13 +2466,25 @@ void av_resample_close(struct AVResampleContext *c);
 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
 /* YUV420 format is assumed ! */
 
+/**
+ * @deprecated Use the software scaler (swscale) instead.
+ */
 struct ImgReSampleContext attribute_deprecated;
 
+/**
+ * @deprecated Use the software scaler (swscale) instead.
+ */
 typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
 
+/**
+ * @deprecated Use the software scaler (swscale) instead.
+ */
 attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
                                       int input_width, int input_height);
 
+/**
+ * @deprecated Use the software scaler (swscale) instead.
+ */
 attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
                                       int iwidth, int iheight,
                                       int topBand, int bottomBand,
@@ -2478,10 +2492,15 @@ attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int
                                       int padtop, int padbottom,
                                       int padleft, int padright);
 
-
+/**
+ * @deprecated Use the software scaler (swscale) instead.
+ */
 attribute_deprecated void img_resample(ImgReSampleContext *s,
                   AVPicture *output, const AVPicture *input);
 
+/**
+ * @deprecated Use the software scaler (swscale) instead.
+ */
 attribute_deprecated void img_resample_close(ImgReSampleContext *s);
 
 #endif
@@ -2604,7 +2623,10 @@ int img_get_alpha_info(const AVPicture *src,
                        int pix_fmt, int width, int height);
 
 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
-/* convert among pixel formats */
+/**
+ * convert among pixel formats
+ * @deprecated Use the software scaler (swscale) instead.
+ */
 attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
                 const AVPicture *src, int pix_fmt,
                 int width, int height);
@@ -3046,6 +3068,10 @@ void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
 /**
  * Frees all static arrays and resets their pointers to 0.
  * Call this function to release all statically allocated tables.
+ *
+ * @deprecated. Code which uses av_free_static is broken/missdesigned
+ * and should correctly use static arrays
+ *
  */
 attribute_deprecated void av_free_static(void);
 
@@ -3056,6 +3082,8 @@ attribute_deprecated void av_free_static(void);
  *
  * @param[in] size The amount of memory you need in bytes.
  * @return block of memory of the requested size
+ * @deprecated. Code which uses av_mallocz_static is broken/missdesigned
+ * and should correctly use static arrays
  */
 attribute_deprecated void *av_mallocz_static(unsigned int size);
 
@@ -3078,12 +3106,21 @@ int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width,
             int padtop, int padbottom, int padleft, int padright, int *color);
 
 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
+/**
+ * @deprecated Use the software scaler (swscale) instead.
+ */
 attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
               int pix_fmt, int width, int height);
 
+/**
+ * @deprecated Use the software scaler (swscale) instead.
+ */
 attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
              int pix_fmt, int top_band, int left_band);
 
+/**
+ * @deprecated Use the software scaler (swscale) instead.
+ */
 attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
             int padtop, int padbottom, int padleft, int padright, int *color);
 #endif
diff --git a/libavcodec/bitstream.c b/libavcodec/bitstream.c
index a0c2397..20b5f81 100644
--- a/libavcodec/bitstream.c
+++ b/libavcodec/bitstream.c
@@ -36,6 +36,8 @@
  * @param[in] ptr The block of memory to reallocate.
  * @param[in] size The requested size.
  * @return Block of memory of requested size.
+ * @deprecated. Code which uses ff_realloc_static is broken/missdesigned
+ * and should correctly use static arrays
  */
 attribute_deprecated void *ff_realloc_static(void *ptr, unsigned int size);
 
diff --git a/libavcodec/eval.h b/libavcodec/eval.h
index b52199c..71993c5 100644
--- a/libavcodec/eval.h
+++ b/libavcodec/eval.h
@@ -29,6 +29,9 @@
 #define AVCODEC_EVAL_H
 
 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
+/**
+ * @deprecated Use ff_eval2 instead
+ */
 double ff_eval(char *s, double *const_value, const char **const_name,
                double (**func1)(void *, double), const char **func1_name,
                double (**func2)(void *, double, double), char **func2_name,
diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 2c8f8e9..1e8028c 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -111,8 +111,11 @@ static inline void av_free_packet(AVPacket *pkt)
 /*************************************************/
 /* fractional numbers for exact pts handling */
 
-/* the exact value of the fractional number is: 'val + num / den'. num
-   is assumed to be such as 0 <= num < den */
+/**
+ * the exact value of the fractional number is: 'val + num / den'.
+ * num is assumed to be such as 0 <= num < den
+ * @deprecated Use AVRational instead
+*/
 typedef struct AVFrac {
     int64_t val, num, den;
 } AVFrac attribute_deprecated;
diff --git a/libavformat/riff.h b/libavformat/riff.h
index 45c72dd..cd2b85d 100644
--- a/libavformat/riff.h
+++ b/libavformat/riff.h
@@ -46,10 +46,22 @@ extern const AVCodecTag codec_wav_tags[];
 
 unsigned int codec_get_tag(const AVCodecTag *tags, int id);
 enum CodecID codec_get_id(const AVCodecTag *tags, unsigned int tag);
-unsigned int codec_get_bmp_tag(int id) attribute_deprecated; //use av_codec_get_tag
-unsigned int codec_get_wav_tag(int id) attribute_deprecated; //use av_codec_get_tag
-enum CodecID codec_get_bmp_id(unsigned int tag) attribute_deprecated; //use av_codec_get_id
-enum CodecID codec_get_wav_id(unsigned int tag) attribute_deprecated; //use av_codec_get_id
+/**
+ * @deprecated Use av_codec_get_tag instead.
+ */
+unsigned int codec_get_bmp_tag(int id) attribute_deprecated;
+/**
+ * @deprecated Use av_codec_get_tag instead.
+ */
+unsigned int codec_get_wav_tag(int id) attribute_deprecated;
+/**
+ * @deprecated Use av_codec_get_id instead.
+ */
+enum CodecID codec_get_bmp_id(unsigned int tag) attribute_deprecated;
+/**
+ * @deprecated Use av_codec_get_id instead.
+ */
+enum CodecID codec_get_wav_id(unsigned int tag) attribute_deprecated;
 void ff_parse_specific_params(AVCodecContext *stream, int *au_rate, int *au_ssize, int *au_scale);
 
 #endif
-- 
2.7.4