improve documentation

rest-for-physics · Jan 17, 2025 · 3b7f7a0 · 3b7f7a0
1 parent e2a6eb5
commit 3b7f7a0
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/source/framework/analysis/src/TRestEventTimeSelectionProcess.cxx b/source/framework/analysis/src/TRestEventTimeSelectionProcess.cxx
@@ -151,6 +151,11 @@ void TRestEventTimeSelectionProcess::InitProcess() {
     fNEventsSelected = 0;
 }
 
+///////////////////////////////////////////////
+/// \brief Function to calculate the total time in seconds of all the time ranges
+/// (active or dead periods of time). It takes into account the time offset,
+/// and both the start and end margins.
+///
 Double_t TRestEventTimeSelectionProcess::CalculateTotalTimeInSeconds() {
     Double_t totalTime = 0;
     for (auto id : fStartEndTimes) {