[EMCAL-622][Doxygen] Minor fixes of params and commands

mfasDa · davidrohr · commit d8aa51ab0f0a · 2020-02-05T20:17:51.000+01:00
diff --git a/Detectors/EMCAL/base/include/EMCALBase/Geometry.h b/Detectors/EMCAL/base/include/EMCALBase/Geometry.h
@@ -45,7 +45,6 @@ class Geometry
 
   /// \brief Constructor for normal use.
   /// \param name Name of the geometry (see table for options)
-  /// \param title Geometry title
   /// \param mcname Geant3/4, Flukla, needed for settings of transport
   /// \param mctitle Geant4 physics list
   ///
@@ -74,9 +73,8 @@ class Geometry
 
   /// \brief Get instance of the EMCAL geometry
   /// \param name Geometry name (see constructor for definition)
-  /// \param title Geometry title
   /// \param mcname Geant3/4, Fluka, needed for settings of transport
-  /// \param mctitle: Geant4 physics list
+  /// \param mctitle Geant4 physics list
   /// \return the pointer of the unique instance of the geometry
   ///
   /// Also initializes the geometry if
@@ -88,8 +86,8 @@ class Geometry
   /// \brief Instanciate geometry depending on the run number. Mostly used in analysis and MC anchors.
   /// \param runNumber as indicated
   /// \param geoName Geometry name, see constructor for options
-  /// \param mcname: Geant3/4, Fluka, needed for settings of transport (check). Not really needed to be specified.
-  /// \param mctitle:  Geant4 physics list (check). Not really needed to be specified.
+  /// \param mcname Geant3/4, Fluka, needed for settings of transport (check). Not really needed to be specified.
+  /// \param mctitle Geant4 physics list (check). Not really needed to be specified.
   /// \return the pointer of the unique instance
   static Geometry* GetInstanceFromRunNumber(Int_t runNumber, const std::string_view = "",
                                             const std::string_view mcname = "TGeant3",
@@ -133,11 +131,11 @@ class Geometry
   Bool_t Impact(const TParticle* particle) const;
 
   /// \brief Get the impact coordinates on EMCAL
-  /// \param vtx[in] TVector3 with vertex
-  /// \param theta[in] theta location
-  /// \param phi[in] azimuthal angle
-  /// \param absId[out] absolute ID number
-  /// \param vimpact[out] TVector3 of impact coordinates?
+  /// \param[in] vtx TVector3 with vertex
+  /// \param[in] theta theta location
+  /// \param[in] phi azimuthal angle
+  /// \param[out] absId absolute ID number
+  /// \param[out] vimpact TVector3 of impact coordinates?
   ///
   /// Calculates the impact coordinates on EMCAL (centre of a tower/not on EMCAL surface)
   /// of a neutral particle emitted in the vertex vtx[3] with direction theta and phi in
@@ -267,27 +265,26 @@ class Geometry
   //
 
   /// \brief  Figure out the global coordinates from local coordinates on a supermodule.
-  /// \param loc[in] local coordinates (double[3])
-  /// \param glob[out] global coordinates (double[2])
-  /// \param iSM super module number
+  /// \param[in] loc local coordinates (double[3])
+  /// \param[out] glob global coordinates (double[2])
+  /// \param[in] ind super module number
   ///
   /// Use the supermodule alignment.
   void GetGlobal(const Double_t* loc, Double_t* glob, int ind) const;
 
   /// \brief Figure out the global coordinates from local coordinates on a supermodule.
-  /// \param vloc[in] local coordinates
-  /// \param vglob[out] global coordinates
-  /// \param iSM: super module number
+  /// \param[in] vloc local coordinates
+  /// \param[out] vglob global coordinates
+  /// \param[in] ind super module number
   ///
   /// Use the supermodule alignment.
   void GetGlobal(const TVector3& vloc, TVector3& vglob, int ind) const;
 
-  ///
-  /// Figure out the global coordinates of a cell.
+  /// \brief Figure out the global coordinates of a cell.
   /// Use the supermodule alignment. Use double[3].
   ///
-  /// \param absId: cell absolute id. number.
-  /// \param glob: 3-double coordinates, output
+  /// \param absId cell absolute id. number.
+  /// \param glob 3-double coordinates, output
   ///
   void GetGlobal(Int_t absId, Double_t glob[3]) const;
 
@@ -373,23 +370,21 @@ class Geometry
 
   /// \brief Get cell SM, module numbers from absolute ID number
   /// \param absId cell absolute id. number
-  /// \param nSupMod super module number
-  /// \param nModule module number
   /// \return tuple(supermodule ID, module number, index of cell in module in phi, index of cell in module in eta)
   /// \throw InvalidCellIDException
   std::tuple<int, int, int, int> GetCellIndex(Int_t absId) const;
 
   /// \brief Get eta-phi indexes of module in SM
-  /// \param[in] nSupMod: super module number, input
-  /// \param[in] nModule: module number, input
+  /// \param nSupMod super module number, input
+  /// \param nModule module number, input
   /// \return tuple (index in phi direction of module, index in eta direction of module)
   std::tuple<int, int> GetModulePhiEtaIndexInSModule(Int_t nSupMod, Int_t nModule) const;
 
   /// \brief Get eta-phi indexes of cell in SM
-  /// \param nSupMod[in] super module number
-  /// \param nModule[in] module number
-  /// \param nIphi[in] index in phi direction in module
-  /// \param nIeta[in] index in phi direction in module
+  /// \param nSupMod super module number
+  /// \param nModule module number
+  /// \param nIphi index in phi direction in module
+  /// \param nIeta index in phi direction in module
   std::tuple<int, int> GetCellPhiEtaIndexInSModule(Int_t nSupMod, Int_t nModule, Int_t nIphi, Int_t nIeta) const;
 
   /// \brief Adapt cell indices in supermodule to online indexing
@@ -455,8 +450,8 @@ class Geometry
   Int_t GetAbsCellIdFromCellIndexes(Int_t nSupMod, Int_t iphi, Int_t ieta) const;
 
   /// \brief Look to see what the relative position inside a given cell is for a recpoint.
-  /// \param absId[in] cell absolute id. number, input
-  /// \param distEff[in] shower max position? check call in RecPoint!
+  /// \param absId cell absolute id. number, input
+  /// \param distEf shower max position? check call in RecPoint!
   /// \return Point3D with x,y,z coordinates of cell with absId inside SM
   /// \throw InvalidCellIDException if cell ID does not exist
   ///
diff --git a/Detectors/EMCAL/base/include/EMCALBase/Hit.h b/Detectors/EMCAL/base/include/EMCALBase/Hit.h
@@ -34,13 +34,12 @@ class Hit : public o2::BasicXYZEHit<float>
   ///
   /// \param primary Number of primary particle
   /// \param trackID Index of the track, defined as parent track entering teh EMCAL
-  /// \param parentID ID of the parent primary entering the EMCAL
   /// \param detID ID of the detector segment
   /// \param initialEnergy Energy of the primary particle enering the EMCAL
   /// \param pos Position vector of the point
   /// \param mom Momentum vector for the particle at the point
   /// \param tof Time of the hit
-  /// \param length Length of the segment
+  /// \param eLoss Energy loss
   Hit(Int_t primary, Int_t trackID, Int_t detID, Double_t initialEnergy, const Point3D<float>& pos,
       const Vector3D<float>& mom, Double_t tof, Double_t eLoss)
     : o2::BasicXYZEHit<float>(pos.X(), pos.Y(), pos.Z(), tof, eLoss, trackID, detID),
@@ -64,7 +63,7 @@ class Hit : public o2::BasicXYZEHit<float>
   Hit& operator+=(const Hit& rhs);
 
   /// \brief Creates a new point base on this point but adding the energy loss of the right hand side
-  /// \param
+  /// \param rhs Hit to add to
   /// \return New EMAL point base on this point
   Hit operator+(const Hit& rhs) const;
 
diff --git a/Detectors/EMCAL/base/include/EMCALBase/Mapper.h b/Detectors/EMCAL/base/include/EMCALBase/Mapper.h
@@ -45,7 +45,7 @@ class Mapper
   struct ChannelID {
     uint8_t mRow;               ///< Row of the channel in module
     uint8_t mColumn;            ///< Column of the channel in module
-    ChannelType_t mChannelType; ///< Type of the channel (see \ref o2::emcal::ChannelType for channel type definitions)
+    ChannelType_t mChannelType; ///< Type of the channel (see o2::emcal::ChannelType for channel type definitions)
 
     bool operator==(const ChannelID& other) const
     {
@@ -183,7 +183,7 @@ class Mapper
     {
     }
 
-    /// \Destructor
+    /// \brief Destructor
     ~FileFormatException() noexcept override = default;
 
     /// \brief Access to error message of the exception
diff --git a/Detectors/EMCAL/calib/include/EMCALCalib/CalibDB.h b/Detectors/EMCAL/calib/include/EMCALCalib/CalibDB.h
@@ -96,12 +96,12 @@ class CalibDB
     /// \return meta data
     const std::map<std::string, std::string> getMetaData() const { return mMetaDat; }
 
-    /// \Accessor to URL of the CCDB server
+    /// \brief Accessor to URL of the CCDB server
     /// \return URL of the CCDB server
     const std::string& getServer() const { return mServ; }
 
-    /// \Accessor to the CCDB path in the query
-    /// return CCDB path in the query
+    /// \brief Accessor to the CCDB path in the query
+    /// \return CCDB path in the query
     const std::string& getPath() const { return mPath; }
 
     /// \brief Accessor to timestamp used in the query
@@ -172,10 +172,10 @@ class CalibDB
   ~CalibDB() = default;
 
   /// \brief Store bad channel map in the CCDB
-  /// \brief bcm Bad channel map to be stored
-  /// \brief metadata Additional metadata that can be used in the query
-  /// \timestart Start of the time range of the validity of the object
-  /// \timeend End of the time range of the validity of the object
+  /// \param bcm Bad channel map to be stored
+  /// \param metadata Additional metadata that can be used in the query
+  /// \param timestart Start of the time range of the validity of the object
+  /// \param timeend End of the time range of the validity of the object
   void storeBadChannelMap(BadChannelMap* bcm, const std::map<std::string, std::string>& metadata, ULong_t timestart, ULong_t timeend);
 
   /// \brief Find bad channel map in the CCDB for given timestamp
@@ -186,10 +186,10 @@ class CalibDB
   BadChannelMap* readBadChannelMap(ULong_t timestamp, const std::map<std::string, std::string>& metadata);
 
   /// \brief Store time calibration coefficiencts in the CCDB
-  /// \brief tcp time calibration coefficiencts to be stored
-  /// \brief metadata Additional metadata that can be used in the query
-  /// \timestart Start of the time range of the validity of the object
-  /// \timeend End of the time range of the validity of the object
+  /// \param tcp time calibration coefficiencts to be stored
+  /// \param metadata Additional metadata that can be used in the query
+  /// \param timestart Start of the time range of the validity of the object
+  /// \param timeend End of the time range of the validity of the object
   void storeTimeCalibParam(TimeCalibrationParams* tcp, const std::map<std::string, std::string>& metadata, ULong_t timestart, ULong_t timeend);
 
   /// \brief Find time calibration coefficiencts in the CCDB for given timestamp
@@ -200,10 +200,10 @@ class CalibDB
   TimeCalibrationParams* readTimeCalibParam(ULong_t timestamp, const std::map<std::string, std::string>& metadata);
 
   /// \brief Store L1 phase shifts in the CCDB
-  /// \brief tcp L1 phase shifts to be stored
-  /// \brief metadata Additional metadata that can be used in the query
-  /// \timestart Start of the time range of the validity of the object
-  /// \timeend End of the time range of the validity of the object
+  /// \param tcp L1 phase shifts to be stored
+  /// \param metadata Additional metadata that can be used in the query
+  /// \param timestart Start of the time range of the validity of the object
+  /// \param timeend End of the time range of the validity of the object
   void storeTimeCalibParamL1Phase(TimeCalibParamL1Phase* tcp, const std::map<std::string, std::string>& metadata, ULong_t timestart, ULong_t timeend);
 
   /// \brief Find L1 phase shifts in the CCDB for given timestamp
@@ -214,10 +214,10 @@ class CalibDB
   TimeCalibParamL1Phase* readTimeCalibParamL1Phase(ULong_t timestamp, const std::map<std::string, std::string>& metadata);
 
   /// \brief Store temperature calibration coefficiencts in the CCDB
-  /// \brief tcp temperature calibration coefficiencts to be stored
-  /// \brief metadata Additional metadata that can be used in the query
-  /// \timestart Start of the time range of the validity of the object
-  /// \timeend End of the time range of the validity of the object
+  /// \param tcp temperature calibration coefficiencts to be stored
+  /// \param metadata Additional metadata that can be used in the query
+  /// \param timestart Start of the time range of the validity of the object
+  /// \param timeend End of the time range of the validity of the object
   void storeTempCalibParam(TempCalibrationParams* tcp, const std::map<std::string, std::string>& metadata, ULong_t timestart, ULong_t timeend);
 
   /// \brief Find temperature calibration coefficiencts in the CCDB for given timestamp
@@ -228,10 +228,10 @@ class CalibDB
   TempCalibrationParams* readTempCalibParam(ULong_t timestamp, const std::map<std::string, std::string>& metadata);
 
   /// \brief Store temperature calibration coefficiencts per SM in the CCDB
-  /// \brief tcp temperature calibration coefficiencts per SM to be stored
-  /// \brief metadata Additional metadata that can be used in the query
-  /// \timestart Start of the time range of the validity of the object
-  /// \timeend End of the time range of the validity of the object
+  /// \param tcp temperature calibration coefficiencts per SM to be stored
+  /// \param metadata Additional metadata that can be used in the query
+  /// \param timestart Start of the time range of the validity of the object
+  /// \param timeend End of the time range of the validity of the object
   void storeTempCalibParamSM(TempCalibParamSM* tcp, const std::map<std::string, std::string>& metadata, ULong_t timestart, ULong_t timeend);
 
   /// \brief Find temperature calibration coefficiencts per SM in the CCDB for given timestamp
@@ -242,10 +242,10 @@ class CalibDB
   TempCalibParamSM* readTempCalibParamSM(ULong_t timestamp, const std::map<std::string, std::string>& metadata);
 
   /// \brief Store gain calibration factors in the CCDB
-  /// \brief gcf temperature calibration coefficiencts to be stored
-  /// \brief metadata Additional metadata that can be used in the query
-  /// \timestart Start of the time range of the validity of the object
-  /// \timeend End of the time range of the validity of the object
+  /// \param gcf temperature calibration coefficiencts to be stored
+  /// \param metadata Additional metadata that can be used in the query
+  /// \param timestart Start of the time range of the validity of the object
+  /// \param timeend End of the time range of the validity of the object
   void storeGainCalibFactors(GainCalibrationFactors* gcf, const std::map<std::string, std::string>& metadata, ULong_t timestart, ULong_t timeend);
 
   /// \brief Find gain calibration factors in the CCDB for given timestamp
@@ -256,10 +256,10 @@ class CalibDB
   GainCalibrationFactors* readGainCalibFactors(ULong_t timestamp, const std::map<std::string, std::string>& metadata);
 
   /// \brief Store Trigger DCS data in the CCDB
-  /// \brief dcs trigger DCS data to be stored
-  /// \brief metadata Additional metadata that can be used in the query
-  /// \timestart Start of the time range of the validity of the object
-  /// \timeend End of the time range of the validity of the object
+  /// \param dcs trigger DCS data to be stored
+  /// \param metadata Additional metadata that can be used in the query
+  /// \param timestart Start of the time range of the validity of the object
+  /// \param timeend End of the time range of the validity of the object
   void storeTriggerDCSData(TriggerDCS* dcs, const std::map<std::string, std::string>& metadata, ULong_t timestart, ULong_t timeend);
 
   /// \brief Find trigger DCS data in the CCDB for given timestamp
diff --git a/Detectors/EMCAL/calib/include/EMCALCalib/TriggerDCS.h b/Detectors/EMCAL/calib/include/EMCALCalib/TriggerDCS.h
@@ -61,6 +61,7 @@ class TriggerDCS
   TriggerTRUDCS getTRUDCS(Int_t iTRU) const { return mTRUArr.at(iTRU); }
 
   /// \brief Check whether TRU is enabled
+  /// \param iTRU Index of the TRU
   /// Enabled-status defined via presence of the TRU in the STU region: TRU
   /// is enabled if the corresponding bit is set in the STU region
   bool isTRUEnabled(int iTRU) const;
@@ -75,7 +76,7 @@ class TriggerDCS
 
 /// \brief Streaming operator
 /// \param in Stream where the TRU parameters are printed on
-/// \param tru TRU to be printed
+/// \param dcs TRU to be printed
 /// \return Stream after printing the TRU parameters
 std::ostream& operator<<(std::ostream& in, const TriggerDCS& dcs);
 
diff --git a/Detectors/EMCAL/calib/include/EMCALCalib/TriggerSTUDCS.h b/Detectors/EMCAL/calib/include/EMCALCalib/TriggerSTUDCS.h
@@ -117,7 +117,7 @@ class TriggerSTUDCS
 
 /// \brief Streaming operator
 /// \param in Stream where the STU parameters are printed on
-/// \param tru STU to be printed
+/// \param stu STU to be printed
 /// \return Stream after printing the STU parameters
 std::ostream& operator<<(std::ostream& in, const TriggerSTUDCS& stu);
 
diff --git a/Detectors/EMCAL/doxymodules.h b/Detectors/EMCAL/doxymodules.h
@@ -9,14 +9,14 @@
 // or submit itself to any jurisdiction
 
 /**
- * @defgroup DetectorEMCAL
+ * @defgroup DetectorEMCAL EMCAL
  * @brief EMCAL simulation and reconstruction 
  * 
  * See \ref refDetectorsEMCAL for more information
  */
 
 /**
- * @defgroup EMCALbase
+ * @defgroup EMCALbase EMCAL base
  * @brief Main EMCAL components
  * @ingroup DetectorEMCAL
  * 
@@ -27,7 +27,7 @@
  */
 
 /**
- * @defgroup EMCALcalibration
+ * @defgroup EMCALcalibration EMCAL calibration
  * @brief EMCAL calibration objects
  * @ingroup DetectorEMCAL
  * 
@@ -39,28 +39,28 @@
  */
 
 /**
- * @defgroup EMCALsimulation
+ * @defgroup EMCALsimulation EMCAL simulation
  * @brief EMCAL simulation code
  * @ingroup DetectorEMCAL
  * 
- * EMCAL simulation package. See \subpage refEMCALsimulation
+ * EMCAL simulation package. See \ref refEMCALsimulation
  * for more information
  */
 
 /**
- * @defgroup EMCALreconstruction
+ * @defgroup EMCALreconstruction EMCAL reconstruction
  * @brief EMCAL reconstruction code
  * @ingroup DetectorEMCAL
  * 
- * EMCAL reconstruction package. See \subpage refEMCALreconstruction
+ * EMCAL reconstruction package. See \ref refEMCALreconstruction
  * for more information
  */
 
 /**
-  * @defgroup EMCALworkflow
+  * @defgroup EMCALworkflow EMCAL workflow
   * @brief EMCAL reconstruction workflow
   * @ingroup DetectorEMCAL
   * 
-  * EMCAL reconstruction workflow package. See \subpage refEMCALworkflow
+  * EMCAL reconstruction workflow package. See \ref refEMCALworkflow
   * for more information.
   */
diff --git a/Detectors/EMCAL/reconstruction/include/EMCALReconstruction/AltroDecoder.h b/Detectors/EMCAL/reconstruction/include/EMCALReconstruction/AltroDecoder.h
@@ -111,12 +111,12 @@ class AltroDecoder
   /// \throw AltroDecoderError with type RCU_TRAILER_ERROR if the RCU trailer was not initialized
   const RCUTrailer& getRCUTrailer() const;
 
-  /// \Get the reference to the channel container
+  /// \brief Get the reference to the channel container
   /// \return Reference to the channel container
   /// \throw AltroDecoderError with CHANNEL_ERROR if the channel container was not initialized for the current event
   const std::vector<Channel>& getChannels() const;
 
-  /// \read RCU trailer for the current event in the raw buffer
+  /// \brief Read RCU trailer for the current event in the raw buffer
   void readRCUTrailer();
 
   /// \brief Read channels for the current event in the raw buffer
diff --git a/Detectors/EMCAL/reconstruction/include/EMCALReconstruction/Bunch.h b/Detectors/EMCAL/reconstruction/include/EMCALReconstruction/Bunch.h
diff --git a/Detectors/EMCAL/reconstruction/include/EMCALReconstruction/RCUTrailer.h b/Detectors/EMCAL/reconstruction/include/EMCALReconstruction/RCUTrailer.h
diff --git a/Detectors/EMCAL/simulation/include/EMCALSimulation/Detector.h b/Detectors/EMCAL/simulation/include/EMCALSimulation/Detector.h

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ class Mapper`
`45`	`45`	`struct ChannelID {`
`46`	`46`	`uint8_t mRow; ///< Row of the channel in module`
`47`	`47`	`uint8_t mColumn; ///< Column of the channel in module`
`48`		`- ChannelType_t mChannelType; ///< Type of the channel (see \ref o2::emcal::ChannelType for channel type definitions)`
	`48`	`+ ChannelType_t mChannelType; ///< Type of the channel (see o2::emcal::ChannelType for channel type definitions)`
`49`	`49`
`50`	`50`	`bool operator==(const ChannelID& other) const`
`51`	`51`	`{`
`@@ -183,7 +183,7 @@ class Mapper`
`183`	`183`	`{`
`184`	`184`	`}`
`185`	`185`
`186`		`- /// \Destructor`
	`186`	`+ /// \brief Destructor`
`187`	`187`	`~FileFormatException() noexcept override = default;`
`188`	`188`
`189`	`189`	`/// \brief Access to error message of the exception`