[Ffmpeg-devel] doxygen compatible @deprecated tag

[Michael Niedermayer]

Hi

On Mon, Apr 23, 2007 at 01:28:32PM +1000, mark cox wrote:
> This is a preliminary version of a patch so that the deprecated items show
> up correctly when building doxygen docs.
> Any comments on the correct explanatons, if not i will go through them
> one-by-one to see what the alternative fn is.

[...]

> +/*

/**


> + * @deprecated Use ... instead
> +*/
>  attribute_deprecated double ff_eval(char *s, double *const_value, const char **const_name,

ff_eval2()


>                 double (**func1)(void *, double), const char **func1_name,
>                 double (**func2)(void *, double, double), char **func2_name,
> Index: libavcodec/avcodec.h
> ===================================================================
> --- libavcodec/avcodec.h	(revision 8792)
> +++ libavcodec/avcodec.h	(working copy)
> @@ -2148,6 +2148,8 @@
>   * AVPaletteControl
>   * This structure defines a method for communicating palette changes
>   * between and demuxer and a decoder.
> + *
> + * @deprecated Use AvPackets for palette changes instead.

AVPacket


>   * This is totally broken, palette changes should be sent as AVPackets.
>   */
>  #define AVPALETTE_SIZE 1024
> @@ -2462,13 +2464,25 @@
>  #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
>  /* YUV420 format is assumed ! */
>  
> +/*

/**
(and there are more of these)


> + * @deprecated Use ... instead.
> + */
>  struct ImgReSampleContext attribute_deprecated;
>  
> +/*
> + * @deprecated Use ... instead.
> + */
>  typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
>  
> +/*
> + * @deprecated Use ... instead.
> + */
>  attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
>                                        int input_width, int input_height);
>  
> +/*
> + * @deprecated Use ... instead.
> + */
>  attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
>                                        int iwidth, int iheight,
>                                        int topBand, int bottomBand,
> @@ -2476,10 +2490,15 @@
>                                        int padtop, int padbottom,
>                                        int padleft, int padright);
>  
> -
> +/*
> + * @deprecated Use ... instead.
> + */
>  attribute_deprecated void img_resample(ImgReSampleContext *s,
>                    AVPicture *output, const AVPicture *input);
>  
> +/*
> + * @deprecated Use ... instead.
> + */
>  attribute_deprecated void img_resample_close(ImgReSampleContext *s);
>  
>  #endif
> @@ -2603,6 +2622,9 @@
>  
>  #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
>  /* convert among pixel formats */
> +/*
> + * @deprecated Use ... instead.
> + */
>  attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
>                  const AVPicture *src, int pix_fmt,
>                  int width, int height);

all these are replaced by the swscaler




> @@ -3044,6 +3066,8 @@
>  /**
>   * Frees all static arrays and resets their pointers to 0.
>   * Call this function to release all statically allocated tables.
> + *
> + * @deprecated Use ... instead.
>   */
>  attribute_deprecated void av_free_static(void);
>  
> @@ -3054,6 +3078,7 @@
>   *
>   * @param[in] size The amount of memory you need in bytes.
>   * @return block of memory of the requested size
> + * @deprecated Use ... instead.
>   */
>  attribute_deprecated void *av_mallocz_static(unsigned int size);
>  

[...]

> Index: libavcodec/bitstream.c
> ===================================================================
> --- libavcodec/bitstream.c	(revision 8792)
> +++ libavcodec/bitstream.c	(working copy)
> @@ -36,7 +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 Use ... instead
> +*/

wrong indention


>  attribute_deprecated void *ff_realloc_static(void *ptr, unsigned int size);

there are no replacements for the above 3 functions, code which uses
them is broken/missdesigned and should correctly use static arrays

[...]

-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

I do not agree with what you have to say, but I'll defend to the death your
right to say it. -- Voltaire
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20070423/2dba90f3/attachment.pgp>