Doxygen: Difference between revisions

From Octave
Jump to navigation Jump to search
 
(13 intermediate revisions by 3 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 ? ====


A recent version of the Doxygen documentation for Octave is available on the Octave Forge site, by clicking on the [http://octave.sourceforge.net/doxygen/html/index.html C++ API] link on the [http://octave.sourceforge.net/docs.html Documentation] page.
:''See: [[Publications about Octave#Doxygen]]''


* [http://octave.sourceforge.net/doxygen38/html Doxygen documentation for Octave 3.8.x (stable release)]
==== What is the current status of Octave's Doxygen documentation ? ====
* [http://octave.sourceforge.net/doxygen41 Doxygen documentation for Octave 4.1.x (default branch, development version)]


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


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.
For the Doxygen Style Guide look at [[C%2B%2B_style_guide#Doxygen]].


[[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.