rwcarlsen/cyctest — Issue #32: 110 - Create documentation for the logger 
Author: rwcarlsen
Created: 2012-01-24 17:53:23+00:00
State: open

With the absence of alternative propositions, I hereby declare the Logger an official member of our codebase.

I think we need 2 types of documentation for the logger. Obviously it needs some API doc and implementation comments. At least as important, however, is a document describing conventions for its use in both the core and by external developers. One convention I would like to suggest is that the log comments in each file be prefixed with the name of that file (or some unique identifier).

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