Changes

Jump to navigation Jump to search
262 bytes removed ,  10:17, 21 September 2017
→‎Doxygen Style Guide: Disallowed →‎! ...: as valid doxygen comments
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 only {{codeline|//!}}* For longer comments use and NOT {{codeline|/*! ... */}}* For longer comments do not add {{codeline|*}} before each line
* Use {{codeline|@}} for any Doxygen Special Commands
<pre>
//! Short Comment./*! Longer comment with special command and syntax highlighting:
//! @code{.cc} //! double v = 1.0; //! @endcode*/
</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]]
156

edits

Navigation menu