[mythtv] first contribution

[Nigel Pearson]

> Shall I  add them to the .h files (as I'm used to doing) or into  
> the .cpp file
> (as I saw once or twice while I was looking through the code)?

If it is a base class, definitely in the header.
That way, the derived classes use the same doco.


Otherwise? I prefer it in the .cpp,
but the "official" coding standards
http://www.mythtv.org/wiki/index.php/Coding_Standards
say "The majority of your comments should be in header files"


Only other thing is that I don't think including the
method signature (e.g. \fn) is helpful. It just adds
extra maintenance, and Doxygen can parse the method
declaration itself (except in multi-method comment blocks)

See http://svn.mythtv.org/trac/ticket/2511

--
Nigel Pearson, nigel at ind.tansu.com.au|"In this city I confess;
Telstra Net. Eng., Sydney, Australia | god is mammon, more is less.
Office: 9202 3900    Fax:  9261 3912 | Off like lemmings at the gun!
Mobile: 0408 664435  Home: 9792 6998 | I know better, still I run"