Difference between revisions of "Doxygen"
Jump to navigation
Jump to search
Carandraug (talk | contribs) (use octave.org links and link to stable and dev) |
|||
| (8 intermediate revisions by 2 users 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 ? ==== | |
| − | + | 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]] | ||
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 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]
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.