Doxygen: Difference between revisions

From Octave
Jump to navigation Jump to search
(Added information about the preferred style used in Doxygen)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==== What is Doxygen ? ====
==== What is Doxygen ? ====


Doxygen is the de facto standard tool for generating documentation from annotated C++ sources [http://www.stack.nl/~dimitri/doxygen/]
[https://www.doxygen.nl/ Doxygen] is the de facto standard tool for generating documentation from annotated C++ sources.


==== Generating the Doxygen documentation for Octave ====
==== Generating the Doxygen documentation for Octave ====


Doxygen documentation for Octave is easily generated from Octave sources. Instructions can be found in [http://hg.savannah.gnu.org/hgweb/octave/file/tip/doc/doxyhtml/README doc/doxyhtml/README].
Doxygen documentation for Octave is easily generated from Octave sources. Instructions can be found in [https://hg.savannah.gnu.org/hgweb/octave/file/tip/doc/doxyhtml/README doc/doxyhtml/README].


==== Where can I browse the Doxygen documentation for Octave ? ====
==== Where can I browse the Doxygen documentation for Octave ? ====


* [http://octave.org/doxygen/stable Doxygen for the current GNU Octave release]
:''See: [[Publications about Octave#Doxygen]]''
* [http://octave.org/doxygen/dev Doxygen for the current GNU Octave development sources]
 
Alternatively, you can access version specific Doxygen documentation:
 
* [http://octave.org/doxygen/4.2 Doxygen for GNU Octave 4.2.x]
* [http://octave.org/doxygen/4.0 Doxygen for GNU Octave 4.0.x]
* [http://octave.org/doxygen/3.8 Doxygen for GNU Octave 3.8.x]
* [http://octave.org/doxygen/3.6 Doxygen for GNU Octave 3.6.x]
* [http://octave.org/doxygen/3.4 Doxygen for GNU Octave 3.4.x]
* [http://octave.org/doxygen/3.2 Doxygen for GNU Octave 3.2.x]


==== What is the current status of Octave's 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 [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 [[Projects#Documentation_and_On-Line_Help | Projects]] page of this wiki.


==== 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 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]]

Latest revision as of 17:19, 21 January 2023

What is Doxygen ?[edit]

Doxygen is the de facto standard tool for generating documentation from annotated C++ sources.

Generating the Doxygen documentation for Octave[edit]

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 ?[edit]

See: Publications about Octave#Doxygen

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

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[edit]

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

Retrieved from "https://wiki.octave.org/wiki/index.php?title=Doxygen&oldid=14576"