[Ffmpeg-devel] [PATCH] video4linux2 input

Diego Biurrun diego
Wed Feb 1 12:35:38 CET 2006

On Wed, Feb 01, 2006 at 12:25:06PM +0100, Michael Niedermayer wrote:
> On Wed, Feb 01, 2006 at 12:20:33PM +0100, Luca Abeni wrote:
> > 
> > On Wed, 2006-02-01 at 11:43 +0100, Diego Biurrun wrote:
> > [...]
> > > BTW, it would be nice if you could add a few doxygen comments to the
> > > code.
> > Well, I was under impression that only exported functions (which are
> > part of the av{codec,format,util}.h interface) need doxygen comments.
> > 
> > If my understanding is wrong, let me know and I'll send a patch for
> > v4l2.c introducing doxygen comments.

This was a general remark.  I just thought your code was not especially
heavy on comments, not that FFmpeg is loaded with comments in general...

> (doxygen) comments are always good if looking at the function/loop/... for
> a minute isnt enough to understand it, and they are often bad if the code 
> is trivial anyway (its like adding whitespace or random junk which makes
> reading harder, allthough it gives the impression to some people the code
> becomes more understandable, its like 5min to understand 1 line vs. 5min
> to understand 1 page of code but both do the same thing, later gives the
> impression of being easier to understand ...)

Please don't forget that not everybody has your coding skills.  Lesser
coders might profit more from a few explanatory comments.


More information about the ffmpeg-devel mailing list