Changes between Version 10 and Version 11 of Developer/Coding/Doxygen


Ignore:
Timestamp:
Dec 15, 2012, 7:22:29 PM (7 years ago)
Author:
Gedare
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Coding/Doxygen

    v10 v11  
    3535
    3636}}}
     37=  Header guard  =
    3738
    3839After 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
     
    4243
    4344}}}
     45=  Includes  =
    4446
    4547Then add your include files before protecting C declarations from C++.
     
    5254
    5355}}}
     56=  Using @defgroup for group definitions  =
    5457
    5558Add 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.
     
    8083
    8184}}}
     85=  enum and struct  =
    8286
    8387Provide documentation for declarations of enumerated types and structs. Use typedefs for structs, and do not use _t as a typename suffix.
     
    110114} flip_flop_multiple;
    111115}}}
     116=  Using @name for organization  =
    112117
    113118Complicated 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.
     
    120125
    121126}}}
     127=  Declaring functions  =
    122128
    123129Function 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.
     
    178184
    179185}}}
     186=  Ending the file  =
    180187
    181188Close the documentation group definition, then the extern C declarations, then the header guard.