Difference between revisions of "Doxygen"

From Octave
Jump to navigation Jump to search
(→‎Doxygen Style Guide: Disallowed →‎! ...: as valid doxygen comments)
(→‎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]]

Revision as of 09:35, 21 September 2017

What is Doxygen ?

Doxygen is the de facto standard tool for generating documentation from annotated C++ sources [1]

Generating the Doxygen documentation for Octave

Doxygen documentation for Octave is easily generated from Octave sources. Instructions can be found in doc/doxyhtml/README.

Where can I browse the Doxygen documentation for Octave ?

Alternatively, you can access version specific Doxygen documentation:

What is the current status of Octave's Doxygen documentation ?

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 Projects page of this wiki.

Doxygen Style Guide

For the Doxygen Style Guide look at C++_style_guide#Doxygen.