[FFmpeg-cvslog] r18700 - trunk/libavcodec/avcodec.h

[Vitor Sessak]

michael wrote:
> Author: michael
> Date: Mon Apr 27 14:28:56 2009
> New Revision: 18700
> 
> Log:
> Remove documentation from deprecated fields, they should not be used,
> thus there is no sense in documenting them.

[...]

> Modified: trunk/libavcodec/avcodec.h
> ==============================================================================
> --- trunk/libavcodec/avcodec.h	Mon Apr 27 14:25:36 2009	(r18699)
> +++ trunk/libavcodec/avcodec.h	Mon Apr 27 14:28:56 2009	(r18700)
> @@ -1121,9 +1121,6 @@ typedef struct AVCodecContext {
>      int b_frame_strategy;
>  
>      /**
> -     * hurry up amount
> -     * - encoding: unused
> -     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
>       * @deprecated Deprecated in favor of skip_idct and skip_frame.
>       */
>      int hurry_up;

I don't think it really improves the situation. Imagine someone that 
maintains the following third-party piece of code:

ctx->hurry_up = 1;

How is he supposed to know that he can replaces it by ctx->skip_idct=1 
if he has no documentation of what it was supposed to do? People have a 
tendency of not touching code they do/can not understand...

-Vitor