From Avogadro - Free cross-platform molecule editor
|
|
| Line 1: |
Line 1: |
| − | Always give parameter (@param) and return (@return) descriptions:
| |
| − | * Do not capitalize the first word of the description.
| |
| − | * Do not include an ending period (.) unless the description contains multiple sentences.
| |
| | | | |
| − | 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.
| |
| − |
| |
| − | == Links ==
| |
| − | [http://techbase.kde.org/Policies/Library_Documentation_Policy KDE Library Documentation Policy]
| |
| − |
| |
| − | [[Category:Developer]]
| |
Revision as of 09:20, 19 March 2007
