Changes

754 bytes added ,  13:03, 21 September 2017
Added information about the preferred style used in Doxygen
Line 24: Line 24:     
Very little Doxygen documentation is currently available in Octave's source code. Which is why "Doxygen documentation for the C++ classes" is listed in the [http://wiki.octave.org/Projects#Documentation_and_On-Line_Help Projects] page of this wiki.
 
Very little Doxygen documentation is currently available in Octave's source code. Which is why "Doxygen documentation for the C++ classes" is listed in the [http://wiki.octave.org/Projects#Documentation_and_On-Line_Help Projects] page of this wiki.
 +
 +
==== Doxygen Style Guide ====
 +
 +
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 longer comments use {{codeline|/*! ... */}}
 +
* For longer comments do not add {{codeline|*}} before each line
 +
* Use {{codeline|@}} for any Doxygen Special Commands
 +
 +
An example  of properly used Doxygen would look like:
 +
 +
<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]]
 
[[Category:Development]]
156

edits