[Ffmpeg-devel] [PATCH] video4linux2 input

Luca Abeni lucabe72
Wed Feb 1 16:02:01 CET 2006

Hi all,

On Wed, 2006-02-01 at 12:35 +0100, Diego Biurrun wrote:
> > (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.
So, should I send a patch adding doxygen comments, or not?
I did not initially wrote comments because reading v4l2.c all the code
looks obvious to me[1] (and in my opinion the function names are
intuitive enough), but I am the one who wrote the code so I am
biased ;-)

Anyway, if the general consensus is that comments will be useful
(without adding useless bloat to trivial code), just tell me and I'll
provide the needed patch.


[1] See the "Structured Programming" section in "Real Programmers Don't
Copy this in your signature, if you think it is important:
                               N O    W A R ! ! !

 Email.it, the professional e-mail, gratis per te: http://www.email.it/f
 L'auto dei tuoi sogni? Findomestic ti offre finanziamenti chiari e semplici senza anticipi!
 Clicca qui: http://adv.email.it/cgi-bin/foclick.cgi?mid=3940&d=1-2

More information about the ffmpeg-devel mailing list