Editing Doxygen

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
==== What is Doxygen ? ====
==== What is Doxygen ? ====


[https://www.doxygen.nl/ Doxygen] is the de facto standard tool for generating documentation from annotated C++ sources.
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 ====
==== Generating the Doxygen documentation for Octave ====


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


==== Where can I browse the Doxygen documentation for Octave ? ====
==== Where can I browse the Doxygen documentation for Octave ? ====


:''See: [[Publications about Octave#Doxygen]]''
Some older and more recent versions of the Doxygen documentation for Octave are available on the web:
 
* [https://octave.space/doxygen/dev Doxygen for GNU Octave 4.3.x (devel 2017-05-29)]
* [https://octave.space/doxygen/4.2 Doxygen for GNU Octave 4.2.x (stable)]
* [http://octave.org/doxygen/4.0 Doxygen for GNU Octave 4.0.x]
* [http://octave.org/doxygen/3.8 Doxygen for GNU Octave 3.8.x]
* [http://octave.org/doxygen/3.6 Doxygen for GNU Octave 3.6.x]
* [http://octave.org/doxygen/3.4 Doxygen for GNU Octave 3.4.x]
* [http://octave.org/doxygen/3.2 Doxygen for GNU Octave 3.2.x]


==== What is the current status of Octave's Doxygen documentation ? ====
==== 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.
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]]
[[Category:Development]]
Please note that all contributions to Octave may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Octave:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)
Retrieved from "https://wiki.octave.org/Doxygen"