Changes between Version 10 and Version 11 of Developer/Coding/Doxygen
- Timestamp:
- 12/15/12 19:22:29 (11 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Developer/Coding/Doxygen
v10 v11 35 35 36 36 }}} 37 = Header guard = 37 38 38 39 After the comment blocks, use a header guard that assembles at least the include path of the file. For example, if flipflop.h is in <rtems/lib/flipflop.h> then … … 42 43 43 44 }}} 45 = Includes = 44 46 45 47 Then add your include files before protecting C declarations from C++. … … 52 54 53 55 }}} 56 = Using @defgroup for group definitions = 54 57 55 58 Add any group definitions surrounding the function declarations that belong in that group. Rarely, a header may define more than one group. Here we use a dot diagram. … … 80 83 81 84 }}} 85 = enum and struct = 82 86 83 87 Provide documentation for declarations of enumerated types and structs. Use typedefs for structs, and do not use _t as a typename suffix. … … 110 114 } flip_flop_multiple; 111 115 }}} 116 = Using @name for organization = 112 117 113 118 Complicated groups can be given additional organization by using @name, or by declaring additional groups within the hierarchy of the header file's top-level group. … … 120 125 121 126 }}} 127 = Declaring functions = 122 128 123 129 Function declarations should have an @brief that states what the function does in a single topic sentence starting with a descriptive verb in the present tense. … … 178 184 179 185 }}} 186 = Ending the file = 180 187 181 188 Close the documentation group definition, then the extern C declarations, then the header guard.