[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...
Fri Jul 2 14:31:49 CEST 2010
On Fri, Jul 02, 2010 at 02:04:11PM +0200, Michael Niedermayer wrote:
> On Fri, Jul 02, 2010 at 01:19:30PM +0200, diego wrote:
> > Log:
> > Remove non-existing stray arguments from Doxygen function documentation.
> > --- 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)
> 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.
You clearly have not bothered looking at Doxygen output. Doxygen warns
about undocumented parameters, nothing has been hidden.
More information about the ffmpeg-cvslog