[FFmpeg-cvslog] r23970 - in trunk: libavcodec/atrac3.c libavcodec/cook.c libavcodec/elbg.c libavcodec/lzw.c libavcodec/mpegvideo.c libavcodec/mpegvideo_common.h libavcodec/rl2.c libavcodec/rle.h libavfilter/avfilt...

[Diego Biurrun]

On Thu, Jul 08, 2010 at 01:34:18PM +0100, M?ns Rullg?rd wrote:
> Diego Biurrun <diego at biurrun.de> writes:
> 
> > On Fri, Jul 02, 2010 at 02:13:12PM +0200, Michael Niedermayer wrote:
> >> On Fri, Jul 02, 2010 at 12:49:29PM +0200, diego wrote:
> >> > 
> >> > Log:
> >> > Fix misspelled parameter names in Doxygen documentation.
> >> > This fixes one Doxygen warning each.
> >> > 
> >> > --- trunk/libavcodec/atrac3.c	Fri Jul  2 12:37:13 2010	(r23969)
> >> > +++ trunk/libavcodec/atrac3.c	Fri Jul  2 12:49:29 2010	(r23970)
> >> > @@ -166,9 +166,9 @@ static void IMLT(float *pInput, float *p
> >> >  /**
> >> >   * Atrac 3 indata descrambling, only used for data coming from the rm container
> >> >   *
> >> > - * @param in        pointer to 8 bit array of indata
> >> > - * @param bits      amount of bits
> >> > + * @param inbuffer  pointer to 8 bit array of indata
> >> >   * @param out       pointer to 8 bit array of outdata
> >> > + * @param bytes     amount of bytes
> >> >   */
> >> >  
> >> > --- trunk/libavcodec/cook.c	Fri Jul  2 12:37:13 2010	(r23969)
> >> > +++ trunk/libavcodec/cook.c	Fri Jul  2 12:49:29 2010	(r23970)
> >> > @@ -708,7 +708,7 @@ static void interpolate_float(COOKContex
> >> >   *
> >> >   * @param q                 pointer to the COOKContext
> >> > - * @param inbuffer          pointer to the mltcoefficients
> >> > + * @param buffer1           pointer to the mltcoefficients
> >> >   * @param gains_ptr         current and previous gains
> >> >   * @param previous_buffer   pointer to the previous buffer to be used for overlapping
> >> >   */
> >> 
> >> > @@ -877,7 +877,7 @@ static void joint_decode(COOKContext *q,
> >> >   *
> >> >   * @param q                 pointer to the COOKContext
> >> >   * @param inbuffer          pointer to raw stream data
> >> > - * @param gain_ptr          array of current/prev gain pointers
> >> > + * @param gains_ptr         array of current/prev gain pointers
> >> >   */
> >> >  
> >> > @@ -923,7 +923,7 @@ saturate_output_float (COOKContext *q, i
> >> >   *
> >> >   * @param q                 pointer to the COOKContext
> >> >   * @param decode_buffer     pointer to the mlt coefficients
> >> > - * @param gain_ptr          array of current/prev gain pointers
> >> > + * @param gains             array of current/prev gain pointers
> >> >   * @param previous_buffer   pointer to the previous buffer to be used for overlapping
> >> >   * @param out               pointer to the output buffer
> >> >   * @param chan              0: left or single channel, 1: right channel
> >> 
> >> this change is not good.
> >> its the code that should be changed so that the gain pointer array uses
> >> a consistent name not the consistent doxy to inconsistency.
> >> please correct this!
> >
> > I'm not sure I understand your sentence the way you intended to write
> > it, but I cannot see any consistent Doxygen comments being made
> > inconsistent.
> 
> I think what he means is the parameter names in the old comments were
> more descriptive than what the code used.  It would have been better
> to rename the params in the code instead of changing the comments.

If at all, I can only see this being the case for the inbuffer --> buffer1
change.  I consider this a task for the file's maintainer, i.e. Benjamin,
but here is a patch to accomplish it anyway...

Diego
-------------- next part --------------
A non-text attachment was scrubbed...
Name: cook.diff
Type: text/x-diff
Size: 1501 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-cvslog/attachments/20100708/1a4da2dd/attachment-0001.diff>