Merge pull request #731 in B2/basf2 from feature/BII-9189-add-doxygen-test-to-the-dqm-package_release to release/06-01

* commit 'b6a6e245c9c50570a8e43edec81f34afbd7ee1d0':
  Fix doxygen warnings.
  Add doxygen test to the dqm package.

Author: GiacomoXT

dqm/analysis/modules/include/DQMHistAnalysisEpicsExample.h

@@ -31,17 +31,39 @@ namespace Belle2 {
     // Public functions
   public:
 
-    //! Constructor / Destructor
+    /**
+     * Constructor.
+     */
     DQMHistAnalysisEpicsExampleModule();
+
+    /**
+     * Destructor.
+     */
     ~DQMHistAnalysisEpicsExampleModule();
 
-    //! Module functions to be called from main process
+    /**
+     * Initializer.
+     */
     void initialize() override final;
 
-    //! Module functions to be called from event process
+    /**
+     * Called when entering a new run.
+     */
     void beginRun() override final;
+
+    /**
+     * This method is called for each event.
+     */
     void event() override final;
+
+    /**
+     * This method is called if the current run ends.
+     */
     void endRun() override final;
+
+    /**
+     * This method is called at the end of the event processing.
+     */
     void terminate() override final;
 
     // Data members

dqm/analysis/modules/include/DQMHistAnalysisExample.h

@@ -25,17 +25,39 @@ namespace Belle2 {
     // Public functions
   public:
 
-    //! Constructor / Destructor
+    /**
+     * Constructor.
+     */
     DQMHistAnalysisExampleModule();
+
+    /**
+     * Destructor.
+     */
     virtual ~DQMHistAnalysisExampleModule();
 
-    //! Module functions to be called from main process
+    /**
+     * Initializer.
+     */
     virtual void initialize() override;
 
-    //! Module functions to be called from event process
+    /**
+     * Called when entering a new run.
+     */
     virtual void beginRun() override;
+
+    /**
+     * This method is called for each event.
+     */
     virtual void event() override;
+
+    /**
+     * This method is called if the current run ends.
+     */
     virtual void endRun() override;
+
+    /**
+     * This method is called at the end of the event processing.
+     */
     virtual void terminate() override;
 
     //! Parameters accesible from basf2 scripts

dqm/analysis/modules/include/DQMHistAnalysisExampleFlags.h

@@ -22,23 +22,39 @@ namespace Belle2 {
 
   class DQMHistAnalysisExampleFlagsModule : public DQMHistAnalysisModule {
 
-    // Public functions
   public:
 
-    //! Constructor / Destructor
+    /**
+     * Constructor.
+     */
     DQMHistAnalysisExampleFlagsModule();
-  private:
 
-    //! Module functions to be called from main process
+    /**
+     * Initializer.
+     */
     void initialize() override final;
 
-    //! Module functions to be called from event process
+    /**
+     * Called when entering a new run.
+     */
     void beginRun() override final;
+
+    /**
+     * This method is called for each event.
+     */
     void event() override final;
+
+    /**
+     * This method is called if the current run ends.
+     */
     void endRun() override final;
+
+    /**
+     * This method is called at the end of the event processing.
+     */
     void terminate() override final;
 
-    // Data members
+  private:
 
     /** The histogram for the test. */
     TH2F* m_hFlagtest = nullptr;

dqm/analysis/modules/include/DQMHistAnalysisHLTModule.h

@@ -24,10 +24,30 @@ namespace Belle2 {
    */
   class DQMHistAnalysisHLTModule : public DQMHistAnalysisModule {
   public:
+
+    /**
+     * Constructor.
+     */
     DQMHistAnalysisHLTModule();
+
+    /**
+     * Initializer.
+     */
     void initialize() final;
+
+    /**
+     * Called when entering a new run.
+     */
     void beginRun()  final;
+
+    /**
+     * This method is called for each event.
+     */
     void event() final;
+
+    /**
+     * This method is called at the end of the event processing.
+     */
     void terminate() final;
 
   private:

dqm/analysis/modules/include/DQMHistAnalysisIP.h

@@ -33,16 +33,34 @@ namespace Belle2 {
     // Public functions
   public:
 
-    //! Constructor / Destructor
+    /**
+     * Constructor.
+     */
     DQMHistAnalysisIPModule();
+
+    /**
+     * Destructor.
+     */
     ~DQMHistAnalysisIPModule();
 
-    //! Module functions to be called from main process
+    /**
+     * Initializer.
+     */
     void initialize() override final;
 
-    //! Module functions to be called from event process
+    /**
+     * Called when entering a new run.
+     */
     void beginRun() override final;
+
+    /**
+     * This method is called for each event.
+     */
     void event() override final;
+
+    /**
+     * This method is called at the end of the event processing.
+     */
     void terminate() override final;
 
     // Data members

dqm/analysis/modules/include/DQMHistAnalysisInput.h

@@ -33,17 +33,39 @@ namespace Belle2 {
     // Public functions
   public:
 
-    //! Constructor / Destructor
+    /**
+     * Constructor.
+     */
     DQMHistAnalysisInputModule();
+
+    /**
+     * Destructor.
+     */
     virtual ~DQMHistAnalysisInputModule();
 
-    //! Module functions to be called from main process
+    /**
+     * Initializer.
+     */
     virtual void initialize() override;
 
-    //! Module functions to be called from event process
+    /**
+     * Called when entering a new run.
+     */
     virtual void beginRun() override;
+
+    /**
+     * This method is called for each event.
+     */
     virtual void event() override;
+
+    /**
+     * This method is called if the current run ends.
+     */
     virtual void endRun() override;
+
+    /**
+     * This method is called at the end of the event processing.
+     */
     virtual void terminate() override;
 
     // Data members

dqm/analysis/modules/include/DQMHistAnalysisInputPVSrv.h

@@ -49,17 +49,39 @@ namespace Belle2 {
     // Public functions
   public:
 
-    //! Constructor / Destructor
+    /**
+     * Constructor.
+     */
     DQMHistAnalysisInputPVSrvModule();
+
+    /**
+     * Destructor.
+     */
     virtual ~DQMHistAnalysisInputPVSrvModule();
 
-    //! Module functions to be called from main process
+    /**
+     * Definition of the histograms.
+     */
     virtual void initialize() override;
 
-    //! Module functions to be called from event process
+    /**
+     * Called when entering a new run.
+     */
     virtual void beginRun() override;
+
+    /**
+     * This method is called for each event.
+     */
     virtual void event() override;
+
+    /**
+     * This method is called if the current run ends.
+     */
     virtual void endRun() override;
+
+    /**
+     * This method is called at the end of the event processing.
+     */
     virtual void terminate() override;
 
     // Data members

dqm/analysis/modules/include/DQMHistAnalysisInputSrv.h

@@ -29,17 +29,39 @@ namespace Belle2 {
     // Public functions
   public:
 
-    //! Constructor / Destructor
+    /**
+     * Constructor.
+     */
     DQMHistAnalysisInputSrvModule();
+
+    /**
+     * Destructor.
+     */
     virtual ~DQMHistAnalysisInputSrvModule();
 
-    //! Module functions to be called from main process
+    /**
+     * Initializer.
+     */
     virtual void initialize() override;
 
-    //! Module functions to be called from event process
+    /**
+     * Called when entering a new run.
+     */
     virtual void beginRun() override;
+
+    /**
+     * This method is called for each event.
+     */
     virtual void event() override;
+
+    /**
+     * This method is called if the current run ends.
+     */
     virtual void endRun() override;
+
+    /**
+     * This method is called at the end of the event processing.
+     */
     virtual void terminate() override;
 
     // Data members

dqm/analysis/modules/include/DQMHistAnalysisOutput.h

@@ -22,17 +22,39 @@ namespace Belle2 {
     // Public functions
   public:
 
-    //! Constructor / Destructor
+    /**
+     * Constructor.
+     */
     DQMHistAnalysisOutputModule();
+
+    /**
+     * Destructor.
+     */
     virtual ~DQMHistAnalysisOutputModule();
 
-    //! Module functions to be called from main process
+    /**
+     * Initializer.
+     */
     virtual void initialize() override;
 
-    //! Module functions to be called from event process
+    /**
+     * Called when entering a new run.
+     */
     virtual void beginRun() override;
+
+    /**
+     * This method is called for each event.
+     */
     virtual void event() override;
+
+    /**
+     * This method is called if the current run ends.
+     */
     virtual void endRun() override;
+
+    /**
+     * This method is called at the end of the event processing.
+     */
     virtual void terminate() override;
 
     // Data members