From df64048ff3d002edb00fc30feeae35cc143d79f6 Mon Sep 17 00:00:00 2001
From: Mark Jones <jones@jlab.org>
Date: Wed, 18 May 2016 11:55:30 -0400
Subject: [PATCH] Update for Doxygen comments for the classes
---
src/THcAerogelHit.cxx | 24 ++++++------
src/THcCherenkovHit.cxx | 27 +++++++------
src/THcDCHit.cxx | 12 +++---
src/THcDCLookupTTDConv.cxx | 15 ++------
src/THcDCTimeToDistConv.cxx | 10 ++---
src/THcDCTrack.cxx | 12 +++---
src/THcDCWire.cxx | 13 +++----
src/THcDetectorMap.cxx | 18 ++++-----
src/THcFormula.cxx | 23 ++++++-----
src/THcHallCSpectrometer.cxx | 74 +++++++-----------------------------
src/THcHitList.cxx | 18 ++++-----
src/THcHodoEff.cxx | 16 +++-----
src/THcHodoHit.cxx | 12 +++---
src/THcHodoscope.cxx | 8 +---
src/THcInterface.cxx | 19 ++++-----
src/THcParmList.cxx | 2 +-
src/THcRaster.cxx | 21 +++++-----
src/THcRasteredBeam.cxx | 18 ++++-----
src/THcRawDCHit.cxx | 15 ++++----
src/THcRawHit.cxx | 17 ++++-----
src/THcRawHodoHit.cxx | 20 +++++-----
src/THcRawShowerHit.cxx | 31 ++++++++-------
src/THcScalerEvtHandler.cxx | 64 +++++++++++++++----------------
src/THcShowerHit.cxx | 4 ++
src/THcSignalHit.cxx | 11 ++----
src/THcSpacePoint.cxx | 13 +++----
26 files changed, 215 insertions(+), 302 deletions(-)
diff --git a/src/THcAerogelHit.cxx b/src/THcAerogelHit.cxx
index 4ead9c5..b9128d7 100644
--- a/src/THcAerogelHit.cxx
+++ b/src/THcAerogelHit.cxx
@@ -1,16 +1,16 @@
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcAerogelHit //
-// //
-// Class representing a single raw hit for a pair of aerogel tubes //
-// //
-// Contains plane, counter and pos/neg adc //
-// //
-// Assumes Aerogel design where Aerogel PMT's are in pairs and only have //
-// ADCs. //
-// //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcAerogelHit
+ \ingroup DetSupport
+Raw Aerogel Hit Info
+Inherits from THcRawHodoHit
+
+ Contains plane, counter and pos/neg adc
+
+
+
+
+
+*/
#include "THcAerogelHit.h"
//////////////////////////////////////////////////////////////////////////
diff --git a/src/THcCherenkovHit.cxx b/src/THcCherenkovHit.cxx
index c946328..7eb1622 100644
--- a/src/THcCherenkovHit.cxx
+++ b/src/THcCherenkovHit.cxx
@@ -1,17 +1,16 @@
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcCherenkovHit //
-// //
-// Class representing a single raw hit for a pair of aerogel tubes //
-// //
-// Contains plane, counter and pos/neg adc //
-// //
-// Assumes Aerogel design where Aerogel PMT's are in pairs and only have //
-// ADCs. //
-// //
-// Ahmed. First attempt. September 27 2013. //
-// //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcCherenkovHit
+ \ingroup DetSupport
+
+Class representing Cherenkov PMT hit
+Inherits from THcRawHodoHit
+
+ Contains plane, counter and pos/neg adc
+
+
+\author Zafar Ahmed
+
+*/
+
#include "THcCherenkovHit.h"
diff --git a/src/THcDCHit.cxx b/src/THcDCHit.cxx
index 3b1523c..a6c9605 100644
--- a/src/THcDCHit.cxx
+++ b/src/THcDCHit.cxx
@@ -1,11 +1,9 @@
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcDCHit //
-// //
-// Class representing a single hit for the VDC //
-// //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcDCHit
+ \ingroup DetSupport
+Drift chamber wire hit info
+
+*/
#include "THcDCHit.h"
#include "THcDCTimeToDistConv.h"
diff --git a/src/THcDCLookupTTDConv.cxx b/src/THcDCLookupTTDConv.cxx
index 7665457..dc32cc6 100644
--- a/src/THcDCLookupTTDConv.cxx
+++ b/src/THcDCLookupTTDConv.cxx
@@ -1,12 +1,8 @@
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcDCLookupTTDConv //
-// //
-// Upon initialization needs to be given the lookup table for time //
-// to distance conversion. //
-// //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcDCLookupTTDConv
+ \ingroup DetSupport
+
+*/
#include "THcDCLookupTTDConv.h"
ClassImp(THcDCLookupTTDConv)
@@ -50,9 +46,6 @@ Double_t THcDCLookupTTDConv::ConvertTimeToDist(Double_t time)
Double_t drift_distance = fMaxDriftDistance * frac;
- // Engine subtracts a hdc_card_delay from this. Seems
- // to be zero in the PARAM files, bit is it always? Delay implies
- // time? Whis is a time subtracted from a distance?
return(drift_distance);
}
diff --git a/src/THcDCTimeToDistConv.cxx b/src/THcDCTimeToDistConv.cxx
index 1596589..468311f 100644
--- a/src/THcDCTimeToDistConv.cxx
+++ b/src/THcDCTimeToDistConv.cxx
@@ -1,9 +1,9 @@
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcDCTimeToDistConv //
-// //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcDCTimeToDistConv
+ \ingroup DetSupport
+
+
+*/
#include "THcDCTimeToDistConv.h"
diff --git a/src/THcDCTrack.cxx b/src/THcDCTrack.cxx
index 92503b0..7de01b9 100644
--- a/src/THcDCTrack.cxx
+++ b/src/THcDCTrack.cxx
@@ -1,9 +1,9 @@
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcDCTrack //
-// //
-// Class representing a track found from linking DC Space points //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcDCTrack
+ \ingroup DetSupport
+
+ Class representing a track found from linking DC Space points
+
+*/
#include "THcDCHit.h"
#include "THcDCTrack.h"
diff --git a/src/THcDCWire.cxx b/src/THcDCWire.cxx
index 3b6520b..f81d646 100644
--- a/src/THcDCWire.cxx
+++ b/src/THcDCWire.cxx
@@ -1,10 +1,9 @@
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcDCWire //
-// //
-// Class to represent a drift chamber wire //
-// //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcDCHit
+ \ingroup DetSupport
+
+ Class to represent a drift chamber wire
+
+*/
#include "THcDCWire.h"
diff --git a/src/THcDetectorMap.cxx b/src/THcDetectorMap.cxx
index 9247259..eea8a83 100644
--- a/src/THcDetectorMap.cxx
+++ b/src/THcDetectorMap.cxx
@@ -1,14 +1,14 @@
-//*-- Author: Stephen Wood
+/** \class THcDetectorMap
+ \ingroup Base
-//////////////////////////////////////////////////////////////////////////
-//
-// THcDetectorMap
-//
-// Class to read and Hall C style detector map
-// FillMap method builds a map for a specific detector
-//
-//////////////////////////////////////////////////////////////////////////
+
+ Class to read and Hall C style detector map
+ FillMap method builds a map for a specific detector
+
+\author S. A. Wood
+
+*/
#include "THcDetectorMap.h"
#include "TObjArray.h"
diff --git a/src/THcFormula.cxx b/src/THcFormula.cxx
index 114d8f6..d9467c8 100644
--- a/src/THcFormula.cxx
+++ b/src/THcFormula.cxx
@@ -1,15 +1,14 @@
-//*-- Author : Stephen Wood 17-Oct-2013
-
-//////////////////////////////////////////////////////////////////////////
-//
-// THcFormula
-//
-// Tweaked THaFormula. If cutname.scaler is used in a formula, then
-// it is evaluated as the number of times that the cut passed.
-// Use EVariableType of kUndefined to indicate cut scaler in list of
-// variables used in the formula
-//
-//////////////////////////////////////////////////////////////////////////
+/** \class THcFormula
+ \ingroup Base
+
+ Tweaked THaFormula. If cutname.scaler is used in a formula, then
+ it is evaluated as the number of times that the cut passed.
+ Use EVariableType of kUndefined to indicate cut scaler in list of
+ variables used in the formula
+
+\author S. A. Wood
+
+*/
#include "THcFormula.h"
#include "THcParmList.h"
diff --git a/src/THcHallCSpectrometer.cxx b/src/THcHallCSpectrometer.cxx
index 54421c9..cc76683 100644
--- a/src/THcHallCSpectrometer.cxx
+++ b/src/THcHallCSpectrometer.cxx
@@ -1,65 +1,17 @@
-//*-- Author : Stephen Wood 20-Apr-2012
+/** \class THcHallCSpectrometer
+ \ingroup Base
-//////////////////////////////////////////////////////////////////////////
-//
-// THcHallCSpectrometer
-//
-// A standard Hall C spectrometer.
-// Contains no standard detectors,
-// May add hodoscope
-//
-// The usual name of this object is either "H", "S", or "P"
-// for HMS, SOS, or suPerHMS respectively
-//
-// Defines the functions FindVertices() and TrackCalc(), which are common
-// to both the LeftHRS and the RightHRS.
-//
-// Special configurations of the HRS (e.g. more detectors, different
-// detectors) can be supported in on e of three ways:
-//
-// 1. Use the AddDetector() method to include a new detector
-// in this apparatus. The detector will be decoded properly,
-// and its variables will be available for cuts and histograms.
-// Its processing methods will also be called by the generic Reconstruct()
-// algorithm implemented in THaSpectrometer::Reconstruct() and should
-// be correctly handled if the detector class follows the standard
-// interface design.
-//
-// 2. Write a derived class that creates the detector in the
-// constructor. Write a new Reconstruct() method or extend the existing
-// one if necessary.
-//
-// 3. Write a new class inheriting from THaSpectrometer, using this
-// class as an example. This is appropriate if your HRS
-// configuration has fewer or different detectors than the
-// standard HRS. (It might not be sensible to provide a RemoveDetector()
-// method since Reconstruct() relies on the presence of the
-// standard detectors to some extent.)
-//
-// For timing calculations, S1 is treated as the scintillator at the
-// 'reference distance', corresponding to the pathlength correction
-// matrix.
-//
-//
-// Golden track using scin. Zafar Ahmed. August 19 2014
-// Goldent track is moved to THcHallCSpectrometer::TrackCalc()
-// if fSelUsingScin == 0 then golden track is calculated just
-// like podd. i.e. it is the first track with minimum chi2/ndf
-// with sorting ON
-//
-// if fSelUsingScin == 1 then golden track is calculetd just like
-// engine/HTRACKING/h_select_best_track_using_scin.h. This method
-// gives the best track with minimum value of chi2/ndf but with
-// additional cuts on the tracks. These cuts are on dedx, beta
-// and on energy.
-//
-// Golden track using prune. Zafar Ahmed. September 23 2014
-// Selection of golden track using prune method is added.
-// A bug is also fixed in THcHodoscope class
-// Number of pmts hits, focal plane time, good time for plane 4
-// and good time for plane 3 are set to the tracks in
-// THcHodoscope class.
-//
+ A standard Hall C spectrometer.
+ Contains no standard detectors,
+
+ The usual name of this object is either "H", "S", "P"
+ for HMS, SOS, or suPerHMS respectively
+
+
+
+\author S. A. Wood
+
+*/
//////////////////////////////////////////////////////////////////////////
#include "THcHallCSpectrometer.h"
diff --git a/src/THcHitList.cxx b/src/THcHitList.cxx
index bbac904..94b6d7b 100644
--- a/src/THcHitList.cxx
+++ b/src/THcHitList.cxx
@@ -1,15 +1,11 @@
-//*-- Author : Stephen Wood 30-March-2012
-
-//////////////////////////////////////////////////////////////////////////
-//
-// THcHitList
-//
-// Class to build a Hall C ENGINE style list of raw hits from the raw data.
-// Detectors that use hit lists need to inherit from this class
-// as well as THaTrackingDetector or THaNonTrackingDetector
-//
-//////////////////////////////////////////////////////////////////////////
+/** \class THcHitList
+ \ingroup Base
+ Class to build a Hall C ENGINE style list of raw hits from the raw data.
+ Detectors that use hit lists need to inherit from this class
+ as well as THaTrackingDetector or THaNonTrackingDetector
+
+*/
#include "THcHitList.h"
#include "TError.h"
#include "TClass.h"
diff --git a/src/THcHodoEff.cxx b/src/THcHodoEff.cxx
index 138abf8..30aaf0f 100644
--- a/src/THcHodoEff.cxx
+++ b/src/THcHodoEff.cxx
@@ -1,14 +1,10 @@
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcHodoEff //
-// //
-// Class for accumulating statistics for and calculating hodoscope //
-// efficiencies. //
-// //
-// Moddled after VDCeff //
-// For now trying to emulate work done in h_scin_eff/h_scin_eff_shutdown //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcHodoEff
+ \ingroup DetSupport
+ Class for accumulating statistics for and calculating hodoscope
+ efficiencies.
+
+*/
#include "THaEvData.h"
#include "THaCutList.h"
#include "VarDef.h"
diff --git a/src/THcHodoHit.cxx b/src/THcHodoHit.cxx
index 7a79e0d..9c6d82a 100644
--- a/src/THcHodoHit.cxx
+++ b/src/THcHodoHit.cxx
@@ -1,11 +1,9 @@
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcHodoHit //
-// //
-// Class representing a single hit for the Hodoscopes //
-// //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcHodoHit
+ \ingroup DetSupport
+ Class representing a single hit for the Hodoscopes
+
+*/
#include "THcHodoHit.h"
#include <iostream>
diff --git a/src/THcHodoscope.cxx b/src/THcHodoscope.cxx
index fea9714..39a3ce4 100644
--- a/src/THcHodoscope.cxx
+++ b/src/THcHodoscope.cxx
@@ -7,12 +7,6 @@ This differs from Hall A scintillator class in that it is the whole
hodoscope array, not just one plane.
*/
-// Date July 8 2014:
-// Zafr Ahmed
-// Beta and chis square are calculated for each of the hodoscope track.
-// Two new variables are added. fBeta and fBetaChisq
-//
-///////////////////////////////////////////////////////////////////////////////
#include "THcSignalHit.h"
#include "THcHodoHit.h"
@@ -40,7 +34,7 @@ hodoscope array, not just one plane.
#include "TClonesArray.h"
#include "TMath.h"
-s#include "THaTrackProj.h"
+#include "THaTrackProj.h"
#include <vector>
#include <cstring>
diff --git a/src/THcInterface.cxx b/src/THcInterface.cxx
index c52398a..ceea259 100644
--- a/src/THcInterface.cxx
+++ b/src/THcInterface.cxx
@@ -1,14 +1,11 @@
-//*-- Author : Ole Hansen 12/05/2000
-
-//////////////////////////////////////////////////////////////////////////
-//
-// THcInterface
-//
-// THcInterface is the interactive interface to the Hall A Analyzer.
-// It allows interactive access to all analyzer classes as well as
-// all of standard ROOT.
-//
-//////////////////////////////////////////////////////////////////////////
+/** \class THcInterface
+ \ingroup Base
+
+ THcInterface is the interactive interface to the Hall A Analyzer.
+ It allows interactive access to all analyzer classes as well as
+ all of standard ROOT.
+
+*/
#include "TROOT.h"
#include "TClass.h"
diff --git a/src/THcParmList.cxx b/src/THcParmList.cxx
index ddf9e65..0b58db2 100644
--- a/src/THcParmList.cxx
+++ b/src/THcParmList.cxx
@@ -1,5 +1,5 @@
/** \class THcParmList
- \ingroup Core
+ \ingroup Base
A class that can read and hold the parmaters from the CTP formatted
parameter files used by the Fortran ENGINE.
diff --git a/src/THcRaster.cxx b/src/THcRaster.cxx
index 2afed7e..3358f75 100644
--- a/src/THcRaster.cxx
+++ b/src/THcRaster.cxx
@@ -1,16 +1,13 @@
-// Author : Buddhini Waidyawansa
-// Date : 12-09-2013
-
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcRaster //
-// //
-// A class to decode the fast raster signals. //
-// Measures the two magnet currents which are propotioanl to horizontal and //
-// vertical beam position //
-// //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcRaster
+ \ingroup DetSupport
+ A class to decode the fast raster signals.
+ Measures the two magnet currents which are proportional to horizontal and
+ vertical beam position
+
+\author Buddhini Waidyawansa
+
+*/
#include "THcRaster.h"
#include "THaEvData.h"
#include "THaDetMap.h"
diff --git a/src/THcRasteredBeam.cxx b/src/THcRasteredBeam.cxx
index b29ce6b..c4bd431 100644
--- a/src/THcRasteredBeam.cxx
+++ b/src/THcRasteredBeam.cxx
@@ -1,13 +1,11 @@
-// Author : Buddhini Waidyawansa
-// Date : 01-08-2014
-
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcRasteredBeam //
-// //
-// A class to handle the raster processing tasks //
-// //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcRasteredBeam
+ \ingroup Detectors
+
+ A class to handle the raster processing tasks
+
+\author Buddhini Waidyawansa
+
+*/
#include "THcRasteredBeam.h"
#include "THcRaster.h"
diff --git a/src/THcRawDCHit.cxx b/src/THcRawDCHit.cxx
index 6032b15..174e791 100644
--- a/src/THcRawDCHit.cxx
+++ b/src/THcRawDCHit.cxx
@@ -1,11 +1,10 @@
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcRawDCHit //
-// //
-// Class representing for drift chamber wire (or other device with //
-// a single multihit TDC channel per detector element //
-// //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcRawDCHit
+ \ingroup DetSupport
+
+ Class representing for drift chamber wire (or other device with
+ a single multihit TDC channel per detector element
+
+*/
#include "THcRawDCHit.h"
diff --git a/src/THcRawHit.cxx b/src/THcRawHit.cxx
index e2cd54e..0dd4f0b 100644
--- a/src/THcRawHit.cxx
+++ b/src/THcRawHit.cxx
@@ -1,12 +1,11 @@
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcRawHit //
-// //
-// Abstract class for a single raw hit //
-// //
-// Contains plane, counter and at least one data value //
-// //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcRawHit
+ \ingroup DetSupport
+
+ Abstract class for a single raw hit
+
+ Contains plane, counter and at least one data value
+
+*/
#include "THcRawHit.h"
diff --git a/src/THcRawHodoHit.cxx b/src/THcRawHodoHit.cxx
index dc2021a..3d6bc71 100644
--- a/src/THcRawHodoHit.cxx
+++ b/src/THcRawHodoHit.cxx
@@ -1,12 +1,14 @@
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcRawHodoHit //
-// //
-// Class representing a single raw hit for a hodoscope paddle //
-// //
-// Contains plane, counter and pos/neg adc and tdc values //
-// //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcRawHodoHit
+ \ingroup DetSupport
+
+Raw Aerogel Hit Info
+
+Class representing a single raw hit for a hodoscope paddle
+
+ Contains plane, counter and pos/neg adc and tdc values
+
+
+*/
#include <cstring>
#include <cstdio>
diff --git a/src/THcRawShowerHit.cxx b/src/THcRawShowerHit.cxx
index d509621..859cc6c 100644
--- a/src/THcRawShowerHit.cxx
+++ b/src/THcRawShowerHit.cxx
@@ -1,19 +1,18 @@
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcRawShowerHit //
-// //
-// Class representing a single raw hit for a hodoscope paddle //
-// //
-// Contains plane, counter and pos/neg adc and tdc values //
-// //
-// Enhanced to work with FADC250 data samples. If fNPosSamples/fNNegSamples //
-// is greater than 1, assume that the data held in the hit is the sampled //
-// waveform. Signals 0,1 will return the integrated pulse with dynamic //
-// pedestal subtraction (first four samples comprise the pedestal). Signals //
-// 2,3 are reserved for time information. Signals 4,5 are pedestals and //
-// 6 and 7 are the straight sum of all the samples. //
-// //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcRawShowerHit
+ \ingroup DetSupport
+
+ Class representing a single raw hit for a hodoscope paddle
+
+ Contains plane, counter and pos/neg adc and tdc values
+
+ Enhanced to work with FADC250 data samples. If fNPosSamples/fNNegSamples
+ is greater than 1, assume that the data held in the hit is the sampled
+ waveform. Signals 0,1 will return the integrated pulse with dynamic
+ pedestal subtraction (first four samples comprise the pedestal). Signals
+ 2,3 are reserved for time information. Signals 4,5 are pedestals and
+ 6 and 7 are the straight sum of all the samples.
+
+*/
#include "THcRawShowerHit.h"
#include <iostream>
diff --git a/src/THcScalerEvtHandler.cxx b/src/THcScalerEvtHandler.cxx
index 4f1ef7e..9e5fb58 100644
--- a/src/THcScalerEvtHandler.cxx
+++ b/src/THcScalerEvtHandler.cxx
@@ -1,36 +1,34 @@
-////////////////////////////////////////////////////////////////////
-//
-// THcScalerEvtHandler
-//
-// Event handler for Hall C scalers
-// E. Brash, June, 2015
-// based on THaScalerEvtHandler
-// R. Michaels, Sept, 2014
-//
-// This class does the following
-// For a particular set of event types (here, event type 0)
-// decode the scalers and put some variables into global variables.
-// The global variables can then appear in the Podd output tree T.
-// In addition, a tree "TS" is created by this class; it contains
-// just the scaler data by itself. Note, the "fName" is concatenated
-// with "TS" to ensure the tree is unqiue; further, "fName" is
-// concatenated with the name of the global variables, for uniqueness.
-// The list of global variables and how they are tied to the
-// scaler module and channels is defined here; eventually this
-// will be modified to use a scaler.map file
-// NOTE: if you don't have the scaler map file (e.g. Leftscalevt.map)
-// there will be no variable output to the Trees.
-//
-// To use in the analyzer, your setup script needs something like this
-// gHaEvtHandlers->Add (new THcScalerEvtHandler("HMS","HC scaler event type 0"));
-//
-// To enable debugging you may try this in the setup script
-//
-// THcScalerEvtHandler *hscaler = new THcScalerEvtHandler("HS","HC scaler event type 0");
-// hscaler->SetDebugFile("HScaler.txt");
-// gHaEvtHandlers->Add (hscaler);
-//
-/////////////////////////////////////////////////////////////////////
+/** \class THcScalerEvtHandler
+ \ingroup Base
+
+ Event handler for Hall C scalers
+
+
+ This class does the following
+ For a particular set of event types (here, event type 0)
+ decode the scalers and put some variables into global variables.
+ The global variables can then appear in the Podd output tree T.
+ In addition, a tree "TS" is created by this class; it contains
+ just the scaler data by itself. Note, the "fName" is concatenated
+ with "TS" to ensure the tree is unqiue; further, "fName" is
+ concatenated with the name of the global variables, for uniqueness.
+ The list of global variables and how they are tied to the
+ scaler module and channels is defined here; eventually this
+ will be modified to use a scaler.map file
+ NOTE: if you don't have the scaler map file (e.g. Leftscalevt.map)
+ there will be no variable output to the Trees.
+
+ To use in the analyzer, your setup script needs something like this
+ gHaEvtHandlers->Add (new THcScalerEvtHandler("HMS","HC scaler event type 0"));
+
+ To enable debugging you may try this in the setup script
+
+ THcScalerEvtHandler *hscaler = new THcScalerEvtHandler("HS","HC scaler event type 0");
+ hscaler->SetDebugFile("HScaler.txt");
+ gHaEvtHandlers->Add (hscaler);
+
+\author E. Brash based on THaScalerEvtHandler by R. Michaels
+*/
#include "THaEvtTypeHandler.h"
#include "THcScalerEvtHandler.h"
diff --git a/src/THcShowerHit.cxx b/src/THcShowerHit.cxx
index 7d46f05..514591c 100644
--- a/src/THcShowerHit.cxx
+++ b/src/THcShowerHit.cxx
@@ -1,3 +1,7 @@
+/** \classTHcShowerHit
+ \ingroup DetSupport
+
+*/
#include "THcShowerHit.h"
//ClassImp(THcShowerHit)
diff --git a/src/THcSignalHit.cxx b/src/THcSignalHit.cxx
index 8400419..5d2b7b7 100644
--- a/src/THcSignalHit.cxx
+++ b/src/THcSignalHit.cxx
@@ -1,10 +1,7 @@
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcSignalHit //
-// //
-// Class representing a single signal value and its wire/paddle number //
-// //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcSignalHit
+ \ingroup DetSupport
+
+*/
#include "THcSignalHit.h"
diff --git a/src/THcSpacePoint.cxx b/src/THcSpacePoint.cxx
index eb48ba8..f9dd04e 100644
--- a/src/THcSpacePoint.cxx
+++ b/src/THcSpacePoint.cxx
@@ -1,10 +1,9 @@
-///////////////////////////////////////////////////////////////////////////////
-// //
-// THcSpacePoint //
-// //
-// Class representing a single hit for the VDC //
-// //
-///////////////////////////////////////////////////////////////////////////////
+/** \class THcSpacePoint
+ \ingroup DetSupport
+
+ Class representing a single hit DC
+
+*/
#include "THcSpacePoint.h"
--
GitLab