Difference between revisions of "Documentation"

From Avogadro - Free cross-platform molecule editor
Jump to: navigation, search
(Redirected page to Category:Documentation)
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Give an @author when possible.  When you make changes add your name to the list.
+
#redirect [[:Category:Documentation]]
 
 
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.
 
 
 
 
 
== Links ==
 
[http://techbase.kde.org/Policies/Library_Documentation_Policy KDE Library Documentation Policy]
 

Latest revision as of 08:07, 16 June 2009