Skip to content

Commit

Permalink
Doxygen-related cleanups (#355)
Browse files Browse the repository at this point in the history
  • Loading branch information
knopers8 authored Mar 23, 2020
1 parent c10d8ef commit 0d98915
Show file tree
Hide file tree
Showing 19 changed files with 28 additions and 39 deletions.
1 change: 0 additions & 1 deletion Modules/Common/src/TH2Reductor.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ const char* TH2Reductor::getBranchLeafList()

void TH2Reductor::update(TObject* obj)
{
// todo: use GetStats() instead?
auto histo = dynamic_cast<TH2*>(obj);
if (histo) {
histo->GetStats(mStats.sums.array);
Expand Down
2 changes: 1 addition & 1 deletion Modules/Daq/include/Daq/DaqTask.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Modules/EMCAL/include/EMCAL/DigitsQcTask.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions Modules/EMCAL/include/EMCAL/RawCheck.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Modules/EMCAL/include/EMCAL/RawTask.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Modules/Example/include/Example/ExampleTask.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Modules/MFT/include/MFT/BasicDigitQcTask.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 3 additions & 4 deletions Modules/Skeleton/include/Skeleton/SkeletonCheck.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

///
/// \file SkeletonCheck.h
/// \author Piotr Konopka
/// \author My Name
///

#ifndef QC_MODULE_SKELETON_SKELETONCHECK_H
Expand All @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions Modules/Skeleton/include/Skeleton/SkeletonPostProcessing.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down
9 changes: 3 additions & 6 deletions Modules/Skeleton/include/Skeleton/SkeletonTask.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@

///
/// \file SkeletonTask.h
/// \author Barthelemy von Haller
/// \author Piotr Konopka
/// \author My Name
///

#ifndef QC_MODULE_SKELETON_SKELETONTASK_H
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Modules/Skeleton/src/SkeletonCheck.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

///
/// \file SkeletonCheck.cxx
/// \author Piotr Konopka
/// \author My Name
///

#include "Skeleton/SkeletonCheck.h"
Expand Down
2 changes: 1 addition & 1 deletion Modules/Skeleton/src/SkeletonPostProcessing.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

///
/// \file PostProcessingInterface.cxx
/// \author Piotr Konopka
/// \author My Name
///

#include "Skeleton/SkeletonPostProcessing.h"
Expand Down
3 changes: 1 addition & 2 deletions Modules/Skeleton/src/SkeletonTask.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@

///
/// \file SkeletonTask.cxx
/// \author Barthelemy von Haller
/// \author Piotr Konopka
/// \author My Name
///

#include <TCanvas.h>
Expand Down
2 changes: 1 addition & 1 deletion Modules/Skeleton/test/.testEmpty.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

///
/// \file .testEmpty.cxx
/// \author
/// \author My Name
///

#include "QualityControl/TaskFactory.h"
Expand Down
4 changes: 1 addition & 3 deletions Modules/TOF/include/TOF/TOFDecoderCompressed.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions Modules/TOF/include/TOF/TOFTask.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions Modules/TOF/include/TOF/TOFTaskCompressed.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 3 additions & 4 deletions Modules/TPC/include/TPC/PID.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Modules/TPC/include/TPC/Tracks.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 0d98915

Please sign in to comment.