Hi all! Currently, there are a number of methods of documenting the code. I would like to standardize on JavaDoc/Doxygen style, which is common, industry-standard, machine-readable, and easy to use. Some of the code is already done this way. Other parts, especially the older stuff, is done using Monty's original SYNOPSIS style (if it has any documentation at all!)
One final question remains in my mind, though, which I would like to get a decision on: Where should the documentation for a function or class go? In the header (declaration) or source file (implementation)? My personal preference is to put documentation *about* the API and classes in the declaration area, and place implementation-specific documentation comments within the implementation itself. Any other opinions? Jay _______________________________________________ Mailing list: https://launchpad.net/~drizzle-discuss Post to : [email protected] Unsubscribe : https://launchpad.net/~drizzle-discuss More help : https://help.launchpad.net/ListHelp
