[FFmpeg-cvslog] r23977 - trunk/libavcodec/rl2.c

[Michael Niedermayer]

On Thu, Jul 08, 2010 at 03:28:23PM +0200, Diego Biurrun wrote:
> On Fri, Jul 02, 2010 at 02:15:46PM +0200, Michael Niedermayer wrote:
> > On Fri, Jul 02, 2010 at 01:37:54PM +0200, diego wrote:
> > > 
> > > Log:
> > > Remove two more non-existing stray Doxygen function arguments.
> > 
> > wrong as well
> 
> Yes, there is still a bug, one function parameter remains undocumented.
> Doxygen generates the following warning for it:
> 
> /usr/src/ffmpeg/trunk/libavcodec/rl2.c:172: Warning: The following parameters of rl2_decode_frame(AVCodecContext *avctx, void *data, int *data_size, AVPacket *avpkt) are not documented:
>   parameter 'avpkt'
> 
> I removed the documentation for two paramaters which no longer exist
> in the code, and this change is correct.  Documenting the remaining
> parameter is a separate issue.

no, its not seperate, the 2 parameters where merged into avpkt.
the corresponding change for the doxy is to merge them too, not to remove
them and wait for someone else to fix it up

you can just revert the change or fix it properly but spliting a move
or merge into a remove you do and add you dont do is not ok

the warnings where showing a problem, that is a forgotten update of the
doxy after a change to the code. Your change does not correct this problem
it is thus per definition not a solution for this problem.

When a warning indicates a problem then this problem must be solved and
until this is done the warning must stay.

When a warning does not indicate a problem the warning must be removed with
a minimum of negative sideefects.

[...]

-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Many that live deserve death. And some that die deserve life. Can you give
it to them? Then do not be too eager to deal out death in judgement. For
even the very wise cannot see all ends. -- Gandalf
-------------- 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/6d52bfee/attachment.pgp>