[FFmpeg-cvslog] r23983 - trunk/libavcodec/h264.c

[Michael Niedermayer]

On Thu, Jul 08, 2010 at 04:44:31PM +0100, M?ns Rullg?rd wrote:
> Michael Niedermayer <michaelni at gmx.at> writes:
> 
> > On Thu, Jul 08, 2010 at 09:55:33AM -0400, Ronald S. Bultje wrote:
> >> Hi,
> >> 
> >> On Fri, Jul 2, 2010 at 8:35 AM, Michael Niedermayer <michaelni at gmx.at> wrote:
> >> > On Fri, Jul 02, 2010 at 01:54:34PM +0200, diego wrote:
> >> >> Author: diego
> >> >> Date: Fri Jul ?2 13:54:34 2010
> >> >> New Revision: 23983
> >> >>
> >> >> Log:
> >> >> Fix typo in Doxygen function parameter name.
> >> >>
> >> >> Modified:
> >> >> ? ?trunk/libavcodec/h264.c
> >> >>
> >> >> Modified: trunk/libavcodec/h264.c
> >> >> ==============================================================================
> >> >> --- trunk/libavcodec/h264.c ? Fri Jul ?2 13:53:00 2010 ? ? ? ?(r23982)
> >> >> +++ trunk/libavcodec/h264.c ? Fri Jul ?2 13:54:34 2010 ? ? ? ?(r23983)
> >> >> @@ -1428,7 +1428,7 @@ static int pred_weight_table(H264Context
> >> >>
> >> >> ?/**
> >> >> ? * Initialize implicit_weight table.
> >> >> - * @param field, 0/1 initialize the weight for interlaced MBAFF
> >> >> + * @param field ?0/1 initialize the weight for interlaced MBAFF
> >> >> ? * ? ? ? ? ? ? ? ?-1 initializes the rest
> >> >> ? */
> >> >
> >> > Please refrain from making changes to code documentation without the
> >> > C developers checking them first.
> >> 
> >> Some other comments might have been a little quick and should be
> >> reverted+discussed, but I think this change is correct. I'd leave this
> >> particular one in.
> >
> > hmm, i thought that is dead obvious
> >
> > the parameter field is described by
> >
> > field, 0/1 initialize the weight for interlaced MBAFF -1 initializes the rest
> > not
> > 0/1 initialize the weight for interlaced MBAFF -1 initializes the rest
> >
> > that looks a bit odd in doxygen syntax
> > @param field field, 0/1 initialize the weight for interlaced MBAFF
> >
> > but thats how it was meant imho
> 
> That doesn't make sense to me.

lets assume the variable was named var0 instead of field
what was written there was:
@param field, 0/1 initialize the weight for interlaced MBAFF -1 initializes the rest

what should have been written there (in that case) would have been:
@param var0 field, 0/1 initialize the weight for interlaced MBAFF -1 initializes the rest


[...]
-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

No snowflake in an avalanche ever feels responsible. -- Voltaire
-------------- 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/20100708/c98ae2dd/attachment.pgp>