Difference between revisions of "Doxygen"

From Octave
Jump to navigation Jump to search
Line 1: Line 1:
==== What is Doxygen ? ====
+
==== What is Doxygen ? ====  
  
 
[https://www.stack.nl/~dimitri/doxygen/ Doxygen] is the de facto standard tool for generating documentation from annotated C++ sources.
 
[https://www.stack.nl/~dimitri/doxygen/ Doxygen] is the de facto standard tool for generating documentation from annotated C++ sources.

Revision as of 04:19, 12 February 2021

What is Doxygen ?

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

Doxygen Style Guide

For the Doxygen Style Guide look at C++_style_guide#Doxygen.