Changes

Jump to navigation Jump to search
391 bytes removed ,  17:35, 21 September 2017
→‎Doxygen Style Guide: Moved doxygen style guide to C++ style guide
Line 27: Line 27:  
==== Doxygen Style Guide ====
 
==== 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 the Doxygen Style Guide look at [[C%2B%2B_style_guide#Doxygen]].
 
  −
* For Doxygen comments use only {{codeline|//!}} and NOT {{codeline|/*! ... */}}
  −
* Use {{codeline|@}} for any Doxygen Special Commands
  −
 
  −
An example  of properly used Doxygen would look like:
  −
 
  −
<pre>
  −
//! Comment with special command and syntax highlighting:
  −
 
  −
//! @code{.cc}
  −
//! double v = 1.0;
  −
//! @endcode
  −
</pre>
      
[[Category:Development]]
 
[[Category:Development]]
156

edits

Navigation menu