Doxygen: Difference between revisions
(→Doxygen Style Guide: Moved doxygen style guide to C++ style guide) |
|||
(5 intermediate revisions by one other user 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 | [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 [ | 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 ? ==== | ||
:''See: [[Publications about Octave#Doxygen]]'' | |||
==== 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 [ | 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 ==== | ==== Doxygen Style Guide ==== |
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 OctaveEdit
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
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 GuideEdit
For the Doxygen Style Guide look at C++_style_guide#Doxygen.