Changes

262 bytes removed ,  17:17, 21 September 2017
→‎Doxygen Style Guide: Disallowed →‎! ...: as valid doxygen comments
Line 29: Line 29:  
Doxygen allows for a variety of commenting styles. In order to maintain uniformity across the entire project the following rules should be applied:
 
Doxygen allows for a variety of commenting styles. In order to maintain uniformity across the entire project the following rules should be applied:
   −
* For short Doxygen comments use {{codeline|//!}}
+
* For Doxygen comments use only {{codeline|//!}} and NOT {{codeline|/*! ... */}}
* For longer comments use {{codeline|/*! ... */}}
  −
* For longer comments do not add {{codeline|*}} before each line
   
* Use {{codeline|@}} for any Doxygen Special Commands
 
* Use {{codeline|@}} for any Doxygen Special Commands
   Line 37: Line 35:     
<pre>
 
<pre>
//! Short Comment.
+
//! Comment with special command and syntax highlighting:
/*!
  −
    Longer comment with special command and syntax highlighting:
     −
    @code{.cc}
+
//! @code{.cc}
    double v = 1.0;
+
//! double v = 1.0;
    @endcode
+
//! @endcode
*/
   
</pre>
 
</pre>
  −
For actual use example look at [http://hg.savannah.gnu.org/hgweb/octave/file/1327ea4f5a93/liboctave/array/Array.h#l46 liboctave/array/Array.h]
  −
      
[[Category:Development]]
 
[[Category:Development]]
156

edits