Changes between Version 1 and Version 2 of CodingStyle


Ignore:
Timestamp:
04/28/2011 08:47:50 PM (8 years ago)
Author:
Gabriele Pohl
Comment:

describe comment style for doxygen

Legend:

Unmodified
Added
Removed
Modified
  • CodingStyle

    v1 v2  
    1313=== Comments ===
    1414
    15 Doxygen generates [http://smartmontools.sourceforge.net/doxygen/ documentation pages] automatically by ''reading'' the sourcecode.
    16 We use the following styles for inline comments:
     15Doxygen generates our [http://smartmontools.sourceforge.net/doxygen/ sourcecode documentation pages]
     16automatically by ''reading'' the sourcecode. If you set a block with C++ comment lines,
     17where each line starts with an additional slash, the text will be shown in the doxygen generated docs.
     18Note that a blank line ends a documentation block. You may add two blocks, a first one with a brief description
     19and a second with an extended description for a class, struct or function.
    1720
    18 ..to be continued
     21{{{
     22/// SAT support.
     23/// Implements ATA by tunnelling through SCSI.
    1924
     25class sat_device
     26}}}
     27
     28Use ''in line'' comment style to add explanation on defines and variables.
     29A comment starting with three slashes, will appear in doxygen.
     30Comments that start with only two slashes, will be invisible there.
     31
     32{{{
     33// ATA ONLY
     34bool sct_erc_set;                       // set SCT ERC to:
     35unsigned short sct_erc_readtime;        // ERC read time (deciseconds)
     36unsigned short sct_erc_writetime;       // ERC write time (deciseconds)
     37
     38unsigned char curr_pending_id;          // ID of current pending sector count, 0 if none
     39unsigned char offl_pending_id;          // ID of offline uncorrectable sector count, 0 if none
     40}}}