update documentation

Author: smorovic

EventFilter/Utilities/interface/DAQSource.h

@@ -1,6 +1,15 @@
 #ifndef EventFilter_Utilities_DAQSource_h
 #define EventFilter_Utilities_DAQSource_h
 
+/*
+ * DAQSource - modular input source supporting multiple
+ * buffering strategies and data formats. Specific formats are included
+ * as models defined as DataMode child class.
+ * Source supports DAQ file protocol using specific input file naming schema
+ * and JSON metadata files.
+ * See doc/READHME-DTH.md for more information, including file naming formats
+ */
+
 #include <condition_variable>
 #include <cstdio>
 #include <filesystem>

EventFilter/Utilities/interface/DAQSourceModels.h

@@ -1,6 +1,11 @@
 #ifndef EventFilter_Utilities_DAQSourceModels_h
 #define EventFilter_Utilities_DAQSourceModels_h
 
+/*
+ * Base class defining modular interface for DAQSource data models
+ * See doc/README-DTH.md for interface description
+ */
+
 #include <condition_variable>
 #include <cstdio>
 #include <filesystem>

EventFilter/Utilities/interface/DAQSourceModelsDTH.h

@@ -1,6 +1,17 @@
 #ifndef EventFilter_Utilities_DAQSourceModelsDTH_h
 #define EventFilter_Utilities_DAQSourceModelsDTH_h
 
+/*
+ * DAQ Source module for DTH readout
+ * Used by modular DAQSource to read files containing raw DTH orbit payload.
+ * Orbits are unpacked into individual events which are queued to the framework as FedRawDataCollection object.
+ * If more than one sourceID blocks is included they will all be unpacked, they need to be adjacent in the file
+ * for the same orbit. Exception to this is reading from multiple file sources,
+ * in that case that is only required locally in a file, but orbits need to come in the same order in all files.
+ * See test/RunBUFU.sh and test/testDTH.sh for example how to run with this module
+ * Also see documentation in doc/README=DTH.md
+*/
+
 #include <filesystem>
 #include <queue>
 #include <regex>

EventFilter/Utilities/interface/DAQSourceModelsFRD.h

@@ -1,6 +1,14 @@
 #ifndef EventFilter_Utilities_DAQSourceModelsFRD_h
 #define EventFilter_Utilities_DAQSourceModelsFRD_h
 
+/*
+* DAQSource data model classes for reading Run3 FRD format and unpacking into the FedRawDataCollection
+* FRD: standard readout of input from the event builder
+* FRDPreUNpack: variant unpacking events tns nto FedRawDataCollection class in reader threads
+* FRSStiped: more generic version able to read from multiple source
+* directories (Super-Fragmeng Builder DAQ)
+* */
+
 #include <filesystem>
 #include <queue>
 #include "oneapi/tbb/concurrent_unordered_set.h"
@@ -10,6 +18,10 @@
 
 class FEDRawDataCollection;
 
+/*
+ * FRD unpacker equivalent to the FedRawDataInputSource
+ */
+
 class DataModeFRD : public DataMode {
 public:
   DataModeFRD(DAQSource* daqSource, bool verifyFEDs) : DataMode(daqSource), verifyFEDs_(verifyFEDs) {}
@@ -91,7 +103,7 @@ class DataModeFRD : public DataMode {
 };
 
 /*
- * FRD source prebuffering in reader thread
+ * FRD source prebuffering in the reader thread
  */
 
 class DataModeFRDPreUnpack : public DataMode {
@@ -176,7 +188,7 @@ class DataModeFRDPreUnpack : public DataMode {
 };
 
 /* 
- * FRD source reading files from multiple striped destinations
+ * FRD source reading files from multiple striped destinations (Super-Fragment Builder DAQ)
  *
  * */