Changes between Version 5 and Version 6 of UsingDoxygen


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

—

Legend:

Unmodified
Added
Removed
Modified

  • UsingDoxygen

    v5 v6  
    1  = Documenting AstroBEAR =
     1[[PageOutline]]
     2 = Documenting AstroBEAR with Doxygen=
    23
     4== Generating HTML Output ==
    35Doxygen 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. 
    46 * 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.
    57 * Running {{{doxygen dox-config-scrambler-with-warnings}}} will produce a file {{{dox-warnlog.txt}}} which can be used to check for documentation related warnings. 
    68
     9== Doxygen and Fortran ==
    710Doxygen is a bit fickle especially when it comes to fortran so there are a few things to be aware of.
    811