On Jul 31, 2008, at 12:17 PM, Mats Kindahl wrote:
I would suggest placing documentation for an object or function with
the
*definition* of the function, class, or other entity. This means that
documentation for classes go with the class definition in the header
file (as you suggest) and documentation for functions go with the
definition of the function, which is usually in the implementation
file.
In my mind, the .c/.cc file is king, and the .h is a mere derivative.
If we want to embed API information for the function in the H file, we
can have the machine do some copying & pasting into the .h for us as
part of a make process. This is how we do it over on Parrot.
xoa
--
Andy Lester => [EMAIL PROTECTED] => www.petdance.com => AIM:petdance
_______________________________________________
Mailing list: https://launchpad.net/~drizzle-discuss
Post to : [email protected]
Unsubscribe : https://launchpad.net/~drizzle-discuss
More help : https://help.launchpad.net/ListHelp
