Skip to content

Commit 0d98915

Browse files
authored
Doxygen-related cleanups (#355)
1 parent c10d8ef commit 0d98915

19 files changed

Lines changed: 28 additions & 39 deletions

File tree

Modules/Common/src/TH2Reductor.cxx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ const char* TH2Reductor::getBranchLeafList()
3131

3232
void TH2Reductor::update(TObject* obj)
3333
{
34-
// todo: use GetStats() instead?
3534
auto histo = dynamic_cast<TH2*>(obj);
3635
if (histo) {
3736
histo->GetStats(mStats.sums.array);

Modules/Daq/include/Daq/DaqTask.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ namespace o2::quality_control_modules::daq
3232
/// \brief Example Quality Control Task
3333
/// It is final because there is no reason to derive from it. Just remove it if needed.
3434
/// \author Barthelemy von Haller
35-
class DaqTask /*final*/ : public TaskInterface // todo add back the "final" when doxygen is fixed
35+
class DaqTask final : public TaskInterface
3636
{
3737
public:
3838
/// \brief Constructor

Modules/EMCAL/include/EMCAL/DigitsQcTask.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ namespace emcal
3333
/// Monitoring observables:
3434
/// - Digit amplitude for different towers
3535
/// - Digit time for different towers
36-
class DigitsQcTask /*final*/ : public TaskInterface // todo add back the "final" when doxygen is fixed
36+
class DigitsQcTask final : public TaskInterface
3737
{
3838
public:
3939
/// \brief Constructor

Modules/EMCAL/include/EMCAL/RawCheck.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ using namespace o2::quality_control::core;
2525
namespace o2::quality_control_modules::emcal
2626
{
2727

28-
/// \brief Example Quality Control DPL Task
28+
/// \brief EMCAL raw data check
2929
/// It is final because there is no reason to derive from it. Just remove it if needed.
30-
/// \author Barthelemy von Haller
31-
class RawCheck /*final*/ : public o2::quality_control::checker::CheckInterface // todo add back the "final" when doxygen is fixed
30+
/// \author Cristina Terrevoli
31+
class RawCheck final : public o2::quality_control::checker::CheckInterface
3232
{
3333
public:
3434
/// Default constructor

Modules/EMCAL/include/EMCAL/RawTask.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ namespace o2::quality_control_modules::emcal
3535
/// It is final because there is no reason to derive from it. Just remove it if needed.
3636
/// \author Barthelemy von Haller
3737
/// \author Piotr Konopka
38-
class RawTask /*final*/ : public TaskInterface // todo add back the "final" when doxygen is fixed
38+
class RawTask final : public TaskInterface
3939
{
4040
public:
4141
/// \brief Constructor

Modules/Example/include/Example/ExampleTask.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ namespace o2::quality_control_modules::example
1818
/// \brief Example Quality Control Task
1919
/// It is final because there is no reason to derive from it. Just remove it if needed.
2020
/// \author Barthelemy von Haller
21-
class ExampleTask /*final*/ : public TaskInterface // todo add back the "final" when doxygen is fixed
21+
class ExampleTask final : public TaskInterface
2222
{
2323
public:
2424
/// \brief Constructor

Modules/MFT/include/MFT/BasicDigitQcTask.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ namespace o2::quality_control_modules::mft
3030
///
3131
/// \author Tomas Herman
3232
/// \author Guillermo Contreras
33-
class BasicDigitQcTask /*final*/ : public TaskInterface // todo add back the "final" when doxygen is fixed
33+
class BasicDigitQcTask final : public TaskInterface
3434
{
3535
public:
3636
/// \brief Constructor

Modules/Skeleton/include/Skeleton/SkeletonCheck.h

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
///
1212
/// \file SkeletonCheck.h
13-
/// \author Piotr Konopka
13+
/// \author My Name
1414
///
1515

1616
#ifndef QC_MODULE_SKELETON_SKELETONCHECK_H
@@ -21,9 +21,8 @@
2121
namespace o2::quality_control_modules::skeleton
2222
{
2323

24-
/// \brief Check whether a plot is empty or not.
25-
///
26-
/// \author Barthelemy von Haller
24+
/// \brief Example QC Check
25+
/// \author My Name
2726
class SkeletonCheck : public o2::quality_control::checker::CheckInterface
2827
{
2928
public:

Modules/Skeleton/include/Skeleton/SkeletonPostProcessing.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
// or submit itself to any jurisdiction.
1010

1111
///
12-
/// \file SkeletonPostProcessing.cxx
13-
/// \author Piotr Konopka
12+
/// \file SkeletonPostProcessing.h
13+
/// \author My Name
1414
///
1515

1616
#ifndef QUALITYCONTROL_SKELETONPOSTPROCESSING_H
@@ -24,7 +24,7 @@ namespace o2::quality_control_modules::skeleton
2424
{
2525

2626
/// \brief Example Quality Control Postprocessing Task
27-
/// \author Piotr Konopka
27+
/// \author My Name
2828
class SkeletonPostProcessing final : public quality_control::postprocessing::PostProcessingInterface
2929
{
3030
public:

Modules/Skeleton/include/Skeleton/SkeletonTask.h

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@
1010

1111
///
1212
/// \file SkeletonTask.h
13-
/// \author Barthelemy von Haller
14-
/// \author Piotr Konopka
13+
/// \author My Name
1514
///
1615

1716
#ifndef QC_MODULE_SKELETON_SKELETONTASK_H
@@ -27,10 +26,8 @@ namespace o2::quality_control_modules::skeleton
2726
{
2827

2928
/// \brief Example Quality Control DPL Task
30-
/// It is final because there is no reason to derive from it. Just remove it if needed.
31-
/// \author Barthelemy von Haller
32-
/// \author Piotr Konopka
33-
class SkeletonTask /*final*/ : public TaskInterface // todo add back the "final" when doxygen is fixed
29+
/// \author My Name
30+
class SkeletonTask final : public TaskInterface
3431
{
3532
public:
3633
/// \brief Constructor

0 commit comments

Comments
 (0)