docs: Fix some Doxygen warnings

FairRootGroup · Mar 29, 2023 · 01849fd · 01849fd
1 parent e05679b
commit 01849fd
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 11 deletions.
diff --git a/examples/common/mcstack/FairStack.h b/examples/common/mcstack/FairStack.h
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2014-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ * Copyright (C) 2014-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -174,7 +174,6 @@ class FairStack : public FairGenericStack
     void Register() override;
 
     /** Output to screen
-     **@param iVerbose: 0=events summary, 1=track info
      **/
     void Print(Option_t*) const override;
 

diff --git a/fairroot/base/steer/FairTrajFilter.h b/fairroot/base/steer/FairTrajFilter.h
@@ -1,5 +1,5 @@
 /********************************************************************************
- *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ * Copyright (C) 2014-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -253,7 +253,8 @@ class FairTrajFilter
 
     /**
      * This is the getter for the total energy cut.
-     * @param References to the variables where return values should be stored.
+     *
+     * \param [out] etotMin,etotMax References to the variables where return values should be stored.
      */
     void GetEnergyCut(Double_t& etotMin, Double_t& etotMax) const;
 

diff --git a/fairroot/eventdisplay/FairHitDraw.h b/fairroot/eventdisplay/FairHitDraw.h
@@ -1,5 +1,5 @@
 /********************************************************************************
- *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ * Copyright (C) 2014-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -22,8 +22,6 @@
 #include <Rtypes.h>     // for FairHitDraw::Class, etc
 #include <TVector3.h>   // for TVector3
 
-class TObject;
-
 class FairHitDraw : public FairBoxSetDraw
 {
   public:
@@ -38,7 +36,6 @@ class FairHitDraw : public FairBoxSetDraw
 
     /** Legacy constructor
      *@param name        Name of task
-     *@param dataSource  Input container for data to be displayed
      *@param iVerbose    Verbosity level
      **/
     FairHitDraw(const char* name, Int_t iVerbose = 1);

diff --git a/fairroot/generators/FairUrqmdGenerator.h b/fairroot/generators/FairUrqmdGenerator.h
@@ -1,5 +1,5 @@
 /********************************************************************************
- *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ * Copyright (C) 2014-2023 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -55,8 +55,6 @@ class FairUrqmdGenerator : public FairGenerator
 
     /** Reads on event from the input file and pushes the tracks onto
      ** the stack. Abstract method in base class.
-     ** @param pStack    pointer to the stack
-     ** @param ver       not used
      **/
     Bool_t ReadEvent(FairPrimaryGenerator* primGen);