Difference between revisions of "Documentation"
From Avogadro - Free cross-platform molecule editor
| Line 1: | Line 1: | ||
| − | |||
Give an @author when possible. When you make changes add your name to the list. | Give an @author when possible. When you make changes add your name to the list. | ||
| Line 7: | Line 6: | ||
: Do not capitalize the first word of the description. | : Do not capitalize the first word of the description. | ||
: Do not include an ending period (.) unless the description contains multiple sentences. | : Do not include an ending period (.) unless the description contains multiple sentences. | ||
| + | |||
| + | |||
| + | == Links == | ||
| + | [http://techbase.kde.org/Policies/Library_Documentation_Policy KDE Library Documentation Policy] | ||
Revision as of 11:38, 15 March 2007
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.
