Difference between revisions of "Doxygen"

From Octave
Jump to navigation Jump to search
(Created page with "==== What is Doxygen ? ==== Doxygen is the de facto standard tool for generating documentation from annotated C++ sources [http://www.stack.nl/~dimitri/doxygen/] ==== Genera...")
 
Line 10: Line 10:
  
 
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.
 
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.
 +
 +
* [http://octave.sourceforge.net/doxygen38/html Doxygen documentation for Octave 3.8.x (stable release)]
 +
* [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 ? ====
 
==== What is the current status of Octave's Doxygen documentation ? ====

Revision as of 12:56, 9 January 2015

What is Doxygen ?

Doxygen is the de facto standard tool for generating documentation from annotated C++ sources [1]

Generating the Doxygen documentation for Octave

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 ?

A recent version of the Doxygen documentation for Octave is available on the Octave Forge site, by clicking on the C++ API link on the Documentation page.

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 page of this wiki.