Andy Lester wrote: > > 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.
Well... if you have the definition of the function in the header file, there is no place to put the documentation for the function in the .c/.cc file. I'm not questioning your rule (which is good), just pointing out that, AFAICT, what you describe follow the rule "put the documentation with the definition". Just my few cents, Mats Kindahl > > xoa > > -- > Andy Lester => [EMAIL PROTECTED] => www.petdance.com => AIM:petdance > > > > -- Mats Kindahl Lead Software Developer Replication Team MySQL AB, www.mysql.com
begin:vcard fn:Mats Kindahl n:Kindahl;Mats org:Sun Microsystems adr;quoted-printable:;;Tegv=C3=A4gen 3;Storvreta;SE;74334;Sweden email;internet:[EMAIL PROTECTED] title:Lead Replication Software Developer x-mozilla-html:FALSE version:2.1 end:vcard
_______________________________________________ Mailing list: https://launchpad.net/~drizzle-discuss Post to : [email protected] Unsubscribe : https://launchpad.net/~drizzle-discuss More help : https://help.launchpad.net/ListHelp
