[Ffmpeg-devel] [PATCH 01/31] Doxygenize existing comments

[Michael Niedermayer]

Hi

On Sun, Mar 04, 2007 at 11:51:16PM +0100, Panagiotis Issaris wrote:
> Hi,
> 
> Michael Niedermayer schreef:
> >On Sun, Mar 04, 2007 at 11:11:26PM +0100, takis.issaris at uhasselt.be wrote:
> >  
> >>Doxygenize the existing comments in avformat.h. The contents of the 
> >>comment was
> >>left unaltered.
> >>    
> >
> >patch ok
> >comments unrelated to the doxygenization but rather related to the
> >comments/doxy are below
> >  
> 
> So, it is okay to apply the patch without the fixes to the content only 
> adding the one comment I forgot to doxygenize?
> And, of course fix the remarks below in follow-up patches?

yes


[...]
> >
> >[...]
> >  
> >>     int flags;
> >>-    /* currently only used to set pixel format if not YUV420P */
> >>+    /** currently only used to set pixel format if not YUV420P */
> >>     int (*set_parameters)(struct AVFormatContext *, AVFormatParameters 
> >>     *);
> >>    
> >
> >this is wrong i think
> >  
> Okay to just remove the entire comment?

thats the simple solution ...
complex one is RTFS and write a correct comment, but its much better to
have none than a wrong one


> 
> >[...]
> >  
> >>     /* ffmpeg.c private use */
> >>-    int stream_copy; /* if TRUE, just copy stream */
> >>+    int stream_copy; /* *<if TRUE, just copy stream */
> >>    
> >
> >TRUE? this isnt C++
> >  
> "if greater then zero, just copy stream */
> or
> "if >0, just copy stream */

if 1 .. or if not zero ... or if set ...


[...]
-- 
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: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20070305/dbb0a385/attachment.pgp>