Difference between revisions of "Doxygen"

From Octave
Jump to navigation Jump to search
(→‎Where can I browse the Doxygen documentation for Octave ?: Add link to 4.4.x release Doxygen. All urls HTTPS.)
m (All links HTTPS and usage of wiki-links.)
 
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 ? ====
Line 24: Line 24:
 
==== 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 ====
 
==== Doxygen Style Guide ====

Latest revision as of 06:53, 1 September 2018

What is Doxygen ?[edit]

Doxygen is the de facto standard tool for generating documentation from annotated C++ sources.

Generating the Doxygen documentation for Octave[edit]

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]

Alternatively, you can access version specific Doxygen documentation:

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 Guide[edit]

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