From bcf72128377a214cafdf8b9ffe924f68d3c81e4f Mon Sep 17 00:00:00 2001 From: boldyrev <alexey.boldyrev@cern.ch> Date: Mon, 10 Apr 2017 16:09:31 +0300 Subject: [PATCH] Fix typos in Doxygen commands Former-commit-id: 4c6ed1d99006a3968f086de8eaa2182175ddbf01 --- .../CaloIdentifier/CaloIDHelper.h | 2 +- .../CaloIdentifier/src/CaloIDHelper.cxx | 2 +- Calorimeter/CaloTools/doc/packagedoc.h | 2 +- .../AthContainers/AthContainers/DataVector.h | 4 +- .../AthContainers/PackedParameters.h | 2 +- .../AthContainers/tools/DVLDataBucket.h | 2 +- Control/SGTools/SGTools/BaseInfo.h | 2 +- Control/SGTools/SGTools/safe_clid.h | 2 +- Control/StoreGate/StoreGate/VarHandleBase.h | 2 +- .../RDBAccessSvc/RDBAccessSvc/IRDBRecord.h | 2 +- .../src/TConvertingBranchElement.cxx | 2 +- .../EventCommonAlgs/INav4MomDumper.h | 2 +- Event/EventCommonAlgs/src/I4MomDumper.h | 2 +- Event/FourMomUtils/FourMomUtils/P4Helpers.h | 8 ++-- Event/xAOD/xAODBPhys/xAODBPhys/BPhysHelper.h | 6 +-- .../xAODEgamma/ElectronxAODHelpers.h | 2 +- .../xAODForward/versions/AFPTrack_v1.h | 2 +- .../xAODMissingET/MissingETComposition.h | 4 +- .../versions/MissingETCompositionBase.h | 2 +- .../xAODMissingET/versions/MissingET_v1.icc | 2 +- Generators/Photos_i/doc/packagedoc.h | 4 +- .../TrigConf2COOLOnline/OnlTrigC2CWriter.h | 2 +- .../SCT_CalibAlgs/SCT_CalibAlgs/SCTCalib.h | 2 +- .../CscCalibData/CscCalibReportSlope.h | 8 ++-- .../CalibNtupleUtils/doc/packagedoc.h | 2 +- .../MuonPrepRawData/CscStripPrepData.h | 2 +- .../MuonRecExample/python/MuonCalibConfig.py | 4 +- .../src/MuPatCandidateTool.h | 40 ++++++++-------- .../RootCoreUtils/ranLoadPackages.h | 2 +- .../python/MuonCaloTagTool.py | 2 +- Tools/PyJobTransforms/python/trfAMI.py | 2 +- Tools/PyJobTransforms/python/trfArgClasses.py | 10 ++-- Tools/PyJobTransforms/python/trfExe.py | 2 +- Tools/PyJobTransforms/python/trfGraph.py | 2 +- Tools/PyJobTransforms/python/trfReports.py | 4 +- Tools/PyJobTransforms/python/trfUtils.py | 46 +++++++++---------- Tools/PyJobTransforms/python/trfValidation.py | 4 +- .../TrkPriVxPurityTool.h | 2 +- .../TrigL2MuonSA/TrigL2MuonSA/TgcFit.h | 2 +- .../TrigT2CaloJet/T2AllRoiUnpacking.h | 2 +- .../TrigmuIso/TrigmuIso/muIsoUtil.h | 12 ++--- .../src/MuonRoiWithExtendedBunches.cxx | 2 +- .../TrigEffJpsiTools/src/TrigEffJpsiTools.cxx | 2 +- .../TrigConfOffline/python/HLTOfflineRules.py | 2 +- .../TrigInterfaces/TrigInterfaces/Algo.h | 2 +- 45 files changed, 109 insertions(+), 109 deletions(-) diff --git a/Calorimeter/CaloIdentifier/CaloIdentifier/CaloIDHelper.h b/Calorimeter/CaloIdentifier/CaloIdentifier/CaloIDHelper.h index 2f794ee3063..2338b5566aa 100644 --- a/Calorimeter/CaloIdentifier/CaloIdentifier/CaloIDHelper.h +++ b/Calorimeter/CaloIdentifier/CaloIdentifier/CaloIDHelper.h @@ -91,7 +91,7 @@ public: * @param name Name of this group (only for error reporting). * @param ids Set of Identifiers comprising this group. * @param end_index The ending index for the context for this group. - * @param msgSvc The global message service + * @parma msgSvc The global message service * (may be 0, only for error reporting). * @param full_range The @c MultiRange corresponding to this group. * If supplied, the side of the @c ids set is checked diff --git a/Calorimeter/CaloIdentifier/src/CaloIDHelper.cxx b/Calorimeter/CaloIdentifier/src/CaloIDHelper.cxx index e579c948606..57e3b11c3c2 100644 --- a/Calorimeter/CaloIdentifier/src/CaloIDHelper.cxx +++ b/Calorimeter/CaloIdentifier/src/CaloIDHelper.cxx @@ -34,7 +34,7 @@ CaloIDHelper::HashGroup::HashGroup () * @param name Name of this group (only for error reporting). * @param ids Set of Identifiers comprising this group. * @param end_index The ending index for the context for this group. - * @param msgSvc The global message service + * @parma msgSvc The global message service * (may be 0, only for error reporting). * @param full_range The @c MultiRange corresponding to this group. * If supplied, the side of the @c ids set is checked diff --git a/Calorimeter/CaloTools/doc/packagedoc.h b/Calorimeter/CaloTools/doc/packagedoc.h index b7bd84970a2..61570bbb6a5 100644 --- a/Calorimeter/CaloTools/doc/packagedoc.h +++ b/Calorimeter/CaloTools/doc/packagedoc.h @@ -9,7 +9,7 @@ This package provides some tools used in the calorimeter reconstruction. @author David Rousseau rousseau@lal.in2p3.fr -@authour Sven Menke Sven.Menke@cern.ch +@author Sven Menke Sven.Menke@cern.ch */ diff --git a/Control/AthContainers/AthContainers/DataVector.h b/Control/AthContainers/AthContainers/DataVector.h index 983ce753087..54647ae0e2d 100644 --- a/Control/AthContainers/AthContainers/DataVector.h +++ b/Control/AthContainers/AthContainers/DataVector.h @@ -405,7 +405,7 @@ * Calling @c clearDecorations will erase all variables marked as decorations, * restoring the state back to where it was when @c lock was called. * - * An @c auxdecor method is also available, analogous to @x auxdata. + * An @c auxdecor method is also available, analogous to @c auxdata. * * * Index tracking @@ -1737,7 +1737,7 @@ public: /** * @brief Convert to @c AuxVectorBase. * - * Needed to get @x AuxVectorBase from a @c ConstDataVector. + * Needed to get @c AuxVectorBase from a @c ConstDataVector. * Present in @c DataVector as well for consistency. * We only really need it in the base class; however, root6 fails * constructing a @c TMethodCall for this if there is virtual diff --git a/Control/AthContainers/AthContainers/PackedParameters.h b/Control/AthContainers/AthContainers/PackedParameters.h index fe03b315cae..72b1385b65c 100644 --- a/Control/AthContainers/AthContainers/PackedParameters.h +++ b/Control/AthContainers/AthContainers/PackedParameters.h @@ -249,7 +249,7 @@ public: /** * @brief Set a packing option. - * @parameter option The option to set. + * @param option The option to set. * * Recognized options are `nbits', `nmantissa', `scale', `signed', * `rounding', and `float'. See the setter functions above for details diff --git a/Control/AthContainers/AthContainers/tools/DVLDataBucket.h b/Control/AthContainers/AthContainers/tools/DVLDataBucket.h index 161db007369..bca498387c7 100644 --- a/Control/AthContainers/AthContainers/tools/DVLDataBucket.h +++ b/Control/AthContainers/AthContainers/tools/DVLDataBucket.h @@ -34,7 +34,7 @@ namespace SG { * * In particular, we may have a situation where we're asked to convert * from @c DataVector\<D> to @c DataVector\<B>, where these two classes - * are not related by inheritance, but @c D derived from @B. + * are not related by inheritance, but @c D derived from @c B. * (In practice, this arises when one has multiple inheritance, * and can't mirror both arms with @c DataVector/@c DataList.) * diff --git a/Control/SGTools/SGTools/BaseInfo.h b/Control/SGTools/SGTools/BaseInfo.h index 9ffe44b311a..fd22fb13c58 100755 --- a/Control/SGTools/SGTools/BaseInfo.h +++ b/Control/SGTools/SGTools/BaseInfo.h @@ -812,7 +812,7 @@ public: * @brief Return a function for casting to a derived pointer. * @param clid @a type_info of the class @a B from which to cast. * @return A function to convert a pointer to a @c B to a pointer - * to a @T. @a tinfo must be known to be a base + * to a @a T. @a tinfo must be known to be a base * of @a T; otherwise, 0 will be returned. * 0 will also be returned if the @a dynamic_cast fails. */ diff --git a/Control/SGTools/SGTools/safe_clid.h b/Control/SGTools/SGTools/safe_clid.h index ff48a1d7a33..5e2d36b25ab 100755 --- a/Control/SGTools/SGTools/safe_clid.h +++ b/Control/SGTools/SGTools/safe_clid.h @@ -20,7 +20,7 @@ * can severely restrict the applicability of generic code. * * This header provides @a SG::safe_clid<T>(), which should return - * the class ID of @T, or @a CLID_NULL if @a T does not have a defined + * the class ID of @a T, or @a CLID_NULL if @a T does not have a defined * class ID (without causing an error). * * The implementation relies on the fact that when the class ID traits diff --git a/Control/StoreGate/StoreGate/VarHandleBase.h b/Control/StoreGate/StoreGate/VarHandleBase.h index d81b4738d17..31d33e9a6e8 100644 --- a/Control/StoreGate/StoreGate/VarHandleBase.h +++ b/Control/StoreGate/StoreGate/VarHandleBase.h @@ -472,7 +472,7 @@ namespace SG { /** * @brief Output stream. * @param out Stream to which to write. - * @param o Object to write. + * @parma o Object to write. */ std::ostream& operator<<( std::ostream& out, const VarHandleBase& o ); diff --git a/Database/AthenaPOOL/RDBAccessSvc/RDBAccessSvc/IRDBRecord.h b/Database/AthenaPOOL/RDBAccessSvc/RDBAccessSvc/IRDBRecord.h index e12bae5a733..f9a977c11e4 100755 --- a/Database/AthenaPOOL/RDBAccessSvc/RDBAccessSvc/IRDBRecord.h +++ b/Database/AthenaPOOL/RDBAccessSvc/RDBAccessSvc/IRDBRecord.h @@ -33,7 +33,7 @@ class IRDBRecord /// Check if the field value is NULL /// @param fieldName [IN] field name - /// @retun TRUE if the field is NULL, FALSE otherwise + /// @return TRUE if the field is NULL, FALSE otherwise virtual bool isFieldNull(const std::string& fieldName) const = 0; /// Get int field value diff --git a/Database/AthenaPOOL/RootConversions/src/TConvertingBranchElement.cxx b/Database/AthenaPOOL/RootConversions/src/TConvertingBranchElement.cxx index b98ad6da8dd..cfc3dc5af5f 100755 --- a/Database/AthenaPOOL/RootConversions/src/TConvertingBranchElement.cxx +++ b/Database/AthenaPOOL/RootConversions/src/TConvertingBranchElement.cxx @@ -128,7 +128,7 @@ std::string BasenameOfBranch (const std::string& fullname) /** * @brief Find the @c TStreamerInfo for a class from a @c TFile. * @param cl The class for which we want the @c TStreamerInfo. - * @param br The branch in which the class is being read. + * @parma br The branch in which the class is being read. * * Find the @c TStreamerInfo for a class by looking directly at the * list from the file from which it's being read (not relying on the diff --git a/Event/EventCommonAlgs/EventCommonAlgs/INav4MomDumper.h b/Event/EventCommonAlgs/EventCommonAlgs/INav4MomDumper.h index 33986d41b44..b3ac2d7e817 100755 --- a/Event/EventCommonAlgs/EventCommonAlgs/INav4MomDumper.h +++ b/Event/EventCommonAlgs/EventCommonAlgs/INav4MomDumper.h @@ -54,7 +54,7 @@ class INav4MomDumper : public AthAlgorithm /////////////////////////////////////////////////////////////////// /** Prints out (on the configured output stream) the content - * of an @c INavigable4MomentumCollection object, given its @C StoreGate + * of an @c INavigable4MomentumCollection object, given its @c StoreGate * key. */ StatusCode dump( const std::string& collName ); diff --git a/Event/EventCommonAlgs/src/I4MomDumper.h b/Event/EventCommonAlgs/src/I4MomDumper.h index 88bf6f4cbce..093e3b4258c 100644 --- a/Event/EventCommonAlgs/src/I4MomDumper.h +++ b/Event/EventCommonAlgs/src/I4MomDumper.h @@ -67,7 +67,7 @@ class I4MomDumper : public AthAlgorithm /////////////////////////////////////////////////////////////////// /** Prints out (on the configured output stream) the content - * of an @c INavigable4MomentumCollection object, given its @C StoreGate + * of an @c INavigable4MomentumCollection object, given its @c StoreGate * key. */ StatusCode dump( const std::string& collName ); diff --git a/Event/FourMomUtils/FourMomUtils/P4Helpers.h b/Event/FourMomUtils/FourMomUtils/P4Helpers.h index a402d1226e2..ecbb872a21d 100644 --- a/Event/FourMomUtils/FourMomUtils/P4Helpers.h +++ b/Event/FourMomUtils/FourMomUtils/P4Helpers.h @@ -187,7 +187,7 @@ namespace P4Helpers double deltaPhi( const I4Momentum * const pA, const I4Momentum * const pB ) { return deltaPhi( pA->phi(), pB->phi() ); } - /// \Delta{R} from 1 @c I4Momentum + /// @f$ \Delta{R} @f$ from 1 @c I4Momentum inline double deltaR( const I4Momentum& p4, double eta, double phi ) { @@ -212,8 +212,8 @@ namespace P4Helpers double deltaR( const I4Momentum * const pA, const I4Momentum * const pB ) { return P4Helpers::deltaR( *pA, *pB ); } - /// Check if 2 @c I4Momentum are in a \Delta{R} cone - /// @param dR [in] \Delta{R} + /// Check if 2 @c I4Momentum are in a @f$ \Delta{R} @f$ cone + /// @param dR [in] @f$ \Delta{R} @f$ /// @return true if they are inline bool isInDeltaR( const I4Momentum& p1, const I4Momentum& p2, @@ -281,7 +281,7 @@ namespace P4Helpers /// Find the closest element in a collection to an @c I4Momentum /// @param index [out] index of the closest element - /// @param deltaR [out] \Delta{R} + /// @param deltaR [out] @f$ \Delta{R} @f$ /// @return true if found template <class Container_t> inline diff --git a/Event/xAOD/xAODBPhys/xAODBPhys/BPhysHelper.h b/Event/xAOD/xAODBPhys/xAODBPhys/BPhysHelper.h index a6341e16e60..200c3a46be7 100644 --- a/Event/xAOD/xAODBPhys/xAODBPhys/BPhysHelper.h +++ b/Event/xAOD/xAODBPhys/xAODBPhys/BPhysHelper.h @@ -453,10 +453,10 @@ namespace xAOD { * using the PV. For instance, the transverse distance can be calculated wrt * the default PV, the closest PV etc. * - * @value: PV_MAX_SUM_PT2 vertex with the largest sum Pt^2 (the default one) - * @value: PV_MIN_A0 collision vertex closest in 3D to the particle's trajectory, + * \@value: PV_MAX_SUM_PT2 vertex with the largest sum Pt^2 (the default one) + * \@value: PV_MIN_A0 collision vertex closest in 3D to the particle's trajectory, * i.e. the vertex with the smalles 3D impact parameter a0 - * @value: PV_MIN_Z0 collision vertex closest in delta(z0) = pv_z - z0, where z0 + * \@value: PV_MIN_Z0 collision vertex closest in delta(z0) = pv_z - z0, where z0 * is the z coordinate of the intesection of the particle's * trajectory with the beam axis in the Z-rho plane. */ diff --git a/Event/xAOD/xAODEgamma/xAODEgamma/ElectronxAODHelpers.h b/Event/xAOD/xAODEgamma/xAODEgamma/ElectronxAODHelpers.h index ebc73a39ca1..451c2cec963 100644 --- a/Event/xAOD/xAODEgamma/xAODEgamma/ElectronxAODHelpers.h +++ b/Event/xAOD/xAODEgamma/xAODEgamma/ElectronxAODHelpers.h @@ -23,7 +23,7 @@ namespace xAOD { ///@brief Helper function for getting the "Original" Track Particle (i.e before GSF) via the GSF Track Particle const xAOD::TrackParticle* getOriginalTrackParticleFromGSF(const xAOD::TrackParticle* trkPar); - ///@Brief return parameters for the last measurement for a GSF track particle + ///@brief return parameters for the last measurement for a GSF track particle float getLastMeasurementQoverP(const xAOD::TrackParticle *tp); ///@brief Return a list of all or only the best TrackParticle associated to the object. diff --git a/Event/xAOD/xAODForward/xAODForward/versions/AFPTrack_v1.h b/Event/xAOD/xAODForward/xAODForward/versions/AFPTrack_v1.h index 2870aab473b..27a058a6bcd 100644 --- a/Event/xAOD/xAODForward/xAODForward/versions/AFPTrack_v1.h +++ b/Event/xAOD/xAODForward/xAODForward/versions/AFPTrack_v1.h @@ -81,7 +81,7 @@ namespace xAOD { /** * @brief Track position along Y axis in station local coordinate system. * - * @copydetail xAOD::AFPTrack_v1::xLocal() + * @copydetails xAOD::AFPTrack_v1::xLocal() */ float yLocal() const; diff --git a/Event/xAOD/xAODMissingET/xAODMissingET/MissingETComposition.h b/Event/xAOD/xAODMissingET/xAODMissingET/MissingETComposition.h index 182f2f10c62..b9787c5d7c3 100644 --- a/Event/xAOD/xAODMissingET/xAODMissingET/MissingETComposition.h +++ b/Event/xAOD/xAODMissingET/xAODMissingET/MissingETComposition.h @@ -49,7 +49,7 @@ namespace xAOD static bool insert(MissingETComponentMap* pMap,const MissingET* pMET,const IParticle* pPart,MissingETBase::Types::weight_t weight=MissingETBase::Types::weight_t()); /*! @brief Insert MET object and contributing object by pointers, with list of signals and optional kinematic weight object. * - * @copydetail insert(MissingETComponentMap*,const MissingET*,const IParticle*,MissingETBase::Types::weight_t) + * @copydetails insert(MissingETComponentMap*,const MissingET*,const IParticle*,MissingETBase::Types::weight_t) * * @param[in] signalList reference to non-modifiable list of (base type) pointers to signals associated with the given physics or signal object * @param[in] p signal type indicator (optional, default is MissingETBase:UsageHandler::OnlyCluster) @@ -70,7 +70,7 @@ namespace xAOD static bool insert(MissingETComponentMap* pMap,const MissingET* pMET,const IParticle* pPart,double wpx,double wpy,double wet); /*! @brief Insert MET object and contributing object by pointers, with list of signals and individual weight components * - * @copydetail insert(MissingETComponentMap*,const MissingET*,const IParticle*,double,double,double) + * @copydetails insert(MissingETComponentMap*,const MissingET*,const IParticle*,double,double,double) * * @param[in] signalList reference to non-modifiable list of (base type) pointers to signals associated with the given physics or signal object * @param[in] p signal type indicator (optional, default is MissingETBase:UsageHandler::OnlyCluster) diff --git a/Event/xAOD/xAODMissingET/xAODMissingET/versions/MissingETCompositionBase.h b/Event/xAOD/xAODMissingET/xAODMissingET/versions/MissingETCompositionBase.h index 3f485eae41e..029e079e3cd 100644 --- a/Event/xAOD/xAODMissingET/xAODMissingET/versions/MissingETCompositionBase.h +++ b/Event/xAOD/xAODMissingET/xAODMissingET/versions/MissingETCompositionBase.h @@ -48,7 +48,7 @@ namespace MissingETBase typedef ConstDataVector<xAOD::IParticleContainer> const_signal_vector_t; - /*! @names Vector of links and object types */ + /*! @name Vector of links and object types */ /*!@{*/ /*! @brief Vector of object links type * diff --git a/Event/xAOD/xAODMissingET/xAODMissingET/versions/MissingET_v1.icc b/Event/xAOD/xAODMissingET/xAODMissingET/versions/MissingET_v1.icc index c852776ee08..51543dbd5dc 100644 --- a/Event/xAOD/xAODMissingET/xAODMissingET/versions/MissingET_v1.icc +++ b/Event/xAOD/xAODMissingET/xAODMissingET/versions/MissingET_v1.icc @@ -205,7 +205,7 @@ inline void xAOD::MissingET_v1::clear() * * @note The particular behaviour concerning the data store depends on the actual implementation of SG::AuxElement::makePrivateStore. * - * @param[in] met reference to non-modifiable MET object (the source). + * @parm[in] met reference to non-modifiable MET object (the source). */ ///////////// diff --git a/Generators/Photos_i/doc/packagedoc.h b/Generators/Photos_i/doc/packagedoc.h index de2e2bf78a4..68f4f754be3 100644 --- a/Generators/Photos_i/doc/packagedoc.h +++ b/Generators/Photos_i/doc/packagedoc.h @@ -6,12 +6,12 @@ @page Photos_i_page -<i> +\<i\> The usage of Photos and Tauola in the Athena environment is described in the following note: https://svnweb.cern.ch/trac/atlasoff/browser/Generators/Photos_i/trunk/doc/athena_TauolaPhotos.pdf -<\i> +\<\i\> diff --git a/HLT/Trigger/TrigConfiguration/TrigConf2COOLOnline/TrigConf2COOLOnline/OnlTrigC2CWriter.h b/HLT/Trigger/TrigConfiguration/TrigConf2COOLOnline/TrigConf2COOLOnline/OnlTrigC2CWriter.h index 0a4884abe20..0471d63e8fc 100644 --- a/HLT/Trigger/TrigConfiguration/TrigConf2COOLOnline/TrigConf2COOLOnline/OnlTrigC2CWriter.h +++ b/HLT/Trigger/TrigConfiguration/TrigConf2COOLOnline/TrigConf2COOLOnline/OnlTrigC2CWriter.h @@ -39,7 +39,7 @@ class TrigConf::OnlTrigC2CWriter : public daq::rc::Controllable { public: /**@brief:constructor. - * @parameter name: this is the named published in IPC (required) + * @param name: this is the named published in IPC (required) */ OnlTrigC2CWriter(const std::string & partitionName, const std::string & cooldb, const std::string& triggerdb, bool l1is, bool l1cool, bool mckcool = false ); OnlTrigC2CWriter(const OnlTrigC2CWriter&) = delete; diff --git a/InnerDetector/InDetCalibAlgs/SCT_CalibAlgs/SCT_CalibAlgs/SCTCalib.h b/InnerDetector/InDetCalibAlgs/SCT_CalibAlgs/SCT_CalibAlgs/SCTCalib.h index a4853134ade..0813f7430ab 100644 --- a/InnerDetector/InDetCalibAlgs/SCT_CalibAlgs/SCT_CalibAlgs/SCTCalib.h +++ b/InnerDetector/InDetCalibAlgs/SCT_CalibAlgs/SCT_CalibAlgs/SCTCalib.h @@ -5,7 +5,7 @@ /** * @file SCTCalib.h * -* @Header file for the SCTCalib class +* Header file for the SCTCalib class * * @author Jose E. Garcia, jose.enrique.garcia@cern.ch * @author Peter Vankov, peter.vankov@cern.ch diff --git a/MuonSpectrometer/MuonCalib/CscCalib/CscCalibData/CscCalibData/CscCalibReportSlope.h b/MuonSpectrometer/MuonCalib/CscCalib/CscCalibData/CscCalibData/CscCalibReportSlope.h index 472f5540e6b..cfee6cf9bf6 100755 --- a/MuonSpectrometer/MuonCalib/CscCalib/CscCalibData/CscCalibData/CscCalibReportSlope.h +++ b/MuonSpectrometer/MuonCalib/CscCalib/CscCalibData/CscCalibData/CscCalibReportSlope.h @@ -59,23 +59,23 @@ class CscCalibReportSlope : public CscCalibReportBase void setBitHists(DataVector<TH1I> * somePedAmpHists); /** setCalGraphs - Set the pedAmpHist vector. - @PARAM someCalGraphs - Pointer to DataVector of calibration graphs. Takes ownership. + @param someCalGraphs - Pointer to DataVector of calibration graphs. Takes ownership. */ void setCalGraphs(DataVector<TGraphErrors> * someCalGraphs); /*setDeadChanges - set the changed dead channels - @PARAM someDeadChanges - Pointer to map of changed channels and their new value + @param someDeadChanges - Pointer to map of changed channels and their new value void setDeadChanges(std::set<bitChange> * someDeadChannels); */ /**setAmpProfs - set the changed dead channels - @PARAM someAmpProfs - Pointer to map of changed channels and their new value + @param someAmpProfs - Pointer to map of changed channels and their new value */ void setAmpProfs(std::map<int,TProfile*> * someAmpProfs); /**setPulsedChambers - set the pulsed chambers - @PARAM somePulsedChambers - Pointer to set of pulsed chambers. Takes ownership. + @param somePulsedChambers - Pointer to set of pulsed chambers. Takes ownership. */ void setPulsedChambers(std::set<int> * somePulsedChambers); diff --git a/MuonSpectrometer/MuonCalib/MuonCalibStandAlone/CalibNtupleUtils/doc/packagedoc.h b/MuonSpectrometer/MuonCalib/MuonCalibStandAlone/CalibNtupleUtils/doc/packagedoc.h index bdee770d089..7daccbbb041 100644 --- a/MuonSpectrometer/MuonCalib/MuonCalibStandAlone/CalibNtupleUtils/doc/packagedoc.h +++ b/MuonSpectrometer/MuonCalib/MuonCalibStandAlone/CalibNtupleUtils/doc/packagedoc.h @@ -11,7 +11,7 @@ Helper packages for the MuonCalibStandAlone packages. -@secton CalibNtupleUtilsOverview Class Overview +@section CalibNtupleUtilsOverview Class Overview This set of classes are usefull whilst analysing/handling CalibrationNtuples. It contains the following packages: - HistHandler : a class reducing the amount of code in order to make sets of TH1F/Th2F histograms which similar features. For example, if one choses to store station-level TDC spectra, only one HistHandler should be declared. The class sorts out which station-histogram will be filled (given a MuonFixedId). - HistSetting : Helper class in order to customize HistHandler with your favorite LabelSize/Offset, TitleSize/Offset etc. diff --git a/MuonSpectrometer/MuonReconstruction/MuonRecEvent/MuonPrepRawData/MuonPrepRawData/CscStripPrepData.h b/MuonSpectrometer/MuonReconstruction/MuonRecEvent/MuonPrepRawData/MuonPrepRawData/CscStripPrepData.h index f999c6bf681..f957d34414c 100755 --- a/MuonSpectrometer/MuonReconstruction/MuonRecEvent/MuonPrepRawData/MuonPrepRawData/CscStripPrepData.h +++ b/MuonSpectrometer/MuonReconstruction/MuonRecEvent/MuonPrepRawData/MuonPrepRawData/CscStripPrepData.h @@ -105,7 +105,7 @@ namespace Muon virtual std::ostream& dump( std::ostream& stream) const; /** set the sampling phase - @Warning This does not conform to ATLAS Coding Conventions and will be renamed to setSamplingPhase() */ + @warning This does not conform to ATLAS Coding Conventions and will be renamed to setSamplingPhase() */ void set_samplingPhase () ; private: diff --git a/MuonSpectrometer/MuonReconstruction/MuonRecExample/python/MuonCalibConfig.py b/MuonSpectrometer/MuonReconstruction/MuonRecExample/python/MuonCalibConfig.py index 3dfcc35002a..147891dc81b 100644 --- a/MuonSpectrometer/MuonReconstruction/MuonRecExample/python/MuonCalibConfig.py +++ b/MuonSpectrometer/MuonReconstruction/MuonRecExample/python/MuonCalibConfig.py @@ -47,7 +47,7 @@ def getCalibConfigs(): ## Setup MuonSegmenToCalibSegment algorithm. -# @input @c segmentKeys list of segment keys to use or single segments key (string) +# @param[in] segmentKeys list of segment keys to use or single segments key (string) def getMuonSegmentToCalibSegment(): global topSequence,muonRecFlags try: @@ -76,7 +76,7 @@ def getMuonSegmentToCalibSegment(): ## Setup the basic MuonCalibAlg algorithm. Needs further configuration after this call # depending on the use-case. -# @input @c evenTag The event tag written to file +# @param[in] evenTag The event tag written to file def getMuonCalibAlg(eventTag): global topSequence,beamFlags try: diff --git a/MuonSpectrometer/MuonReconstruction/MuonTrackMakers/MuonTrackMakerTools/MuonTrackSteeringTools/src/MuPatCandidateTool.h b/MuonSpectrometer/MuonReconstruction/MuonTrackMakers/MuonTrackMakerTools/MuonTrackSteeringTools/src/MuPatCandidateTool.h index 206f7b6e371..e1dfba569e3 100644 --- a/MuonSpectrometer/MuonReconstruction/MuonTrackMakers/MuonTrackMakerTools/MuonTrackSteeringTools/src/MuPatCandidateTool.h +++ b/MuonSpectrometer/MuonReconstruction/MuonTrackMakers/MuonTrackMakerTools/MuonTrackSteeringTools/src/MuPatCandidateTool.h @@ -75,33 +75,33 @@ namespace Muon { static const InterfaceID& interfaceID() { return IID_MuPatCandidateTool; } /** @brief extend a track candidate with a segment - @input can the MuPatTrack to be extended - @input track the new track, ownership is passed to the candidate - @input seg the MuPatSegment to be added, ownership is NOT passed! - @output true if any segment was removed from the track, false if not + @param[in] can the MuPatTrack to be extended + @param[in] track the new track, ownership is passed to the candidate + @param[in] seg the MuPatSegment to be added, ownership is NOT passed! + @param[out] true if any segment was removed from the track, false if not */ bool extendWithSegment( MuPatTrack& can, MuPatSegment& segInfo, const Trk::Track* track ) const; /** @brief create a track candidate from one segment - @input seg1 the first MuPatSegment to be added, ownership is NOT passed! - @input seg2 the second MuPatSegment to be added, ownership is NOT passed! - @input track the new track, ownership is passed to the candidate - @output the new candidate, ownership is passed to caller + @param[in] seg1 the first MuPatSegment to be added, ownership is NOT passed! + @param[in] seg2 the second MuPatSegment to be added, ownership is NOT passed! + @param[in] track the new track, ownership is passed to the candidate + @param[out] the new candidate, ownership is passed to caller */ MuPatTrack* createCandidate( MuPatSegment& segInfo, const Trk::Track* track ) const; /** @brief create a track candidate from two segments - @input seg1 the first MuPatSegment to be added, ownership is NOT passed! - @input seg2 the second MuPatSegment to be added, ownership is NOT passed! - @input track the new track, ownership is passed to the candidate - @output the new candidate, ownership is passed to caller + @param[in] seg1 the first MuPatSegment to be added, ownership is NOT passed! + @param[in] seg2 the second MuPatSegment to be added, ownership is NOT passed! + @param[in] track the new track, ownership is passed to the candidate + @param[out] the new candidate, ownership is passed to caller */ MuPatTrack* createCandidate( MuPatSegment& segInfo1, MuPatSegment& segInfo2, const Trk::Track* track ) const; /** @brief create a track candidate from a track - @input track the new track, ownership is passed to the candidate - @output the new candidate, ownership is passed to caller + @param[in] track the new track, ownership is passed to the candidate + @param[out] the new candidate, ownership is passed to caller */ MuPatTrack* createCandidate( const Trk::Track* track ) const; @@ -113,20 +113,20 @@ namespace Muon { bool recalculateCandidateSegmentContent( MuPatTrack& candidate ) const; /** @brief copy a candidate without copying the track (lazy pointer copy) - @input can the MuPatTrack to be copied - @output the new candidate, ownership is passed to caller. The new candidate will not own the track (lazy pointer copy) + @param[in] can the MuPatTrack to be copied + @param[out] the new candidate, ownership is passed to caller. The new candidate will not own the track (lazy pointer copy) */ MuPatTrack* copyCandidate( MuPatTrack& canIn ) const; /** @brief copy a candidate and transfer the track ownwership from the old to the new candidate. - @input can the MuPatTrack to be copied. After the copy, it will no longer own the track (but keeps pointer to it) - @output the new candidate, ownership is passed to caller. The new candidate will own the track. + @param[in] can the MuPatTrack to be copied. After the copy, it will no longer own the track (but keeps pointer to it) + @param[out] the new candidate, ownership is passed to caller. The new candidate will own the track. */ MuPatTrack* copyCandidateAndTransferTrack( MuPatTrack& canIn ) const; /** @brief create a MuPatSegment object from a segment - @input segment input segment - @output the MuPatSegment object, ownership is passed to caller + @param[in] segment input segment + @param[out] the MuPatSegment object, ownership is passed to caller */ MuPatSegment* createSegInfo( const MuonSegment& segment ) const; diff --git a/PhysicsAnalysis/D3PDTools/RootCoreUtils/RootCoreUtils/ranLoadPackages.h b/PhysicsAnalysis/D3PDTools/RootCoreUtils/RootCoreUtils/ranLoadPackages.h index 1b9bae4d3d8..5da31acbb21 100644 --- a/PhysicsAnalysis/D3PDTools/RootCoreUtils/RootCoreUtils/ranLoadPackages.h +++ b/PhysicsAnalysis/D3PDTools/RootCoreUtils/RootCoreUtils/ranLoadPackages.h @@ -21,7 +21,7 @@ namespace RCU /// to know whether to run this again or not. /// \par Guarantee /// no-fail - /// \warn this is the method that should be called to check this, as + /// @warning this is the method that should be called to check this, as /// the exact mechanism for checking this may change bool ranLoadPackages (); } diff --git a/Reconstruction/MuonIdentification/MuonCombinedRecExample/python/MuonCaloTagTool.py b/Reconstruction/MuonIdentification/MuonCombinedRecExample/python/MuonCaloTagTool.py index 19901e92900..ff5cbd17f74 100644 --- a/Reconstruction/MuonIdentification/MuonCombinedRecExample/python/MuonCaloTagTool.py +++ b/Reconstruction/MuonIdentification/MuonCombinedRecExample/python/MuonCaloTagTool.py @@ -11,7 +11,7 @@ from AthenaCommon.Logging import log ############################################################################### ## Helper function for defining THistSvc inputs ############################################################################### -# Finds the root file @rootFileName and creates a one-item list for THistSvc.Input +# Finds the root file \@rootFileName and creates a one-item list for THistSvc.Input ############################################################################### ### Track Selector for CaloTrkMuIdAlg diff --git a/Tools/PyJobTransforms/python/trfAMI.py b/Tools/PyJobTransforms/python/trfAMI.py index 81c4ee6b865..3fee8a4428d 100644 --- a/Tools/PyJobTransforms/python/trfAMI.py +++ b/Tools/PyJobTransforms/python/trfAMI.py @@ -262,7 +262,7 @@ def getPANDAClient(): return cur ## @brief Un-escape information from PANDA -# @detail Provided by Pavel. +# @details Provided by Pavel. def ReadablePANDA(s): return s.replace('%0B',' ').replace('%9B','; ').replace('%8B','"').replace('%3B',';').replace('%2C',',').replace('%2B','+') diff --git a/Tools/PyJobTransforms/python/trfArgClasses.py b/Tools/PyJobTransforms/python/trfArgClasses.py index e533fd9cd6e..4f6c1da7c53 100644 --- a/Tools/PyJobTransforms/python/trfArgClasses.py +++ b/Tools/PyJobTransforms/python/trfArgClasses.py @@ -334,7 +334,7 @@ class argList(argument): ## @brief Argument value setter - # @detail If we get a list then set that, otherwise we split a string on the splitter character + # @details If we get a list then set that, otherwise we split a string on the splitter character @value.setter def value(self, value): if isinstance(value, (list, tuple)): @@ -379,7 +379,7 @@ class argIntList(argList): ## @brief Argument value setter - # @detail If we get a list then set that, otherwise we split a string on the splitter character + # @details If we get a list then set that, otherwise we split a string on the splitter character # @throw trfExceptions.TransformArgException Exception thrown if any list member is not an @c int # @throw trfExceptions.TransformArgException Exception thrown is any @c int() conversion fails @value.setter @@ -435,7 +435,7 @@ class argKeyFloatValueList(argList): return self._value ## @brief Argument value setter - # @detail If we get a dict then set that, otherwise we split a string on the splitter character + # @details If we get a dict then set that, otherwise we split a string on the splitter character # and then on the kvsplitter into key and value, with the value being converted to float # @throw trfExceptions.TransformArgException Exception thrown if any dictionary @c key:value member is not @c string:int # @throw trfExceptions.TransformArgException Exception thrown if any @c int() conversion fails of the kvsplitter is not found @@ -551,7 +551,7 @@ class argFile(argList): return self._value ## @brief Argument value setter - # @detail Calls the valueSetter function with the standard options + # @details Calls the valueSetter function with the standard options @value.setter def value(self, value): self.valueSetter(value) @@ -1039,7 +1039,7 @@ class argFile(argList): return isCachedFlag ## @brief Look for dataset name in dataset#filename Tier0 convention - # @detail At the moment all files must be in the same dataset if it's specified. + # @details At the moment all files must be in the same dataset if it's specified. # (To change this dataset will need to become a per-file metadatum.) # @note dsn#lfn notation must be used for @b all input values and all dsn values must be the same # @param @c reset If @c True then forget previous dataset setting. Default is @c False. diff --git a/Tools/PyJobTransforms/python/trfExe.py b/Tools/PyJobTransforms/python/trfExe.py index 2ccf0a4a1df..e2e5bbf90fa 100755 --- a/Tools/PyJobTransforms/python/trfExe.py +++ b/Tools/PyJobTransforms/python/trfExe.py @@ -98,7 +98,7 @@ class transformExecutor(object): ## @brief Base class initaliser for transform executors # @param name Transform name # @param trf Parent transform - # @param conf executorConfig object (if @None then set from the @c trf directly) + # @param conf executorConfig object (if @c None then set from the @c trf directly) # @param inData Data inputs this transform can start from. This should be a list, tuple or set # consisting of each input data type. If a tuple (or list) is passed as a set member then this is interpreted as # meaning that all of the data members in that tuple are necessary as an input. diff --git a/Tools/PyJobTransforms/python/trfGraph.py b/Tools/PyJobTransforms/python/trfGraph.py index 0dd9f427ee7..45bb0326cc0 100644 --- a/Tools/PyJobTransforms/python/trfGraph.py +++ b/Tools/PyJobTransforms/python/trfGraph.py @@ -168,7 +168,7 @@ class executorGraph(object): ## @brief Find a topologically sorted list of the graph nodes # @note If this is not possible, the graph is not a DAG - not supported - # @notes See http://en.wikipedia.org/wiki/Topological_sorting + # @note See http://en.wikipedia.org/wiki/Topological_sorting def doToposort(self): # We will manipulate the graph, so deepcopy it graphCopy = copy.deepcopy(self._nodeDict) diff --git a/Tools/PyJobTransforms/python/trfReports.py b/Tools/PyJobTransforms/python/trfReports.py index 4820f5e193a..cb0d4adb79c 100644 --- a/Tools/PyJobTransforms/python/trfReports.py +++ b/Tools/PyJobTransforms/python/trfReports.py @@ -38,7 +38,7 @@ class trfReport(object): pass ## @brief String representation of the job report - # @detail Uses pprint module to output the python object as text + # @details Uses pprint module to output the python object as text # @note This is a 'property', so no @c fast option is available def __str__(self): return pprint.pformat(self.python()) @@ -323,7 +323,7 @@ class trfExecutorReport(object): self._exe = executor ## @brief Get a python representation of executor report - # @detail Returns the python representation of this executor + # @details Returns the python representation of this executor # @return Python dictionary def python(self, fast = False): reportDict = {'name': self._exe.name, diff --git a/Tools/PyJobTransforms/python/trfUtils.py b/Tools/PyJobTransforms/python/trfUtils.py index 262ee2aecde..6ff164cf0c7 100644 --- a/Tools/PyJobTransforms/python/trfUtils.py +++ b/Tools/PyJobTransforms/python/trfUtils.py @@ -53,7 +53,7 @@ def findFile(pathvar, fname): ## @brief List all processes and parents and form a dictionary where the # parent key lists all child PIDs -# @parameter listMyOrphans If this is @c True, then processes which share the same +# @param listMyOrphans If this is @c True, then processes which share the same # @c pgid as this process and have parent PID=1 (i.e., init) get added to this process's children, # which allows these orphans to be added to the kill list. N.B. this means # that orphans have two entries - as child of init and a child of this @@ -292,7 +292,7 @@ def releaseIsOlderThan(major, minor=None): ## @brief Quote a string array so that it can be echoed back on the command line in a cut 'n' paste safe way # @param strArray: Array of strings to quote -# @detail Technique is to first quote any pre-existing single quotes, then single quote all of the array +# @details Technique is to first quote any pre-existing single quotes, then single quote all of the array # elements so that the shell sees them as a single argument def shQuoteStrings(strArray = sys.argv): return [ "'" + qstring.replace("'", "\\'") + "'" for qstring in strArray ] @@ -315,7 +315,7 @@ def lineByLine(filename, strip = True, removeTimestamp = True): f.close() -## #brief XML pretty print an ElementTree.ELement object +## @brief XML pretty print an ElementTree.ELement object # @param element ElementTree.ELement object to print # @param indent Indent parameter for minidom toprettyxml method # @param poolFileCatalogFormat Whether to reformat the XML as a classic POOLFILECATALOG document @@ -360,7 +360,7 @@ def prettyXML(element, indent = ' ', poolFileCatalogFormat = False): ## @brief Return isoformated 'now' string -# @detail Uses datetime.isoformat method, but suppressing microseconds +# @details Uses datetime.isoformat method, but suppressing microseconds def isodate(): return datetime.now().replace(microsecond=0).isoformat() @@ -382,7 +382,7 @@ def forceToAlphaNum(string): ## @brief Compare metadata for files, but taking into account that GUID can vary -# @detail Compare metadata dictionaries, but allowing for differences in the file_guid property +# @details Compare metadata dictionaries, but allowing for differences in the file_guid property # as this is generated randomly for file types without an intrinsic GUID # @param metadata1 Filel metadata dictionary # @param metadata2 File2 metadata dictionary @@ -440,7 +440,7 @@ def unpackTarFile(filename, directory="."): ## @brief Ensure that the DBRelease tarball has been unpacked -# @detail Extract the dbversion number and look for an unpacked directory. +# @details Extract the dbversion number and look for an unpacked directory. # If found then this release is already setup. If not then try to unpack # the tarball. # @param tarball The tarball file @@ -580,7 +580,7 @@ def cliToKey(option): ## @brief print in a human-readable way the items of a given object -# @detail This function prints in a human-readable way the items of a given +# @details This function prints in a human-readable way the items of a given # object. # @param object to print def printHR(the_object): @@ -598,7 +598,7 @@ def printHR(the_object): ## @brief return a URL-safe, base 64-encoded pseudorandom UUID -# @detail This function returns a URL-safe, base 64-encoded pseudorandom +# @details This function returns a URL-safe, base 64-encoded pseudorandom # Universally Unique IDentifier (UUID). # @return string of URL-safe, base 64-encoded pseudorandom UUID def uniqueIdentifier(): @@ -607,7 +607,7 @@ def uniqueIdentifier(): ## @brief return either singular or plural units as appropriate for a given # quantity -# @detail This function returns either singular or plural units as appropriate +# @details This function returns either singular or plural units as appropriate # for a given quantity. So, a quantity of 1 would cause the return of singular # units and a quantity of 2 would cause the return of plural units. # @param quantity the numerical quantity @@ -638,7 +638,7 @@ def isInteractiveEnv(): ## @brief Job: a set of pieces of information relevant to a given work function -# @detail A Job object is a set of pieces of information relevant to a given +# @details A Job object is a set of pieces of information relevant to a given # work function. A Job object comprises a name, a work function, work function # arguments, the work function timeout specification, a # multiprocessing.Pool.apply_async() object and, ultimately, a result object. @@ -681,7 +681,7 @@ class Job(object): return self._name ## @brief return an object self description string - # @ detail This method returns an object description string consisting of + # @details This method returns an object description string consisting of # a listing of the items of the object self. # @return object description string def __str__(self): @@ -694,7 +694,7 @@ class Job(object): return descriptionString ## @brief print in a human-readable way the items of the object self - # @detail This function prints in a human-readable way the items of the + # @details This function prints in a human-readable way the items of the # object self. def printout(self): printHR(vars(self)) @@ -702,7 +702,7 @@ class Job(object): ## @brief JobGroup: a set of Job objects and pieces of information relevant to a # given set of Job objects -# @detail A JobGroup is a set of Job objects and pieces of information relevant +# @details A JobGroup is a set of Job objects and pieces of information relevant # to a given set of Job objects. A JobGroup object comprises a name, a list of # Job objects, a timeout and, ultimately, an ordered list of result objects. # The timeout can be speecified or derived from the summation of the timeout @@ -752,7 +752,7 @@ class JobGroup(object): return descriptionString ## @brief return Boolean JobGroup timeout status - # @detail This method returns the timeout status of a JobGroup object. If + # @details This method returns the timeout status of a JobGroup object. If # the JobGroup object has not timed out, the Boolean False is returned. If # the JobGroup object has timed out, the Boolean True is returned. If the # JobGroup object has been completed or is not submitted, the Boolean False @@ -771,7 +771,7 @@ class JobGroup(object): return False ## @brief print in a human-readable way the items of the object self - # @detail This function prints in a human-readable way the items of the + # @details This function prints in a human-readable way the items of the # object self. def printout(self): printHR(vars(self)) @@ -793,7 +793,7 @@ def initialise_processes(): class ParallelJobProcessor(object): ## @brief initialisation method that accepts submissions and starts pool - # @detail This method is the initialisation method of the parallel job + # @details This method is the initialisation method of the parallel job # processor. It accepts input JobGroup object submissions and prepares a # pool of workers. def __init__( @@ -828,7 +828,7 @@ class ParallelJobProcessor(object): )) ## @brief return an object self-description string - # @detail This method returns an object description string consisting of + # @details This method returns an object description string consisting of # a listing of the items of the object self. # @return object description string def __str__(self): @@ -841,14 +841,14 @@ class ParallelJobProcessor(object): return descriptionString ## @brief print in a human-readable way the items of the object self - # @detail This function prints in a human-readable way the items of the + # @details This function prints in a human-readable way the items of the # object self. def printout(self): printHR(vars(self) ) ## @brief submit a Job object or a JobGroup object for processing - # @detail This method submits a specified Job object or JobGroup object + # @details This method submits a specified Job object or JobGroup object # for processing. On successful submission, it returns the value 0. # @param jobSubmission Job object or JobGroup object for submission def submit( @@ -928,7 +928,7 @@ class ParallelJobProcessor(object): return 0 ## @brief get results of JobGroup object submission - # @detail This method returns an ordered list of results for jobs + # @details This method returns an ordered list of results for jobs # submitted. # @return order list of results for jobs def getResults(self): @@ -1077,7 +1077,7 @@ class ParallelJobProcessor(object): self._terminate() ## @brief return a status report string - # @detail This method returns a status report string, detailing + # @details This method returns a status report string, detailing # information on the JobGroup submission and on the job processing status. # @return status report string def statusReport(self): @@ -1135,7 +1135,7 @@ class ParallelJobProcessor(object): return statusReport ## @brief abort parallel job processor - # @detail This method aborts the parallel job processor. It is used + # @details This method aborts the parallel job processor. It is used # typically when an exception is raised. def _abort(self): self.status = "aborting" @@ -1146,7 +1146,7 @@ class ParallelJobProcessor(object): self._terminate() ## @brief terminate parallel job processor - # @detail This method terminates the parallel job processor. It terminates + # @details This method terminates the parallel job processor. It terminates # the subprocesses of the parallel job processor. It is used typically # when terminating the parallel job processor on successful completion of # job processing and when aborting the parallel job processor. diff --git a/Tools/PyJobTransforms/python/trfValidation.py b/Tools/PyJobTransforms/python/trfValidation.py index f79b0147405..6297f786a0f 100644 --- a/Tools/PyJobTransforms/python/trfValidation.py +++ b/Tools/PyJobTransforms/python/trfValidation.py @@ -103,8 +103,8 @@ class ignorePatterns(object): ## @brief Load error patterns from files # @details Load regular expressions to be used in logfile parsing - # @files Files to load up structured error patterns from - # @extraSearch Extra regexp strings to @a search against + # Files to load up structured error patterns from + # @param extraSearch Extra regexp strings to @a search against def __init__(self, files=['atlas_error_mask.db'], extraSearch = []): # Setup structured search patterns self._structuredPatterns = [] diff --git a/Tracking/TrkValidation/TrkVertexFitterValidationUtils/TrkVertexFitterValidationUtils/TrkPriVxPurityTool.h b/Tracking/TrkValidation/TrkVertexFitterValidationUtils/TrkVertexFitterValidationUtils/TrkPriVxPurityTool.h index a8060ac57a7..ab5e64a67ba 100755 --- a/Tracking/TrkValidation/TrkVertexFitterValidationUtils/TrkVertexFitterValidationUtils/TrkPriVxPurityTool.h +++ b/Tracking/TrkValidation/TrkVertexFitterValidationUtils/TrkVertexFitterValidationUtils/TrkPriVxPurityTool.h @@ -15,7 +15,7 @@ * of outliers fitted to the vertex and tracks * originating from the pileup is determined. * - * @authpr Kirill Prokofiev, September 2006 + * @author Kirill Prokofiev, September 2006 */ #include "AthenaBaseComps/AthAlgTool.h" diff --git a/Trigger/TrigAlgorithms/TrigL2MuonSA/TrigL2MuonSA/TgcFit.h b/Trigger/TrigAlgorithms/TrigL2MuonSA/TrigL2MuonSA/TgcFit.h index 8f1598d3669..b86df04231a 100644 --- a/Trigger/TrigAlgorithms/TrigL2MuonSA/TrigL2MuonSA/TgcFit.h +++ b/Trigger/TrigAlgorithms/TrigL2MuonSA/TrigL2MuonSA/TgcFit.h @@ -142,7 +142,7 @@ class TgcFit: public AthAlgTool } /* * Calculate projected values given fit results. - * @param fX The X value of the point to project. + * @parma fX The X value of the point to project. * @return The projected Y value. */ double eval(double fX) const; diff --git a/Trigger/TrigAlgorithms/TrigT2CaloJet/TrigT2CaloJet/T2AllRoiUnpacking.h b/Trigger/TrigAlgorithms/TrigT2CaloJet/TrigT2CaloJet/T2AllRoiUnpacking.h index 90b1528cbaf..14f644efa82 100644 --- a/Trigger/TrigAlgorithms/TrigT2CaloJet/TrigT2CaloJet/T2AllRoiUnpacking.h +++ b/Trigger/TrigAlgorithms/TrigT2CaloJet/TrigT2CaloJet/T2AllRoiUnpacking.h @@ -160,7 +160,7 @@ class EtaPhiRectangle{ //! compute the rectangle corresponding to the overlapping area static EtaPhiRectangle overlappingRectangle(const EtaPhiRectangle &lhs, const EtaPhiRectangle &rhs); - //! convert any angle to its equivalent in ( @f$-\pi @f$, @f$ +\pi @f$] + //! convert any angle to its equivalent in ( @f$ -\pi @f$, @f$ +\pi @f$] static double phi_mpi_pi(const double &val); //! convert any angle to its equivalent in ( 0 , @f$ +2\pi @f$] static double phi_zero_2pi(const double &val); diff --git a/Trigger/TrigAlgorithms/TrigmuIso/TrigmuIso/muIsoUtil.h b/Trigger/TrigAlgorithms/TrigmuIso/TrigmuIso/muIsoUtil.h index eae6b785e3c..8a6f7a2f348 100755 --- a/Trigger/TrigAlgorithms/TrigmuIso/TrigmuIso/muIsoUtil.h +++ b/Trigger/TrigAlgorithms/TrigmuIso/TrigmuIso/muIsoUtil.h @@ -19,7 +19,7 @@ namespace muIsoUtil { ///SGExtrapolator Functions - ///Return deltaEta between eta@MS entrance and eta@Calo entrance + ///Return deltaEta between eta\@MS entrance and eta\@Calo entrance /*! * \param double phi * \param double pt @@ -27,7 +27,7 @@ namespace muIsoUtil { */ double corrDEtaCM(double phi, double pt, int charge); - ///Return deltaPhi between phi@MS entrance and phi@Calo entrance + ///Return deltaPhi between phi\@MS entrance and phi@Calo entrance /*! * \param double eta * \param double pt @@ -35,7 +35,7 @@ namespace muIsoUtil { */ double corrDPhiCM(double eta, double pt, int charge); - ///Return deltaEta between eta@Calo entrance and eta@IP (dummy) + ///Return deltaEta between eta\@Calo entrance and eta\@IP (dummy) /*! * \param double phi * \param double pt @@ -52,7 +52,7 @@ namespace muIsoUtil { */ double corrDPhiC(double eta, double pt, int charge); - ///Return phi@Calo entrance + ///Return phi\@Calo entrance /*! * \param double phi * \param double eta @@ -61,7 +61,7 @@ namespace muIsoUtil { */ double phiATCal(double phi, double eta, double pt, int charge); - ///Return eta@Calo entrance + ///Return eta\@Calo entrance /*! * \param double phi * \param double eta @@ -71,7 +71,7 @@ namespace muIsoUtil { double etaATCal(double eta); //dummy //double etaATCal(double phi, double eta, double pt, int charge); - ///Return phi@MS entrance + ///Return phi\@MS entrance /*! * \param double phi * \param double eta diff --git a/Trigger/TrigAnalysis/TrigEffJpsiTools/src/MuonRoiWithExtendedBunches.cxx b/Trigger/TrigAnalysis/TrigEffJpsiTools/src/MuonRoiWithExtendedBunches.cxx index eed86b3eb24..6bcb6523150 100644 --- a/Trigger/TrigAnalysis/TrigEffJpsiTools/src/MuonRoiWithExtendedBunches.cxx +++ b/Trigger/TrigAnalysis/TrigEffJpsiTools/src/MuonRoiWithExtendedBunches.cxx @@ -8,7 +8,7 @@ */ /** @todo */ -/** @warnings */ +/** @warning */ /*--------------------------------------------------------------------* * headers diff --git a/Trigger/TrigAnalysis/TrigEffJpsiTools/src/TrigEffJpsiTools.cxx b/Trigger/TrigAnalysis/TrigEffJpsiTools/src/TrigEffJpsiTools.cxx index 11fe2a75413..0d4c16cb5fa 100644 --- a/Trigger/TrigAnalysis/TrigEffJpsiTools/src/TrigEffJpsiTools.cxx +++ b/Trigger/TrigAnalysis/TrigEffJpsiTools/src/TrigEffJpsiTools.cxx @@ -8,7 +8,7 @@ */ /** @todo */ -/** @warnings */ +/** @warning */ /*--------------------------------------------------------------------* * headers diff --git a/Trigger/TrigConfiguration/TrigConfOffline/python/HLTOfflineRules.py b/Trigger/TrigConfiguration/TrigConfOffline/python/HLTOfflineRules.py index 0dbda6439d5..c63219d2f2e 100644 --- a/Trigger/TrigConfiguration/TrigConfOffline/python/HLTOfflineRules.py +++ b/Trigger/TrigConfiguration/TrigConfOffline/python/HLTOfflineRules.py @@ -848,7 +848,7 @@ class RenameRule(object): ## Apply the rule to the HLTAlgorithm list # @param self The object pointer # @param algs - list of HLTAlgorithms - # @parame OutputLevel - obsolete + # @param OutputLevel - obsolete def apply(self, algs, OutputLevel=3): messg = '\n******************************************\n' messg += '|| Rename Rule: Start ||\n' diff --git a/Trigger/TrigSteer/TrigInterfaces/TrigInterfaces/Algo.h b/Trigger/TrigSteer/TrigInterfaces/TrigInterfaces/Algo.h index d8321dc1f7e..2f564b55829 100755 --- a/Trigger/TrigSteer/TrigInterfaces/TrigInterfaces/Algo.h +++ b/Trigger/TrigSteer/TrigInterfaces/TrigInterfaces/Algo.h @@ -354,7 +354,7 @@ namespace HLT /** * @brief Accessor method for the algorithm configuration. - * @parameter cfg new configuration object for this algorithm. + * @param cfg new configuration object for this algorithm. */ void setConfig(AlgoConfig* cfg) { m_config = cfg; } -- GitLab