Difference between revisions of "GENIE Using Doxygen"

From SourceWiki
Jump to navigation Jump to search
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 +
==Intro==
  
First of all you'll probably need to get the application:
+
'''Doxygen''' is the best code documentation package around.  It now supports Fortran (90), so we'll use it.
  
 +
==Installation==
 +
 +
You'll need a fairly new version, as it hasn't always supported Fortran, but not the newest either--for some reason I can't get v1.6.2 to work properly.  Therefore I suggest using '''v1.5.8'''.  If you need to install it, a reasonable approach is:
 +
 +
Grab a tarball of the precompiled package:
 
<pre>
 
<pre>
 
wget ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.5.8.linux.bin.tar.gz
 
wget ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.5.8.linux.bin.tar.gz
 
</pre>
 
</pre>
  
and install it.
+
Use '''configure''' (with --prefix /path/to/where/you/want/it) and '''make''' to install it.
 +
 
 +
==Using it==
 +
 
 +
[[Fortran2|Fortran2]] has some simple examples of how you should structure your comments.

Latest revision as of 16:07, 2 February 2010

Intro

Doxygen is the best code documentation package around. It now supports Fortran (90), so we'll use it.

Installation

You'll need a fairly new version, as it hasn't always supported Fortran, but not the newest either--for some reason I can't get v1.6.2 to work properly. Therefore I suggest using v1.5.8. If you need to install it, a reasonable approach is:

Grab a tarball of the precompiled package:

wget ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.5.8.linux.bin.tar.gz

Use configure (with --prefix /path/to/where/you/want/it) and make to install it.

Using it

Fortran2 has some simple examples of how you should structure your comments.