Changes

Jump to navigation Jump to search

Doxygen

544 bytes added, 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 ? ====
A recent version of * [https://octave.org/doxygen/stable Doxygen for the current GNU Octave stable release ({{Release}})]* [https://octave.org/doxygen/dev Doxygen documentation for Octave is available on the current GNU Octave Forge sitedevelopment sources] Alternatively, by clicking on the you can access version specific Doxygen documentation: * [https://octave.org/doxygen/4.4 Doxygen for GNU Octave 4.4.x]* [httphttps://octave.sourceforgeorg/doxygen/4.2 Doxygen for GNU Octave 4.2.x]* [https://octave.netorg/doxygen/html4.0 Doxygen for GNU Octave 4.0.x]* [https://octave.org/doxygen/index3.8 Doxygen for GNU Octave 3.8.html C++ APIx] link on the * [httphttps://octave.sourceforgeorg/doxygen/3.6 Doxygen for GNU Octave 3.6.x]* [https://octave.netorg/docsdoxygen/3.4 Doxygen for GNU Octave 3.4.html Documentationx] page* [https://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 ==== For the Doxygen Style Guide look at [[C%2B%2B_style_guide#Doxygen]].
[[Category:Development]]

Navigation menu