From fe11edeae51dc83cc0efc07fb0d1f5fe3cfef78b Mon Sep 17 00:00:00 2001 From: boldyrev <alexey.boldyrev@cern.ch> Date: Mon, 10 Apr 2017 23:16:26 +0300 Subject: [PATCH] More fixes in Doxygen commands --- .../DatabaseTest/AthenaPoolMultiTest/share/Count1.py | 2 +- .../DatabaseTest/AthenaPoolMultiTest/share/Count2.py | 2 +- .../DatabaseTest/AthenaPoolMultiTest/share/Count3.py | 2 +- .../src/ByteStreamEventStorageOutputSvc.h | 2 +- .../InDetCosmicsEventPhase/TRT_TrackTimingTool.h | 4 +--- .../PixelDigitization/src/TimeSvc.cxx | 2 +- TestBeam/TBRec/TBRec/TBPatternUnitStreamerTool.h | 4 ++-- TestBeam/TBRec/TBRec/TBPatternUnitStreamerToolH8.h | 4 ++-- TestBeam/TBRec/TBRec/TBPhaseStreamerTool.h | 4 ++-- .../TileCalibBlobObjs/TileCalibDrawerBase.h | 4 ++-- .../TileCalibBlobObjs/TileCalibUtils.h | 12 ++++++------ .../TrigSteering/TrigSteering/Lvl1ItemsAndRoIs.h | 10 +++++----- 12 files changed, 25 insertions(+), 27 deletions(-) diff --git a/AtlasTest/DatabaseTest/AthenaPoolMultiTest/share/Count1.py b/AtlasTest/DatabaseTest/AthenaPoolMultiTest/share/Count1.py index a680f3befe9..9c88a6a4d47 100755 --- a/AtlasTest/DatabaseTest/AthenaPoolMultiTest/share/Count1.py +++ b/AtlasTest/DatabaseTest/AthenaPoolMultiTest/share/Count1.py @@ -1,7 +1,7 @@ ## @file CheckEDM.py ## @brief TopOptions: Check whether simulation output from DC2 ## is still readable. -## @author Jack Cranshaw (Jack.Cranshaw@cern.ch +## @author Jack Cranshaw Jack.Cranshaw@cern.ch ## $Id: Count1.py,v 1.2 2008-04-01 19:41:36 cranshaw Exp $ #-------------------------------------------------------------- # Event related parameters diff --git a/AtlasTest/DatabaseTest/AthenaPoolMultiTest/share/Count2.py b/AtlasTest/DatabaseTest/AthenaPoolMultiTest/share/Count2.py index 7ed098ffc82..26d6a26d5bf 100755 --- a/AtlasTest/DatabaseTest/AthenaPoolMultiTest/share/Count2.py +++ b/AtlasTest/DatabaseTest/AthenaPoolMultiTest/share/Count2.py @@ -1,7 +1,7 @@ ## @file CheckEDM.py ## @brief TopOptions: Check whether simulation output from DC2 ## is still readable. -## @author Jack Cranshaw (Jack.Cranshaw@cern.ch +## @author Jack Cranshaw Jack.Cranshaw@cern.ch ## $Id: Count2.py,v 1.2 2008-04-01 19:41:36 cranshaw Exp $ #-------------------------------------------------------------- # Event related parameters diff --git a/AtlasTest/DatabaseTest/AthenaPoolMultiTest/share/Count3.py b/AtlasTest/DatabaseTest/AthenaPoolMultiTest/share/Count3.py index 8ac18600a62..c49bac26483 100755 --- a/AtlasTest/DatabaseTest/AthenaPoolMultiTest/share/Count3.py +++ b/AtlasTest/DatabaseTest/AthenaPoolMultiTest/share/Count3.py @@ -1,7 +1,7 @@ ## @file CheckEDM.py ## @brief TopOptions: Check whether simulation output from DC2 ## is still readable. -## @author Jack Cranshaw (Jack.Cranshaw@cern.ch +## @author Jack Cranshaw Jack.Cranshaw@cern.ch ## $Id: Count3.py,v 1.2 2008-04-01 19:41:36 cranshaw Exp $ #-------------------------------------------------------------- # Event related parameters diff --git a/Event/ByteStreamCnvSvc/src/ByteStreamEventStorageOutputSvc.h b/Event/ByteStreamCnvSvc/src/ByteStreamEventStorageOutputSvc.h index bb0a42d3aa3..50b852c8f7d 100644 --- a/Event/ByteStreamCnvSvc/src/ByteStreamEventStorageOutputSvc.h +++ b/Event/ByteStreamCnvSvc/src/ByteStreamEventStorageOutputSvc.h @@ -25,7 +25,7 @@ class EventInfo; class ByteStreamMetadata; -/** @classByteStreamEventStorageOutputSvc +/** @class ByteStreamEventStorageOutputSvc * @brief This class provides the services for writing FullEventFragment into file. * This class implements the interface ByteStreamOutputSvc for the conversion service to write the output. **/ diff --git a/InnerDetector/InDetCosmics/InDetCosmicsEventPhase/InDetCosmicsEventPhase/TRT_TrackTimingTool.h b/InnerDetector/InDetCosmics/InDetCosmicsEventPhase/InDetCosmicsEventPhase/TRT_TrackTimingTool.h index ccfc8a0d521..b6ec25fa5c1 100644 --- a/InnerDetector/InDetCosmics/InDetCosmicsEventPhase/InDetCosmicsEventPhase/TRT_TrackTimingTool.h +++ b/InnerDetector/InDetCosmics/InDetCosmicsEventPhase/InDetCosmicsEventPhase/TRT_TrackTimingTool.h @@ -34,9 +34,7 @@ namespace Trk{ class ITrackFitter; } -/** @class - - TRT_TrackTimingTool is a wrapper that passes on the track time, as measured in TRT, to MuonCombinedTimingTools +/** @class TRT_TrackTimingTool is a wrapper that passes on the track time, as measured in TRT, to MuonCombinedTimingTools @author Sasa Fratina, Brett Jackson */ diff --git a/InnerDetector/InDetDigitization/PixelDigitization/src/TimeSvc.cxx b/InnerDetector/InDetDigitization/PixelDigitization/src/TimeSvc.cxx index d2eb4419df8..a6cce673c44 100644 --- a/InnerDetector/InDetDigitization/PixelDigitization/src/TimeSvc.cxx +++ b/InnerDetector/InDetDigitization/PixelDigitization/src/TimeSvc.cxx @@ -133,7 +133,7 @@ int TimeSvc::relativeBunch2015(const SiTotalCharge &totalCharge, int barrel_ec, * * Ideally, it could be directly parameterized as a function of given ToT. * However, the ToT calibration was changed over 2015-2016, where newly calibrated ToT value was not available for 2016. - * For instance, the b-layer charge tuning was changed from ToT30@MIP (2015) to ToT18@MIP (2016). + * For instance, the b-layer charge tuning was changed from ToT30\@MIP (2015) to ToT18\@MIP (2016). * Thus the time walk effect needs to be parameterized with more universal value, that is, charge information. * But it was non-trivial because of the migration effect between the border in ToT. * diff --git a/TestBeam/TBRec/TBRec/TBPatternUnitStreamerTool.h b/TestBeam/TBRec/TBRec/TBPatternUnitStreamerTool.h index 5ffed71f5ab..867ed5241bd 100755 --- a/TestBeam/TBRec/TBRec/TBPatternUnitStreamerTool.h +++ b/TestBeam/TBRec/TBRec/TBPatternUnitStreamerTool.h @@ -20,8 +20,8 @@ * \param AcceptPattern - list of named bits required for acceptance * \param RejectPattern - list of named bits required for rejection * - * \Author Peter Loch - * \Date June 20, 2004 - first implementation + * \author Peter Loch + * \date June 20, 2004 - first implementation */ #include "TBRec/TBEventStreamerTool.h" diff --git a/TestBeam/TBRec/TBRec/TBPatternUnitStreamerToolH8.h b/TestBeam/TBRec/TBRec/TBPatternUnitStreamerToolH8.h index 6361197d665..67555b208c1 100755 --- a/TestBeam/TBRec/TBRec/TBPatternUnitStreamerToolH8.h +++ b/TestBeam/TBRec/TBRec/TBPatternUnitStreamerToolH8.h @@ -20,8 +20,8 @@ * \param AcceptPattern - list of named bits required for acceptance * \param RejectPattern - list of named bits required for rejection * - * \Author Monika Wielers - * \Date July 28, 2004 - copy of TBPatternUnitStreamerTool adapted for H8 + * \author Monika Wielers + * \date July 28, 2004 - copy of TBPatternUnitStreamerTool adapted for H8 */ #include "TBRec/TBEventStreamerTool.h" diff --git a/TestBeam/TBRec/TBRec/TBPhaseStreamerTool.h b/TestBeam/TBRec/TBRec/TBPhaseStreamerTool.h index 7f508fb23c3..d916924a909 100755 --- a/TestBeam/TBRec/TBRec/TBPhaseStreamerTool.h +++ b/TestBeam/TBRec/TBRec/TBPhaseStreamerTool.h @@ -15,8 +15,8 @@ * * \param Guard - Guard value in TDC counts * - * \Author Rob McPherson - * \Date February 10, 2005 - first implementation + * \author Rob McPherson + * \date February 10, 2005 - first implementation */ #include "TBRec/TBEventStreamerTool.h" diff --git a/TileCalorimeter/TileCalib/TileCalibBlobObjs/TileCalibBlobObjs/TileCalibDrawerBase.h b/TileCalorimeter/TileCalib/TileCalibBlobObjs/TileCalibBlobObjs/TileCalibDrawerBase.h index 24e7703894a..b7559e45725 100644 --- a/TileCalorimeter/TileCalib/TileCalibBlobObjs/TileCalibBlobObjs/TileCalibDrawerBase.h +++ b/TileCalorimeter/TileCalib/TileCalibBlobObjs/TileCalibBlobObjs/TileCalibDrawerBase.h @@ -65,14 +65,14 @@ class TileCalibDrawerBase{ @details In case the copy constructor is called, the underlying coral::Blob is copied and the new TileCalibDrawer is the owner of the new coral::Blob. I.e. it will be deleted when the TileCalibDrawer Dtor is called. - @params other The TileCalibDrawer to copy */ + @param other The TileCalibDrawer to copy */ TileCalibDrawerBase(const TileCalibDrawerBase& other); /** @brief Assignment operator */ TileCalibDrawerBase& operator=(const TileCalibDrawerBase& other); /** @brief Initialzes Blob with content of other Blob. - @params other TileCalibDrawer used for initialization + @param other TileCalibDrawer used for initialization */ virtual void clone(const TileCalibDrawerBase& other); diff --git a/TileCalorimeter/TileCalib/TileCalibBlobObjs/TileCalibBlobObjs/TileCalibUtils.h b/TileCalorimeter/TileCalib/TileCalibBlobObjs/TileCalibBlobObjs/TileCalibUtils.h index 676344180c1..d1e2253dd98 100644 --- a/TileCalorimeter/TileCalib/TileCalibBlobObjs/TileCalibBlobObjs/TileCalibUtils.h +++ b/TileCalorimeter/TileCalib/TileCalibBlobObjs/TileCalibBlobObjs/TileCalibUtils.h @@ -85,21 +85,21 @@ class TileCalibUtils{ static std::string getDrawerString(unsigned int ros, unsigned int drawer); /** @brief Returns the default drawer for a given input drawer. - @params drawerIdx The input drawer index*/ + @param drawerIdx The input drawer index*/ static unsigned int getDefaultDrawerIdx(unsigned int drawerIdx); /** @brief Returns the default drawer for a given input drawer. - @params ros The input ros - @params drawer The input drawer */ + @param ros The input ros + @param drawer The input drawer */ static unsigned int getDefaultDrawerIdx(unsigned int ros, unsigned int drawer); /** @brief Returns the first drawer Idx in a partition of a given input drawer. - @params drawerIdx The input drawer index*/ + @param drawerIdx The input drawer index*/ static unsigned int getFirstDrawerInPartitionIdx(unsigned int drawerIdx); /** @brief Returns the input in fixed point precision. - @params val The input value - @params nBits Number of bits used for encoding */ + @param val The input value + @param nBits Number of bits used for encoding */ static float fixedPointPrecision(float val, unsigned int nBits=16); /** @brief Python compatibility function */ diff --git a/Trigger/TrigSteer/TrigSteering/TrigSteering/Lvl1ItemsAndRoIs.h b/Trigger/TrigSteer/TrigSteering/TrigSteering/Lvl1ItemsAndRoIs.h index a74acc33a19..700de8da794 100644 --- a/Trigger/TrigSteer/TrigSteering/TrigSteering/Lvl1ItemsAndRoIs.h +++ b/Trigger/TrigSteer/TrigSteering/TrigSteering/Lvl1ItemsAndRoIs.h @@ -48,7 +48,7 @@ namespace HLT { uint32_t mask; //!< bit position of this LVL1 threshold in the RoI word }; - /** @struct + /** @struct ConfigJetEThreshold modifed ConfigThreshold to incorporate the JetEnergy type */ struct ConfigJetEThreshold : public ConfigThreshold { @@ -57,7 +57,7 @@ namespace HLT { JetRoIType type; //!< JetEnergy type, see JetRoIType enumeration }; - /** @class + /** @class HLTRoI Generic (templated) class for the RoI classes, it contains a vector of the configured ConfigThresholds. */ @@ -82,7 +82,7 @@ namespace HLT { }; - /** @class + /** @class MuonRoI Concrete MuonRoI class (from templated HLRoI class). */ class MuonRoI : public HLTRoI<ROIB::MuCTPIRoI> { @@ -93,7 +93,7 @@ namespace HLT { friend class Lvl1ResultAccessTool; //!< Lvl1ResultAccessTool is a friend to this class -> cann call addThreshold(..) }; - /** @class + /** @class EMTauRoI Concrete EMTau class (from templated HLRoI class). */ class EMTauRoI : public HLTRoI<ROIB::EMTauRoI> { @@ -105,7 +105,7 @@ namespace HLT { friend class Lvl1ResultAccessTool; //!< Lvl1ResultAccessTool is a friend to this class -> cann call addThreshold(..) }; - /** @class + /** @class JetEnergyRoI Concrete JetEnergy class (from templated HLRoI class). */ class JetEnergyRoI : public HLTRoI<ROIB::JetEnergyRoI> { -- GitLab