[MPlayer-dev-eng] [PATCH] SSA/ASS subtitles support

[Reimar Döffinger]

Hi,
On Wed, Apr 19, 2006 at 10:38:21PM +0300, Uoti Urpala wrote:
> On Wed, 2006-04-19 at 15:59 +0200, Reimar Döffinger wrote:
> > Code should be documentated as described in
> > DOCS/tech/code-documentation.txt, i.e. doxygen comments at least for
> > every global function/variable, and IMHO also for local (i.e. "static"
> > functions.
> 
> That file claims there should be comments for "every function, no matter
> whether it is globally or just locally used". No code in MPlayer really

I think most of the code I added follows it except the standard function
where the documentation would be the same for all files.
But it reminds me, I think I forgot to do it for demux_mpc.c

> follows that, nor should it IMO (commenting obvious things is just
> clutter, more likely to cause confusion as the code in question changes
> than to help).

Commenting in one line what a function does and a single line for every
parameter and the return value should be possible with almost every
function without stating anything obvious.
Do you know how often I had to read lots of code just to find out if a
return value of 0, 1, or -1 means there was an error? A single line can
save a lot of effort.

Greetings,
Reimar Döffinger