Documentation

From Avogadro - Free cross-platform molecule editor
Revision as of 11:37, 15 March 2007 by 12.226.42.223 (talk)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Give an @author when possible. When you make changes add your name to the list.

Use @brief comments only for class definitions, this is the only case where brief will be beneficial.

Parameters (@param) and return (@return) values:

Do not capitalize the first word of the description.
Do not include an ending period (.) unless the description contains multiple sentences.