[MPlayer-dev-eng] [PATCH]VO_VDPAU, round 2

Benjamin Zores ben at geexbox.org
Tue Jan 6 20:25:32 CET 2009

Reimar Döffinger wrote:
> On Tue, Jan 06, 2009 at 09:31:07AM +0100, Benjamin Zores wrote:
>> I could only second that. Doxygen definitely is useless but for a library imho.
> I forces at least a consistent style for documentation and it enforces
> a minimum amount of documentation.
> Obviously for functions that are part of the API documentation should
> not be duplicated, duplicated documentation is not that much better than
> duplicated code.

I'd agree on header files like libvo.h but doxygen on .c is pointless.

>> Efforts should be done on code, not on cosmetics, for once.
> You assume that that saved effort would actually go into code.
> Also messed up indentation makes me loose interest in review very
> quickly, do you intend to review it and put effort into the code?

Sorry for that, I didn't meant indentation speaking about cosmetics but 
more about the comment stuff.

If it's to end up with something like that:

  * \var1 Surely a useful variable
  * \var2 Probably another one
  * \brief Display picture
  * \return A status code
int display_picture (int var1, int var2) {

   /* return success */
   return 0;

then I'm sorry but it's a waste of time.
It's better using meaningful variable and function names than
spaming code with useless doc/comments.

Comments are only there to explain why someone did something the way he 
did, not to describe the code.


More information about the MPlayer-dev-eng mailing list