Difference between revisions of "Doxygen"

From CUC3
Jump to navigation Jump to search
import>Mp466
import>Mp466
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
Doxygen is source code documentation generator for a variety of programming languages such as C, C++, and Fortran.
 
Doxygen is source code documentation generator for a variety of programming languages such as C, C++, and Fortran.
  +
It is robust tool, especially if you are starting of with a new set of code.
It produces output in both latex, html and rtf. It is highly configurable, and has load of online documentation http://www.doxygen.nl/index.html. Getting started is easy with the included config [[Media:config.txt|doxygen_fortran_config]] file. Simply run doxygen in the directory with your fortran source code. For this configuration latex and html output directories will be generated. To compile the latex, simple run make.
+
It produces output in both latex, html and rtf. It is highly configurable, and has load of online documentation http://www.doxygen.nl/index.html. Getting started is easy with the included config [[Media:config.txt|doxygen_fortran_config]] file. Simply run doxygen in the directory with your fortran source code. For this configuration latex and html output directories will be generated. To compile the latex, simple run make. It may not be installed on the sector machines, but should be straightforward to install locally.
   
 
<pre>
 
<pre>
 
doxygen doxygen_fortran_config
 
doxygen doxygen_fortran_config
 
</pre>
 
</pre>
  +
  +
--[[User:mp466|mp466]] 04:46, 19 October 2009 (BST)

Latest revision as of 03:54, 19 October 2009

Doxygen is source code documentation generator for a variety of programming languages such as C, C++, and Fortran. It is robust tool, especially if you are starting of with a new set of code. It produces output in both latex, html and rtf. It is highly configurable, and has load of online documentation http://www.doxygen.nl/index.html. Getting started is easy with the included config doxygen_fortran_config file. Simply run doxygen in the directory with your fortran source code. For this configuration latex and html output directories will be generated. To compile the latex, simple run make. It may not be installed on the sector machines, but should be straightforward to install locally.

  doxygen doxygen_fortran_config

--mp466 04:46, 19 October 2009 (BST)