Changes between Version 8 and Version 9 of Developer/Coding/Doxygen


Ignore:
Timestamp:
Dec 15, 2012, 5:56:17 PM (7 years ago)
Author:
Gedare
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Coding/Doxygen

    v8 v9  
    11= Doxygen Recommendations =
    22
    3 Best Practice  =
     3Doxygen Best Practices  =
    44
    55
    66 *  Do not use ''@param''.  Instead use ''@a name'' to document function parameters.
    7  *  Do not use ''@return''.
    8  *  Use ''@retval'' to document return status codes.
     7 *  Do not use ''@return''. Instead use ''@retval'' to document return status codes.
    98 *  Do not write documentation for trivial functions.
    10  *  Use groups and arrange them in a hierarchy.
    11  *  Put every file into at least one group.
     9 *  Do not repeat documentation, use ''@see'' for example.
    1210 *  Do not use ''@note''.
     11 *  Use groups and arrange them in a hierarchy. Put every file into at least one group.
    1312 *  Use dot comments for state diagrams.
    14  *  Do not repeat documentation, use ''@see'' for example.
    1513=  Header File Example  =
    1614