Changes between Version 4 and Version 5 of UsingDoxygen


Ignore:
Timestamp:
02/03/13 15:07:58 (12 years ago)
Author:
Jonathan
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • UsingDoxygen

    v4 v5  
    11 = Documenting AstroBEAR =
    22
    3 Doxygen is a tool for turning inline documentation into html documents for easier viewing of code/comments.  Doxygen is a bit fickle especially when it comes to fortran so there are a few things to be aware of.
     3Doxygen is a tool for turning inline documentation into html documents for easier viewing of code/comments.  There are two doxygen config files in the code repository that can be used to produce documentation. 
     4 * To generate documentation for the wiki, run {{{doxygen dox-config-scrambler}}}.  This will create a {{{doc}}} directory containing html source.  This should then be copied to {{{/cloverdata/trac/astrobear/doc/doxygen}}} so it can be viewed using the Doxygen tab.
     5 * Running {{{doxygen dox-config-scrambler-with-warnings}}} will produce a file {{{dox-warnlog.txt}}} which can be used to check for documentation related warnings. 
     6
     7Doxygen is a bit fickle especially when it comes to fortran so there are a few things to be aware of.
    48
    59 * All doxygen comment blocks should begin with a '!>'.  Successive lines can begin with a '!!'.  Doxygen will ignore the following