Editing Doxygen

==== What is 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 ====

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

:''See: [[Publications about Octave#Doxygen]]''

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