[Brahms-dev-l] More brat class documentation

Dear dev'ils:

Yet another BRAT class documentation is avaliable (ver 2.24.26), this time
at the new, world-avaliable location:
http://www4.rcf.bnl.gov/~brahmlib/brat/

IMPORTANT: To keep the online documentation relevant it's crucial that new
classes are given a one-line description in the header file. Otherwise it
gets hard to read and understand the rather long list of shortened names
like 'BrTileTiltGainCalModule' ;-) A little grep'ing reveals that the
following classes need attention:

> cat bratclasses.txt | grep 'DOCUMENT ME'
BrBbFlowModule .................... DOCUMENT ME
BrBbFlowWeightCalModule ........... DOCUMENT ME
BrCcDeltaTdcCalModule ............. DOCUMENT ME
BrCcPedCalModule .................. DOCUMENT ME
BrCcSlewingCalModule .............. DOCUMENT ME
BrCcVertexCalModule ............... DOCUMENT ME
BrCcVertexModule .................. DOCUMENT ME
BrClockRdoModule .................. DOCUMENT ME
BrDbCommitModule .................. DOCUMENT ME
BrDvCalModule ..................... DOCUMENT ME
BrFlow ............................ DOCUMENT ME
BrFlowTileWeightCalModule ......... DOCUMENT ME
BrMrsT0RdoModule .................. DOCUMENT ME
BrMultCentCalModule ............... DOCUMENT ME
BrSaveNoTrackModule ............... DOCUMENT ME
BrSiPulserCalModule ............... DOCUMENT ME
BrSiTiltGainCalModule ............. DOCUMENT ME
BrTileTiltGainCalModule ........... DOCUMENT ME

To the authors of these classes: Please add a simple, one-line explanation
of the classes in the header file where it currently says 'DOCUMENT ME',
e.g.
BrCcVertexModule: Calculates vertex position from CC counters
or similar. (To be fair, there is also a number of classes where the
description is simply empty. They should of course also be documented :-)

Regards
--Bjorn 'Holm Light' Samset



--
Bjorn H. Samset                           Phone: 22856465/92051998
PhD student, heavy ion physics            Adr:   Schouterrassen 6
Inst. of Physics, University of Oslo             0573 Oslo
                              \|/
----------------------------> -*- <-----------------------------
                              /|\

_______________________________________________
Brahms-dev-l mailing list
Brahms-dev-l@lists.bnl.gov
http://lists.bnl.gov/mailman/listinfo/brahms-dev-l