diff --git a/docs/groups.md b/docs/groups.md index 2814bcc8b2835c29f9d5b6de7e679d5be8dec93e..cd9e3f02af8d1e08c35955e1ac01c611e02a92d1 100644 --- a/docs/groups.md +++ b/docs/groups.md @@ -1 +1,3 @@ -\defgroup Detectors Detectors +\defgroup Detectors Main detector classes +\defgroup DetSupport Classes supporting detectors +\defgroup Base hcana infrastructure diff --git a/src/THcAnalyzer.cxx b/src/THcAnalyzer.cxx index 117df874f36000b095af4a243718dc81791d0075..e5ba03014828fb75e355f2bb4d555e0a6c91db57 100644 --- a/src/THcAnalyzer.cxx +++ b/src/THcAnalyzer.cxx @@ -1,26 +1,24 @@ -//*-- Author : Stephen Wood 13-March-2012 - -////////////////////////////////////////////////////////////////////////// -// -// THcAnalyzer -// -// THcAnalyzer is the base class for a "Hall C analyzer" class. -// An analyzer defines the basic actions to perform during analysis. -// THcAnalyzer is the default analyzer that is used if no user class is -// defined. It performs a standard analysis consisting of -// -// 1. Decoding/Calibrating -// 2. Track Reconstruction -// 3. Physics variable processing -// -// At the end of each step, testing and histogramming are done for -// the appropriate block defined in the global test/histogram lists. -// -// Hall C has their own analyzer class because some things are bound to -// be different. -// -////////////////////////////////////////////////////////////////////////// +/** \class THcAnalyzer + \ingroup Base +THcAnalyzer is the base class for a "Hall C analyzer" class. +An analyzer defines the basic actions to perform during analysis. +THcAnalyzer is the default analyzer that is used if no user class is +defined. It performs a standard analysis consisting of + + 1. Decoding/Calibrating + 2. Track Reconstruction + 3. Physics variable processing + +At the end of each step, testing and histogramming are done for +the appropriate block defined in the global test/histogram lists. + +Hall C has their own analyzer class because some things are bound to +be different. + +\author S. A. Wood, 13-March-2012 + +*/ #include "THcAnalyzer.h" #include "THaRunBase.h" #include "THaBenchmark.h" diff --git a/src/THcCherenkov.cxx b/src/THcCherenkov.cxx index da3232e95a41031f7f06dd6a11f5200940aa3162..7816cbc03c938e800fafc6e35e44051ecd71cb3a 100644 --- a/src/THcCherenkov.cxx +++ b/src/THcCherenkov.cxx @@ -1,26 +1,11 @@ -/////////////////////////////////////////////////////////////////////////////////////// -// // -// THcCherenkov // -// // -// Class for an Cherenkov detector consisting of two PMT's // -// // -// Zafar Ahmed. Fourth pull request. January 30 2014. // -// Comment: No need to cahnge the Map file. // -// Comment New parameter hcer_tot_pmts = 2 is added to the hcana.param file // -// // -// This code is for the coarse process of THcCherenkov class. // -// // -// // -// Variable Name Description // -// // -// phototubes Nuber of Cherenkov photo tubes // -// adc Raw ADC values // -// adc_p Pedestal Subtracted ADC values // -// npe Number of Photo electrons // -// npesum Sum of Number of Photo electrons // -// ncherhit Number of Hits(Cherenkov) // -// // -/////////////////////////////////////////////////////////////////////////////////////// +/** \class THcCherenkov + \ingroup Detectors + +Class for an Cherenkov detector consisting of two PMT's + +\author Zafar Ahmed + +*/ #include "THcCherenkov.h" #include "TClonesArray.h" diff --git a/src/THcDriftChamber.cxx b/src/THcDriftChamber.cxx index 7d901488caa66bf0ba2d855aac33efd3c2f05304..d7d2e51beb172fe4c2d393e227124f298d9c02b2 100644 --- a/src/THcDriftChamber.cxx +++ b/src/THcDriftChamber.cxx @@ -1,5 +1,5 @@ /** \class ThcDriftChamber - \ingroup Detectors + \ingroup DetSupport Subdetector class to hold a bunch of planes constituting a chamber This class will be created by the THcDC class which will also create diff --git a/src/THcDriftChamberPlane.cxx b/src/THcDriftChamberPlane.cxx index 2e73b1cd0a5a50aaf88a94835409d21a0cb38906..e23fe3a8a66d5e432ab1de97b36ef94ea74361a3 100644 --- a/src/THcDriftChamberPlane.cxx +++ b/src/THcDriftChamberPlane.cxx @@ -1,5 +1,5 @@ /** \class ThcDriftChamberPlane - \ingroup Detectors + \ingroup DetSupport Class for a a single Hall C horizontal drift chamber plane diff --git a/src/THcScintillatorPlane.cxx b/src/THcScintillatorPlane.cxx index 31b3acd5b4ab10eb12808c2fa9e36095605cc196..665751f049f890e904ed80d08b2e6dba16e7b090 100644 --- a/src/THcScintillatorPlane.cxx +++ b/src/THcScintillatorPlane.cxx @@ -1,5 +1,5 @@ /** \class THcScintillatorPlane - \ingroup Detectors + \ingroup DetSupport This class implements a single plane of scintillators. The THaHodoscope class instatiates one object per plane. diff --git a/src/THcShower.cxx b/src/THcShower.cxx index ec630739aa82d42137efafa897a19f99f8b4b8dc..c62c2f57bdac03ad1c2cfb1cf3e9cb70f2237407 100644 --- a/src/THcShower.cxx +++ b/src/THcShower.cxx @@ -1,13 +1,9 @@ -/////////////////////////////////////////////////////////////////////////////// -// // -// THcShower // -// // -// Shower counter class, describing a generic segmented shower detector. // -// // -// // -// // -// // -/////////////////////////////////////////////////////////////////////////////// +/** \class THcShower + \ingroup Detectors + +Shower counter class, describing a generic segmented shower detector. // + +*/ #include "THcShower.h" #include "THcHallCSpectrometer.h" diff --git a/src/THcShowerArray.cxx b/src/THcShowerArray.cxx index f4ffe81964fc080f2ee3e69049b20ea70f571a8c..269eeb55155e236381df0c74c48a33d942e2b607 100644 --- a/src/THcShowerArray.cxx +++ b/src/THcShowerArray.cxx @@ -1,10 +1,9 @@ -//*-- Author : +/** \class THcShowerArray + \ingroup DetSupport -////////////////////////////////////////////////////////////////////////// -// -// THcShowerArray -// -////////////////////////////////////////////////////////////////////////// +Fly's eye array of shower blocks + +*/ #include "THcShowerArray.h" #include "TClonesArray.h" diff --git a/src/THcShowerPlane.cxx b/src/THcShowerPlane.cxx index cb4518336126d5f3012d7f6e0ecbff381d09be95..b50774d04df7b64dda723132ba3378a98cffcb5f 100644 --- a/src/THcShowerPlane.cxx +++ b/src/THcShowerPlane.cxx @@ -1,10 +1,9 @@ -//*-- Author : +/** \class THcShowerPlane + \group DetSupport -////////////////////////////////////////////////////////////////////////// -// -// THcShowerPlane -// -////////////////////////////////////////////////////////////////////////// +One plane of shower blocks with side readout + +*/ #include "THcShowerPlane.h" #include "TClonesArray.h"