Make comments more descriptive

Author: andreasmolander

DataFormats/Detectors/FIT/FDD/include/DataFormatsFDD/RecPoint.h

@@ -33,10 +33,10 @@ struct ChannelDataFloat {
   static constexpr double DUMMY_CFD_TIME = -20000;
   static constexpr double DUMMY_QTC_AMPL = -20000;
 
-  int mPMNumber = DUMMY_CHANNEL_ID;   // channel Id
-  int adcId = DUMMY_CHAIN_QTC;        // QTC chain
-  double mTime = DUMMY_CFD_TIME;      // time in ps, 0 at the LHC clk center
-  double mChargeADC = DUMMY_QTC_AMPL; // charge [channels]
+  int mPMNumber = DUMMY_CHANNEL_ID;   ///< Channel ID
+  int adcId = DUMMY_CHAIN_QTC;        ///< Channel data bits
+  double mTime = DUMMY_CFD_TIME;      ///< Channel time (ns), 0 at the LHC clock center
+  double mChargeADC = DUMMY_QTC_AMPL; ///< Channel charge (ADC channels)
 
   ChannelDataFloat() = default;
   ChannelDataFloat(int Channel, double Time, double Charge, int AdcId)

DataFormats/Detectors/FIT/FT0/include/DataFormatsFT0/RecPoints.h

@@ -39,10 +39,10 @@ struct ChannelDataFloat {
   static constexpr float DUMMY_CFD_TIME = -20000;
   static constexpr float DUMMY_QTC_AMPL = -20000;
 
-  int ChId = DUMMY_CHANNEL_ID;    // channel Id
-  int ChainQTC = DUMMY_CHAIN_QTC; // QTC chain
-  float CFDTime = DUMMY_CFD_TIME; // time in ps, 0 at the LHC clk center
-  float QTCAmpl = DUMMY_QTC_AMPL; // Amplitude mV
+  int ChId = DUMMY_CHANNEL_ID;    ///< Channel ID
+  int ChainQTC = DUMMY_CHAIN_QTC; ///< Channel data bits
+  float CFDTime = DUMMY_CFD_TIME; ///< Channel time (ns), 0 at the LHC clock center
+  float QTCAmpl = DUMMY_QTC_AMPL; ///< Channel charge (ADC channels)
 
   ChannelDataFloat() = default;
   ChannelDataFloat(int iPmt, float time, float charge, int chainQTC)

DataFormats/Detectors/FIT/FV0/include/DataFormatsFV0/RecPoints.h

@@ -32,10 +32,10 @@ struct ChannelDataFloat {
   static constexpr double DUMMY_CFD_TIME = -20000.0;
   static constexpr double DUMMY_QTC_AMPL = -20000.0;
 
-  int channel = DUMMY_CHANNEL_ID; // channel Id
-  double time = DUMMY_CFD_TIME;   // time in ns, 0 at the LHC clk center
-  double charge = DUMMY_QTC_AMPL; // charge [channels]
-  int adcId = DUMMY_CHAIN_QTC;    // QTC chain
+  int channel = DUMMY_CHANNEL_ID; ///< Channel ID
+  double time = DUMMY_CFD_TIME;   ///< Channel time (ns), 0 at the LHC clock center
+  double charge = DUMMY_QTC_AMPL; ///< Channel charge (ADC channels)
+  int adcId = DUMMY_CHAIN_QTC;    ///< Channel data bits
 
   ChannelDataFloat() = default;
   ChannelDataFloat(int Channel, double Time, double Charge, int AdcId)

DataFormats/Detectors/FIT/common/include/DataFormatsFIT/ChannelDataBit.h

@@ -9,12 +9,13 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-/// \file EEventDataBit.h
-/// \brief Enum type describing bits in ChainQTC flag
+/// \file  ChannelDataBit.h
+/// \brief Enum type describing channel data bits
+///
 /// \author wiktor.pierozak@cern.ch
 
-#ifndef O2_FIT_EEVENT_DATA_BIT_
-#define O2_FIT_EEVENT_DATA_BIT_
+#ifndef O2_FIT_CHANNEL_DATA_BIT_
+#define O2_FIT_CHANNEL_DATA_BIT_
 
 namespace o2
 {