Editing Doxygen

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 28: Line 28:
 
==== Doxygen Style Guide ====
 
==== Doxygen Style Guide ====
  
For the Doxygen Style Guide look at [[C%2B%2B_style_guide#Doxygen]].
+
Doxygen allows for a variety of commenting styles. In order to maintain uniformity across the entire project the following rules should be applied:
 +
 
 +
* 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]]

Please note that all contributions to Octave may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Octave:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)

Template used on this page: