== Generating Documentation ==

To generate scrambler documentation with Doxygen, enter the scrambler directory
and type:

   doxygen dox-config

Where  "dox-config" is the pre-configured documentation configuration
for the scrambler project. This configuration recursively reads *.f90 
files in the directory of invocation; documentation will not generate 
unless the command is run from within the scrambler directory.

A successful run will produce a "doc" directory of HTML files and associated 
resources within the scrambler directory. To properly view documentation in a 
web brewer, open "index.html."

Using dox-config-with-warnings will also produce a file containing
oxygen warnings called "dox-warnlog.txt"

== Graphviz ==

To run properly, Graphviz must be installed and "dot" (the directed graph 
program) must exist on the execution path; this has been configured 
properly for clover.pas.rochester.edu. Graphviz will generate call and 
caller graphs for a given function, as well as indicate file associations 
in UML style. 

== External Links ==

=== Doxygen Home Page ===
http://www.stack.nl/~dimitri/doxygen/

=== Fortran Doxygen Comment Formatting ===
http://www.dougdevel.org/index.php?page=doxygen

=== Doxygen Tags ===
http://www.stack.nl/~dimitri/doxygen/commands.html
