add doxygen style comments

Author: VCLanNguyen

sbnanaobj/StandardRecord/SRSBNDFrameShiftInfo.cxx

@@ -1,6 +1,10 @@
-////////////////////////////////////////////////////////////////////////
-// \file    SRSBNDFrame.cxx
-////////////////////////////////////////////////////////////////////////
+/*
+ * @file   /sbnanaobj/StandardRecord/SRSBNDFrameShiftInfo.cxx
+ * @brief  Defines CAF data structures to store sbnd::timing::FrameShiftInfo (docdb#43090).
+ * @author Vu Chi Lan Nguyen
+ * @date   August 29, 2025
+ *
+ */
 
 #include "sbnanaobj/StandardRecord/SRSBNDFrameShiftInfo.h"
 

sbnanaobj/StandardRecord/SRSBNDFrameShiftInfo.h

@@ -1,27 +1,38 @@
-////////////////////////////////////////////////////////////////////////
-// \file    SRSBNDFrameShiftInfo.h
-////////////////////////////////////////////////////////////////////////
+/*
+ * @file   /sbnanaobj/StandardRecord/SRSBNDFrameShiftInfo.h
+ * @brief  Defines CAF data structures to store sbnd::timing::FrameShiftInfo (docdb#43090).
+ * @author Vu Chi Lan Nguyen
+ * @date   August 29, 2025
+ *
+ */
+
 #ifndef SRSBNDFRAMESHIFTINFO_H
 #define SRSBNDFRAMESHIFTINFO_H
 
 #include <cstdint>
 namespace caf
 {
+  /*
+   * @brief A struct to store shifts across different reference frames from sbnd::timing::FrameShiftInfo for SBND Data
+   *
+   * Each shift is in [ns]
+   *
+   */
+
   class SRSBNDFrameShiftInfo
     {
     public:
       SRSBNDFrameShiftInfo();
       virtual ~SRSBNDFrameShiftInfo() {}
 
-      uint16_t timingType;
-      double frameTdcCrtt1;
-      double frameTdcBes;
-      double frameTdcRwm;
-      double frameHltCrtt1;
-      double frameHltBeamGate;
-      double frameApplyAtCaf;
+      uint16_t timingType; ///< Types of decoded frames: 0 - SPEC TDC ETRIG, 1 - HLT ETRIG, 2 - Do Nothing
+      double frameTdcCrtt1; ///< Shift from decoded frame to SPEC-TDC CRT T1 [ns]
+      double frameTdcBes; ///< Shift from decoded frame to SPEC-TDC BES [ns]
+      double frameTdcRwm; ///< Shift from decoded frame to SPEC-TDC RWM [ns]
+      double frameHltCrtt1; ///< Shift from decoded frame to HLT CRT T1 [ns]
+      double frameHltBeamGate; ///< Shift from decoded frame to HLT Beam Gate [ns]
+      double frameApplyAtCaf; ///< Frame to shift to when running at CAF stage
     };
 } // end namespace
-
 #endif // SRSBNDFRAMESHIFTINFO_H
 //////////////////////////////////////////////////////////////////////////////

sbnanaobj/StandardRecord/SRSBNDTimingInfo.cxx

@@ -1,6 +1,10 @@
-////////////////////////////////////////////////////////////////////////
-// \file    SRSBNDTimingInfo.cxx
-////////////////////////////////////////////////////////////////////////
+/*
+ * @file   /sbnanaobj/StandardRecord/SRSBNDTimingInfo.cxx
+ * @brief  Defines CAF data structures to store sbnd::timing::TimingInfo (docdb#43090).
+ * @author Vu Chi Lan Nguyen
+ * @date   August 29, 2025
+ *
+ */
 
 #include "sbnanaobj/StandardRecord/SRSBNDTimingInfo.h"
 

sbnanaobj/StandardRecord/SRSBNDTimingInfo.h

@@ -1,29 +1,40 @@
-////////////////////////////////////////////////////////////////////////
-// \file    SRSBNDTimingInfo.h
-////////////////////////////////////////////////////////////////////////
-#ifndef SRSBNDFRAME_H
-#define SRSBNDFRAME_H
+/*
+ * @file   /sbnanaobj/StandardRecord/SRSBNDTimingInfo.h
+ * @brief  Defines CAF data structures to store sbnd::timing::TimingInfo (docdb#43090).
+ * @author Vu Chi Lan Nguyen
+ * @date   August 29, 2025
+ *
+ */
+    
+#ifndef SRSBNDTIMINGINFO_H
+#define SRSBNDTIMINGINFO_H
 
 #include <stdint.h>
 
 namespace caf
 {
+  /*
+   * @brief A struct to store important timestamps from sbnd::timing::TimingInfo for SBND data
+   *
+   * Each timestamp is in UNIX Timestamp Format [ns]
+   *
+   */
+
   class SRSBNDTimingInfo
     {
     public:
       SRSBNDTimingInfo();
       virtual ~SRSBNDTimingInfo() {}
 
-      uint64_t rawDAQHeaderTimestamp;
-      uint64_t tdcCrtt1;
-      uint64_t tdcBes;
-      uint64_t tdcRwm;
-      uint64_t tdcEtrig;
-      uint64_t hltCrtt1;
-      uint64_t hltEtrig;
-      uint64_t hltBeamGate;
+      uint64_t rawDAQHeaderTimestamp; ///< Timestamp when the event is built by the event builder at DAQ-level
+      uint64_t tdcCrtt1; ///< Timestamp of BNB stream CRT T1 Reset recorded by the SPEC-TDC
+      uint64_t tdcBes; ///< Timestamp of BES signal sent by MFTU recorded by the SPEC-TDC
+      uint64_t tdcRwm; ///< Timestamp of RWM signal recorded by the SPEC-TDC
+      uint64_t tdcEtrig; ///< Timestamp of Event Trigger (ETRIG) sent by the PTB recorded by the SPEC-TDC 
+      uint64_t hltCrtt1; ///< Timestamp of BNB and Offbeam stream CRT T1 Reset High Level Trigger (HLT) created by the PTB
+      uint64_t hltEtrig; ///< Timestamp of ETRIG HLT created by the PTB
+      uint64_t hltBeamGate; ///< Timestamp of Beam Gate Acceptance HLT created by the PTB
     };
 } // end namespace
-
-#endif // SRSBNDFRAME_H
+#endif // SRSBNDTIMINGINFO_H
 //////////////////////////////////////////////////////////////////////////////

sbnanaobj/StandardRecord/StandardRecord.h

@@ -59,9 +59,8 @@ namespace caf
     int                        ncrtpmt_matches; ///<Number of CRT-PMT Matches in event 
     std::vector<SRCRTPMTMatch> crtpmt_matches;  ///< CRT-PMT matches in event 
     bool pass_flashtrig;     ///< Whether this Record passed the Flash Trigger requirement
-    SRSBNDFrameShiftInfo sbnd_frames; ///< List of Frame Shift in event (SBND)
-    SRSBNDTimingInfo sbnd_timings; ///< List of Timing Info in event in Unix format(SBND)
-    
+    SRSBNDFrameShiftInfo sbnd_frames; ///< List of Frame Shift in event in unit [ns] (SBND)
+    SRSBNDTimingInfo sbnd_timings; ///< List of Timing Info in event in UNIX timestamp format(SBND)
 
   };