[MPlayer-dev-eng] important: doxygen - documenting the source - change of code policy

Attila Kinali attila at kinali.ch
Mon Aug 9 14:43:21 CEST 2004


On Mon, Aug 09, 2004 at 05:04:25PM +0900, Attila Kinali wrote:
> On Mon, Aug 09, 2004 at 03:55:55AM +0200, Michael Niedermayer wrote:
> > allthough the 'all' needs some clarification, we probably wont document most 
> > local variables ...
> 
> All means here all functions and all global variables.
> function internall stuff is some other matter. Beside that doxygen
> doesnt look at function internall comments.

Addendum: This doesnt mean of course that function internals
shouldn't be documented, au contraire, they should. But of course
the usual "document the non-obvious" applies.

			Attila Kinali




More information about the MPlayer-dev-eng mailing list