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.stack.nl/~dimitri/doxygen/ 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 web:
| + | * [https://octave.org/doxygen/stable Doxygen for the current GNU Octave stable release ({{Release}})] |
| + | * [https://octave.org/doxygen/dev Doxygen for the current GNU Octave development sources] |
| | | |
− | * [http://octave.org/doxygen/3.2/html Doxygen for GNU Octave 3.2.x] | + | Alternatively, you can access version specific Doxygen documentation: |
− | * [http://octave.org/doxygen/3.4/html Doxygen for GNU Octave 3.4.x] | + | |
− | * [http://octave.org/doxygen/3.6/html Doxygen for GNU Octave 3.6.x] | + | * [https://octave.org/doxygen/4.4 Doxygen for GNU Octave 4.4.x] |
− | * [http://octave.org/doxygen/3.8/html Doxygen for GNU Octave 3.8.x] | + | * [https://octave.org/doxygen/4.2 Doxygen for GNU Octave 4.2.x] |
− | * [http://octave.org/doxygen/4.0/html Doxygen for GNU Octave 4.0.x (stable)] | + | * [https://octave.org/doxygen/4.0 Doxygen for GNU Octave 4.0.x] |
− | * [http://octave.org/doxygen/4.1/html Doxygen for GNU Octave 4.1.x (devel)] | + | * [https://octave.org/doxygen/3.8 Doxygen for GNU Octave 3.8.x] |
| + | * [https://octave.org/doxygen/3.6 Doxygen for GNU Octave 3.6.x] |
| + | * [https://octave.org/doxygen/3.4 Doxygen for GNU Octave 3.4.x] |
| + | * [https://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 [http://wiki.octave.org/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 [[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]] |