From 0d9891507014781f02eaa1f7a0076fccbe43b5a2 Mon Sep 17 00:00:00 2001 From: knopers8 Date: Mon, 23 Mar 2020 13:50:29 +0100 Subject: [PATCH] Doxygen-related cleanups (#355) --- Modules/Common/src/TH2Reductor.cxx | 1 - Modules/Daq/include/Daq/DaqTask.h | 2 +- Modules/EMCAL/include/EMCAL/DigitsQcTask.h | 2 +- Modules/EMCAL/include/EMCAL/RawCheck.h | 6 +++--- Modules/EMCAL/include/EMCAL/RawTask.h | 2 +- Modules/Example/include/Example/ExampleTask.h | 2 +- Modules/MFT/include/MFT/BasicDigitQcTask.h | 2 +- Modules/Skeleton/include/Skeleton/SkeletonCheck.h | 7 +++---- .../Skeleton/include/Skeleton/SkeletonPostProcessing.h | 6 +++--- Modules/Skeleton/include/Skeleton/SkeletonTask.h | 9 +++------ Modules/Skeleton/src/SkeletonCheck.cxx | 2 +- Modules/Skeleton/src/SkeletonPostProcessing.cxx | 2 +- Modules/Skeleton/src/SkeletonTask.cxx | 3 +-- Modules/Skeleton/test/.testEmpty.cxx | 2 +- Modules/TOF/include/TOF/TOFDecoderCompressed.h | 4 +--- Modules/TOF/include/TOF/TOFTask.h | 3 +-- Modules/TOF/include/TOF/TOFTaskCompressed.h | 3 +-- Modules/TPC/include/TPC/PID.h | 7 +++---- Modules/TPC/include/TPC/Tracks.h | 2 +- 19 files changed, 28 insertions(+), 39 deletions(-) diff --git a/Modules/Common/src/TH2Reductor.cxx b/Modules/Common/src/TH2Reductor.cxx index 892eeac7f1..d9a6d5b2eb 100644 --- a/Modules/Common/src/TH2Reductor.cxx +++ b/Modules/Common/src/TH2Reductor.cxx @@ -31,7 +31,6 @@ const char* TH2Reductor::getBranchLeafList() void TH2Reductor::update(TObject* obj) { - // todo: use GetStats() instead? auto histo = dynamic_cast(obj); if (histo) { histo->GetStats(mStats.sums.array); diff --git a/Modules/Daq/include/Daq/DaqTask.h b/Modules/Daq/include/Daq/DaqTask.h index f0b43bbaa3..b3daddb6d9 100644 --- a/Modules/Daq/include/Daq/DaqTask.h +++ b/Modules/Daq/include/Daq/DaqTask.h @@ -32,7 +32,7 @@ namespace o2::quality_control_modules::daq /// \brief Example Quality Control Task /// It is final because there is no reason to derive from it. Just remove it if needed. /// \author Barthelemy von Haller -class DaqTask /*final*/ : public TaskInterface // todo add back the "final" when doxygen is fixed +class DaqTask final : public TaskInterface { public: /// \brief Constructor diff --git a/Modules/EMCAL/include/EMCAL/DigitsQcTask.h b/Modules/EMCAL/include/EMCAL/DigitsQcTask.h index 7d39a0beac..b7b6550197 100644 --- a/Modules/EMCAL/include/EMCAL/DigitsQcTask.h +++ b/Modules/EMCAL/include/EMCAL/DigitsQcTask.h @@ -33,7 +33,7 @@ namespace emcal /// Monitoring observables: /// - Digit amplitude for different towers /// - Digit time for different towers -class DigitsQcTask /*final*/ : public TaskInterface // todo add back the "final" when doxygen is fixed +class DigitsQcTask final : public TaskInterface { public: /// \brief Constructor diff --git a/Modules/EMCAL/include/EMCAL/RawCheck.h b/Modules/EMCAL/include/EMCAL/RawCheck.h index cd950cb085..2e8b3644e0 100644 --- a/Modules/EMCAL/include/EMCAL/RawCheck.h +++ b/Modules/EMCAL/include/EMCAL/RawCheck.h @@ -25,10 +25,10 @@ using namespace o2::quality_control::core; namespace o2::quality_control_modules::emcal { -/// \brief Example Quality Control DPL Task +/// \brief EMCAL raw data check /// It is final because there is no reason to derive from it. Just remove it if needed. -/// \author Barthelemy von Haller -class RawCheck /*final*/ : public o2::quality_control::checker::CheckInterface // todo add back the "final" when doxygen is fixed +/// \author Cristina Terrevoli +class RawCheck final : public o2::quality_control::checker::CheckInterface { public: /// Default constructor diff --git a/Modules/EMCAL/include/EMCAL/RawTask.h b/Modules/EMCAL/include/EMCAL/RawTask.h index 7d0adcc916..d60c4819e3 100644 --- a/Modules/EMCAL/include/EMCAL/RawTask.h +++ b/Modules/EMCAL/include/EMCAL/RawTask.h @@ -35,7 +35,7 @@ namespace o2::quality_control_modules::emcal /// It is final because there is no reason to derive from it. Just remove it if needed. /// \author Barthelemy von Haller /// \author Piotr Konopka -class RawTask /*final*/ : public TaskInterface // todo add back the "final" when doxygen is fixed +class RawTask final : public TaskInterface { public: /// \brief Constructor diff --git a/Modules/Example/include/Example/ExampleTask.h b/Modules/Example/include/Example/ExampleTask.h index fbe212b961..a2988fd550 100644 --- a/Modules/Example/include/Example/ExampleTask.h +++ b/Modules/Example/include/Example/ExampleTask.h @@ -18,7 +18,7 @@ namespace o2::quality_control_modules::example /// \brief Example Quality Control Task /// It is final because there is no reason to derive from it. Just remove it if needed. /// \author Barthelemy von Haller -class ExampleTask /*final*/ : public TaskInterface // todo add back the "final" when doxygen is fixed +class ExampleTask final : public TaskInterface { public: /// \brief Constructor diff --git a/Modules/MFT/include/MFT/BasicDigitQcTask.h b/Modules/MFT/include/MFT/BasicDigitQcTask.h index 14697f256b..3627b131c8 100644 --- a/Modules/MFT/include/MFT/BasicDigitQcTask.h +++ b/Modules/MFT/include/MFT/BasicDigitQcTask.h @@ -30,7 +30,7 @@ namespace o2::quality_control_modules::mft /// /// \author Tomas Herman /// \author Guillermo Contreras -class BasicDigitQcTask /*final*/ : public TaskInterface // todo add back the "final" when doxygen is fixed +class BasicDigitQcTask final : public TaskInterface { public: /// \brief Constructor diff --git a/Modules/Skeleton/include/Skeleton/SkeletonCheck.h b/Modules/Skeleton/include/Skeleton/SkeletonCheck.h index ed614585e5..7ec5fc3032 100644 --- a/Modules/Skeleton/include/Skeleton/SkeletonCheck.h +++ b/Modules/Skeleton/include/Skeleton/SkeletonCheck.h @@ -10,7 +10,7 @@ /// /// \file SkeletonCheck.h -/// \author Piotr Konopka +/// \author My Name /// #ifndef QC_MODULE_SKELETON_SKELETONCHECK_H @@ -21,9 +21,8 @@ namespace o2::quality_control_modules::skeleton { -/// \brief Check whether a plot is empty or not. -/// -/// \author Barthelemy von Haller +/// \brief Example QC Check +/// \author My Name class SkeletonCheck : public o2::quality_control::checker::CheckInterface { public: diff --git a/Modules/Skeleton/include/Skeleton/SkeletonPostProcessing.h b/Modules/Skeleton/include/Skeleton/SkeletonPostProcessing.h index acafdac2ae..30b198566f 100644 --- a/Modules/Skeleton/include/Skeleton/SkeletonPostProcessing.h +++ b/Modules/Skeleton/include/Skeleton/SkeletonPostProcessing.h @@ -9,8 +9,8 @@ // or submit itself to any jurisdiction. /// -/// \file SkeletonPostProcessing.cxx -/// \author Piotr Konopka +/// \file SkeletonPostProcessing.h +/// \author My Name /// #ifndef QUALITYCONTROL_SKELETONPOSTPROCESSING_H @@ -24,7 +24,7 @@ namespace o2::quality_control_modules::skeleton { /// \brief Example Quality Control Postprocessing Task -/// \author Piotr Konopka +/// \author My Name class SkeletonPostProcessing final : public quality_control::postprocessing::PostProcessingInterface { public: diff --git a/Modules/Skeleton/include/Skeleton/SkeletonTask.h b/Modules/Skeleton/include/Skeleton/SkeletonTask.h index 94e23527fa..5d9235618d 100644 --- a/Modules/Skeleton/include/Skeleton/SkeletonTask.h +++ b/Modules/Skeleton/include/Skeleton/SkeletonTask.h @@ -10,8 +10,7 @@ /// /// \file SkeletonTask.h -/// \author Barthelemy von Haller -/// \author Piotr Konopka +/// \author My Name /// #ifndef QC_MODULE_SKELETON_SKELETONTASK_H @@ -27,10 +26,8 @@ namespace o2::quality_control_modules::skeleton { /// \brief Example Quality Control DPL Task -/// It is final because there is no reason to derive from it. Just remove it if needed. -/// \author Barthelemy von Haller -/// \author Piotr Konopka -class SkeletonTask /*final*/ : public TaskInterface // todo add back the "final" when doxygen is fixed +/// \author My Name +class SkeletonTask final : public TaskInterface { public: /// \brief Constructor diff --git a/Modules/Skeleton/src/SkeletonCheck.cxx b/Modules/Skeleton/src/SkeletonCheck.cxx index 18d0814803..8820859c48 100644 --- a/Modules/Skeleton/src/SkeletonCheck.cxx +++ b/Modules/Skeleton/src/SkeletonCheck.cxx @@ -10,7 +10,7 @@ /// /// \file SkeletonCheck.cxx -/// \author Piotr Konopka +/// \author My Name /// #include "Skeleton/SkeletonCheck.h" diff --git a/Modules/Skeleton/src/SkeletonPostProcessing.cxx b/Modules/Skeleton/src/SkeletonPostProcessing.cxx index 4e18cccad0..6d660c45be 100644 --- a/Modules/Skeleton/src/SkeletonPostProcessing.cxx +++ b/Modules/Skeleton/src/SkeletonPostProcessing.cxx @@ -10,7 +10,7 @@ /// /// \file PostProcessingInterface.cxx -/// \author Piotr Konopka +/// \author My Name /// #include "Skeleton/SkeletonPostProcessing.h" diff --git a/Modules/Skeleton/src/SkeletonTask.cxx b/Modules/Skeleton/src/SkeletonTask.cxx index 9b3e065751..c569b6ec18 100644 --- a/Modules/Skeleton/src/SkeletonTask.cxx +++ b/Modules/Skeleton/src/SkeletonTask.cxx @@ -10,8 +10,7 @@ /// /// \file SkeletonTask.cxx -/// \author Barthelemy von Haller -/// \author Piotr Konopka +/// \author My Name /// #include diff --git a/Modules/Skeleton/test/.testEmpty.cxx b/Modules/Skeleton/test/.testEmpty.cxx index ab0afdd1c1..c7e535cb41 100644 --- a/Modules/Skeleton/test/.testEmpty.cxx +++ b/Modules/Skeleton/test/.testEmpty.cxx @@ -10,7 +10,7 @@ /// /// \file .testEmpty.cxx -/// \author +/// \author My Name /// #include "QualityControl/TaskFactory.h" diff --git a/Modules/TOF/include/TOF/TOFDecoderCompressed.h b/Modules/TOF/include/TOF/TOFDecoderCompressed.h index de8ea87f97..205f46ecdd 100644 --- a/Modules/TOF/include/TOF/TOFDecoderCompressed.h +++ b/Modules/TOF/include/TOF/TOFDecoderCompressed.h @@ -30,9 +30,7 @@ namespace o2::quality_control_modules::tof /// \brief TOF Quality Control class for Decoding Compressed data for TOF Compressed data QC Task /// \author Nicolo' Jacazio -class TOFDecoderCompressed /*final*/ - : public DecoderBase -// todo add back the "final" when doxygen is fixed +class TOFDecoderCompressed final : public DecoderBase { public: /// \brief Constructor diff --git a/Modules/TOF/include/TOF/TOFTask.h b/Modules/TOF/include/TOF/TOFTask.h index 4292b70119..19152a055c 100644 --- a/Modules/TOF/include/TOF/TOFTask.h +++ b/Modules/TOF/include/TOF/TOFTask.h @@ -30,8 +30,7 @@ namespace o2::quality_control_modules::tof /// \brief TOF Quality Control DPL Task /// \author Nicolo' Jacazio -class TOFTask /*final*/ - : public TaskInterface // todo add back the "final" when doxygen is fixed +class TOFTask final : public TaskInterface { public: /// \brief Constructor diff --git a/Modules/TOF/include/TOF/TOFTaskCompressed.h b/Modules/TOF/include/TOF/TOFTaskCompressed.h index 0e3d09dc46..8eb91c6cd4 100644 --- a/Modules/TOF/include/TOF/TOFTaskCompressed.h +++ b/Modules/TOF/include/TOF/TOFTaskCompressed.h @@ -32,8 +32,7 @@ namespace o2::quality_control_modules::tof /// \brief TOF Quality Control DPL Task for TOF Compressed data /// \author Nicolo' Jacazio -class TOFTaskCompressed /*final*/ - : public TaskInterface // todo add back the "final" when doxygen is fixed +class TOFTaskCompressed final : public TaskInterface { public: /// \brief Constructor diff --git a/Modules/TPC/include/TPC/PID.h b/Modules/TPC/include/TPC/PID.h index b9d59599fc..30877b145f 100644 --- a/Modules/TPC/include/TPC/PID.h +++ b/Modules/TPC/include/TPC/PID.h @@ -29,11 +29,10 @@ using namespace o2::quality_control::core; namespace o2::quality_control_modules::tpc { -/// \brief Example Quality Control DPL Task +/// \brief TPC PID QC Task /// It is final because there is no reason to derive from it. Just remove it if needed. -/// \author Barthelemy von Haller -/// \author Piotr Konopka -class PID /*final*/ : public TaskInterface // todo add back the "final" when doxygen is fixed +/// \author Jens Wiechula +class PID final : public TaskInterface { public: /// \brief Constructor diff --git a/Modules/TPC/include/TPC/Tracks.h b/Modules/TPC/include/TPC/Tracks.h index 4d9bd2cec2..b3e648ab07 100644 --- a/Modules/TPC/include/TPC/Tracks.h +++ b/Modules/TPC/include/TPC/Tracks.h @@ -30,7 +30,7 @@ namespace o2::quality_control_modules::tpc /// \brief Quality Control DPL Task for QC Module TPC for track related observables /// \author Stefan Heckel -class Tracks /*final*/ : public TaskInterface // todo add back the "final" when doxygen is fixed +class Tracks final : public TaskInterface { public: /// \brief Constructor