Tor Didriksen wrote:
> hi
>
>
> "function and method comments should be placed in front of
> implementation rather than declaration"
>
> I find it quite strange that member functions should be documented in
> the .cc file rather than the .h file, especially if these are public
> member functions (part of the public interface of the class).
I also find this strange. API documentation should be with the
declaration, not definition. This is how Drizzle does things, and also
how a good chunk of the MySQL code base does things...
Implementation-specific documentation should go in the source files (cc
files). For instance, details of an algorithm or *why* a structure is
the way it is. But, simple descriptions of an API's methods and
structures, IMHO, should go in the header files next to the declaration,
not definition/implementation.
Cheers,
Jay
