Changes between Version 8 and Version 9 of Developer/Coding/Doxygen
- Timestamp:
- 12/15/12 17:56:17 (11 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Developer/Coding/Doxygen
v8 v9 1 1 = Doxygen Recommendations = 2 2 3 = Best Practice=3 = Doxygen Best Practices = 4 4 5 5 6 6 * 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. 9 8 * 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. 12 10 * Do not use ''@note''. 11 * Use groups and arrange them in a hierarchy. Put every file into at least one group. 13 12 * Use dot comments for state diagrams. 14 * Do not repeat documentation, use ''@see'' for example.15 13 = Header File Example = 16 14