Changes

Jump to navigation Jump to search

Doxygen

314 bytes removed, 06:53, 1 September 2018
m
All links HTTPS and usage of wiki-links.
==== What is Doxygen ? ====
[https://www.stack.nl/~dimitri/doxygen/ Doxygen ] is the de facto standard tool for generating documentation from annotated C++ sources [http://www.stack.nl/~dimitri/doxygen/]
==== Generating the Doxygen documentation for Octave ====
Doxygen documentation for Octave is easily generated from Octave sources. Instructions can be found in [httphttps://hg.savannah.gnu.org/hgweb/octave/file/tip/doc/doxyhtml/README doc/doxyhtml/README].
==== Where can I browse the Doxygen documentation for Octave ? ====
* [httphttps://octave.org/doxygen/stable Doxygen for the current GNU Octave stable release({{Release}})]* [httphttps://octave.org/doxygen/dev Doxygen for the current GNU Octave development sources]
Alternatively, you can access version specific Doxygen documentation:
* [httphttps://octave.org/doxygen/4.4 Doxygen for GNU Octave 4.4.x]* [https://octave.org/doxygen/4.2 Doxygen for GNU Octave 4.2.x]* [httphttps://octave.org/doxygen/4.0 Doxygen for GNU Octave 4.0.x]* [httphttps://octave.org/doxygen/3.8 Doxygen for GNU Octave 3.8.x]* [httphttps://octave.org/doxygen/3.6 Doxygen for GNU Octave 3.6.x]* [httphttps://octave.org/doxygen/3.4 Doxygen for GNU Octave 3.4.x]* [httphttps://octave.org/doxygen/3.2 Doxygen for GNU Octave 3.2.x]
==== 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.
==== Doxygen Style Guide ====
Doxygen allows for a variety of commenting styles. In order to maintain uniformity across the entire project For 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 Style Guide look at [[C%2B%2B_style_guide#Doxygen would look like: <pre>//! Comment with special command and syntax highlighting: //! @code{.cc}//! double v = 1]].0;//! @endcode</pre>
[[Category:Development]]

Navigation menu