rwcarlsen/cyctest — Issue #18: 101 - Doxygen Cleanup and Improvement 
Author: rwcarlsen
Created: 2012-01-24 17:52:55+00:00
State: open

Target Date :
TBD

Feature Description :

The Doxygen documentation, if it is to be used as a (the) primary resource for the Cyclus code, must be checked for comprehensiveness and should be meticulously updated.

Ensure that all classes are well described and commented. Doxygen documentation withing stub model files should be up to date as well, and should have additional comments indicating the proper use and upkeep of the stub models.

Subtasks :

1. Comb through the code and confirm that all code contains informative Doxygen documentation
2. Make sure there are brief statements in class definitions
3. Update function and parameter definitions
4. For important utility classes, include comments about use of essential functionality

Original link: http://code.google.com/p/cyclus/issues/detail?id=101