[ET Trac] [Einstein Toolkit] #122: Code documentation

[Einstein Toolkit]

#122: Code documentation
-------------------------+--------------------------------------------------
 Reporter:  hinder       |       Owner:  mthomas
     Type:  enhancement  |      Status:  new    
 Priority:  minor        |   Milestone:         
Component:  SimFactory   |     Version:         
 Keywords:               |  
-------------------------+--------------------------------------------------
 In order to help new developers understand the code, the following would
 be useful:

 * Provide some sort of high-level overview of the internal components of
 simfactory.  This could be in the form of a class diagram with annotations
 indicating what each class does, and its relationship to the other classes
 (inheritence/object membership etc).  There must be tools for doing this
 for python and generating doxygen-type output.

 * Within the source code, provide at least a one-line comment for each
 function indicating what it does.

 * Ensure that the readmes etc in the repository are up-to-date, or at
 least remove any out-of-date information.

-- 
Ticket URL: <https://trac.einsteintoolkit.org/ticket/122>
Einstein Toolkit <http://einsteintoolkit.org>
The Einstein Toolkit