[FFmpeg-cvslog] r23976 - in trunk: libavcodec/aacdec.c libavcodec/acelp_pitch_delay.h libavcodec/cook.c libavcodec/escape124.c libavcodec/fraps.c libavcodec/lsp.h libavcodec/qdm2.c libavdevice/x11grab.c libavforma...

[Michael Niedermayer]

On Fri, Jul 02, 2010 at 01:19:30PM +0200, diego wrote:
> Author: diego
> Date: Fri Jul  2 13:19:29 2010
> New Revision: 23976
> 
> Log:
> Remove non-existing stray arguments from Doxygen function documentation.
> 
> Modified:
>    trunk/libavcodec/aacdec.c
>    trunk/libavcodec/acelp_pitch_delay.h
>    trunk/libavcodec/cook.c
>    trunk/libavcodec/escape124.c
>    trunk/libavcodec/fraps.c
>    trunk/libavcodec/lsp.h
>    trunk/libavcodec/qdm2.c
>    trunk/libavdevice/x11grab.c
>    trunk/libavformat/rtpdec_asf.h

[...]

> Modified: trunk/libavcodec/escape124.c
> ==============================================================================
> --- trunk/libavcodec/escape124.c	Fri Jul  2 13:13:23 2010	(r23975)
> +++ trunk/libavcodec/escape124.c	Fri Jul  2 13:19:29 2010	(r23976)
> @@ -200,8 +200,6 @@ static const uint16_t mask_matrix[] = {0
>   * @param avctx decoder context
>   * @param data decoded frame
>   * @param data_size size of the decoded frame
> - * @param buf input buffer
> - * @param buf_size input buffer size
>   * @return 0 success, -1 on error
>   */
>  static int escape124_decode_frame(AVCodecContext *avctx,
> 
> Modified: trunk/libavcodec/fraps.c
> ==============================================================================
> --- trunk/libavcodec/fraps.c	Fri Jul  2 13:13:23 2010	(r23975)
> +++ trunk/libavcodec/fraps.c	Fri Jul  2 13:19:29 2010	(r23976)
> @@ -123,8 +123,6 @@ static int fraps2_decode_plane(FrapsCont
>   * @param avctx codec context
>   * @param data output AVFrame
>   * @param data_size size of output data or 0 if no picture is returned
> - * @param buf input data frame
> - * @param buf_size size of input data frame
>   * @return number of consumed bytes on success or negative if decode fails
>   */
>  static int decode_frame(AVCodecContext *avctx,

These parameters have not been removed they have been merged


> 
> Modified: trunk/libavcodec/lsp.h
> ==============================================================================
> --- trunk/libavcodec/lsp.h	Fri Jul  2 13:13:23 2010	(r23975)
> +++ trunk/libavcodec/lsp.h	Fri Jul  2 13:19:29 2010	(r23976)
> @@ -48,7 +48,6 @@ void ff_acelp_reorder_lsf(int16_t* lsfq,
>   *
>   * @param[in,out] lsf    LSFs in Hertz
>   * @param min_spacing    minimum distance between two consecutive lsf values
> - * @param                size size of the lsf vector
>   */
>  void ff_set_min_dist_lsf(float *lsf, double min_spacing, int order);

the implementation looks like this:
void ff_set_min_dist_lsf(float *lsf, double min_spacing, int size)

you clearly didnt bother looking at it.

just because a doxygen comment does not match 1:1 to a parameter does
not mean it should be removed.
The warnings by doxygen are correct and should stay as a reminder that there
is a problem that needs work. Simply removing what caused the warning is
not solving the warning, it hides the problem.
Please revert this commit, it is technically wrong

[...]

-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Thouse who are best at talking, realize last or never when they are wrong.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-cvslog/attachments/20100702/25e1c325/attachment.pgp>