From 8984a6aa2e86a5db9d92255cc3c3ec7e89fbb1e9 Mon Sep 17 00:00:00 2001 From: aszostak Date: Mon, 11 Jul 2011 22:20:34 +0000 Subject: [PATCH] Fixing in/out tags in documentation --- HLT/MUON/AliHLTMUONProcessor.cxx | 56 ++--- HLT/MUON/AliHLTMUONProcessor.h | 48 ++-- HLT/MUON/AliHLTMUONUtils.cxx | 206 +++++++++--------- HLT/MUON/AliHLTMUONUtils.h | 188 ++++++++-------- HLT/MUON/OfflineInterface/AliHLTMUONAgent.cxx | 12 +- HLT/MUON/OfflineInterface/AliHLTMUONAgent.h | 14 +- .../OfflineInterface/AliHLTMUONESDMaker.h | 10 +- .../AliHLTMUONHitReconstructor.h | 8 +- .../AliHLTMUONTriggerReconstructor.cxx | 38 ++-- .../AliHLTMUONTriggerReconstructor.h | 8 +- HLT/MUON/macros/CreateCDBFieldIntegrals.C | 10 +- HLT/MUON/utils/dHLTdumpraw.cxx | 20 +- 12 files changed, 309 insertions(+), 309 deletions(-) diff --git a/HLT/MUON/AliHLTMUONProcessor.cxx b/HLT/MUON/AliHLTMUONProcessor.cxx index adf22d0ace4..4619f2d9f1f 100644 --- a/HLT/MUON/AliHLTMUONProcessor.cxx +++ b/HLT/MUON/AliHLTMUONProcessor.cxx @@ -333,8 +333,8 @@ int AliHLTMUONProcessor::FetchMappingStores() const int AliHLTMUONProcessor::FetchTMapFromCDB(const char* pathToEntry, TMap*& map) const { /// Fetches a TMap object from the CDB. - /// [in] \param pathToEntry The relative path to the entry in the CDB to fetch. - /// [out] \param map This will be filled with the TMap object found if + /// \param [in] pathToEntry The relative path to the entry in the CDB to fetch. + /// \param [out] map This will be filled with the TMap object found if /// a successful status code is returned. Otherwise it will be unchanged. /// \return Zero if the object could be found. Otherwise an error code, /// which is compatible with the HLT framework, is returned. @@ -365,13 +365,13 @@ int AliHLTMUONProcessor::GetValueFromTMap( ) const { /// Tries to find the string value associated with a certain parameter in a TMap. - /// [in] \param map The TMap object to search in. - /// [in] \param paramName The name of the parameter to search for. - /// [out] \param value Will be filled with the object found. - /// [in] \param pathToEntry The relative path to the entry in the CDB. + /// \param [in] map The TMap object to search in. + /// \param [in] paramName The name of the parameter to search for. + /// \param [out] value Will be filled with the object found. + /// \param [in] pathToEntry The relative path to the entry in the CDB. /// Used when printing error messages. If set to NULL then a string of /// "(unknown)" is used. (default is NULL). - /// [in] \param prettyName Should be the name of the parameter which will + /// \param [in] prettyName Should be the name of the parameter which will /// be used when printing error messages. If this is set to NULL then /// the paramName will be used instead (default is NULL). /// \return Zero if the object could be found. Otherwise an error code, @@ -410,14 +410,14 @@ int AliHLTMUONProcessor::GetIntFromTMap( { /// Tries to find a certain parameter in the TMap object and convert it to /// an integer value. - /// [in] \param map The TMap object to search in. - /// [in] \param paramName The name of the parameter to search for. - /// [out] \param value Will be filled with the integer value for the parameter, + /// \param [in] map The TMap object to search in. + /// \param [in] paramName The name of the parameter to search for. + /// \param [out] value Will be filled with the integer value for the parameter, /// if it was found and it was an integer value. - /// [in] \param pathToEntry The relative path to the entry in the CDB. + /// \param [in] pathToEntry The relative path to the entry in the CDB. /// Used when printing error messages. If set to NULL then a string of /// "(unknown)" is used. (default is NULL). - /// [in] \param prettyName Should be the name of the parameter which will + /// \param [in] prettyName Should be the name of the parameter which will /// be used when printing error messages. If this is set to NULL then /// the paramName will be used instead (default is NULL). /// \return Zero if the object could be found and is valid. Otherwise an @@ -451,14 +451,14 @@ int AliHLTMUONProcessor::GetPositiveIntFromTMap( { /// Tries to find a certain parameter in the TMap object and convert it to /// a positive integer value. - /// [in] \param map The TMap object to search in. - /// [in] \param paramName The name of the parameter to search for. - /// [out] \param value Will be filled with the integer value for the parameter, + /// \param [in] map The TMap object to search in. + /// \param [in] paramName The name of the parameter to search for. + /// \param [out] value Will be filled with the integer value for the parameter, /// if it was found and it was a positive integer value. - /// [in] \param pathToEntry The relative path to the entry in the CDB. + /// \param [in] pathToEntry The relative path to the entry in the CDB. /// Used when printing error messages. If set to NULL then a string of /// "(unknown)" is used. (default is NULL). - /// [in] \param prettyName Should be the name of the parameter which will + /// \param [in] prettyName Should be the name of the parameter which will /// be used when printing error messages. If this is set to NULL then /// the paramName will be used instead (default is NULL). /// \return Zero if the object could be found and is valid. Otherwise an @@ -501,14 +501,14 @@ int AliHLTMUONProcessor::GetFloatFromTMap( { /// Tries to find a certain parameter in the TMap object and convert it to /// an floating point value. - /// [in] \param map The TMap object to search in. - /// [in] \param paramName The name of the parameter to search for. - /// [out] \param value Will be filled with the floating point value for the + /// \param [in] map The TMap object to search in. + /// \param [in] paramName The name of the parameter to search for. + /// \param [out] value Will be filled with the floating point value for the /// parameter, if it was found and it was a floating point value. - /// [in] \param pathToEntry The relative path to the entry in the CDB. + /// \param [in] pathToEntry The relative path to the entry in the CDB. /// Used when printing error messages. If set to NULL then a string of /// "(unknown)" is used. (default is NULL). - /// [in] \param prettyName Should be the name of the parameter which will + /// \param [in] prettyName Should be the name of the parameter which will /// be used when printing error messages. If this is set to NULL then /// the paramName will be used instead (default is NULL). /// \return Zero if the object could be found and is valid. Otherwise an @@ -542,14 +542,14 @@ int AliHLTMUONProcessor::GetPositiveFloatFromTMap( { /// Tries to find a certain parameter in the TMap object and convert it to /// an positive floating point value. - /// [in] \param map The TMap object to search in. - /// [in] \param paramName The name of the parameter to search for. - /// [out] \param value Will be filled with the floating point value for the + /// \param [in] map The TMap object to search in. + /// \param [in] paramName The name of the parameter to search for. + /// \param [out] value Will be filled with the floating point value for the /// parameter, if it was found and it was a positive floating point value. - /// [in] \param pathToEntry The relative path to the entry in the CDB. + /// \param [in] pathToEntry The relative path to the entry in the CDB. /// Used when printing error messages. If set to NULL then a string of /// "(unknown)" is used. (default is NULL). - /// [in] \param prettyName Should be the name of the parameter which will + /// \param [in] prettyName Should be the name of the parameter which will /// be used when printing error messages. If this is set to NULL then /// the paramName will be used instead (default is NULL). /// \return Zero if the object could be found and is valid. Otherwise an @@ -676,7 +676,7 @@ int AliHLTMUONProcessor::FetchFieldIntegral(Double_t& bfieldintegral) const int AliHLTMUONProcessor::LoadRecoParamsFromCDB(AliMUONRecoParam*& params) const { /// Fetches the reconstruction parameters object from the CDB for MUON. - /// [out] \param params This will be filled with the reconstruction + /// \param [out] params This will be filled with the reconstruction /// parameters object found if a successful status code is returned. /// Otherwise it will be unchanged. /// \return Zero if the object could be found. Otherwise an error code, diff --git a/HLT/MUON/AliHLTMUONProcessor.h b/HLT/MUON/AliHLTMUONProcessor.h index 3e3ca0c5b70..aebf58e185d 100644 --- a/HLT/MUON/AliHLTMUONProcessor.h +++ b/HLT/MUON/AliHLTMUONProcessor.h @@ -263,8 +263,8 @@ protected: /** * Fetches a TMap object from the CDB. - * [in] \param pathToEntry The relative path to the entry in the CDB to fetch. - * [out] \param map This will be filled with the TMap object found if + * \param [in] pathToEntry The relative path to the entry in the CDB to fetch. + * \param [out] map This will be filled with the TMap object found if * a successful status code is returned. Otherwise it will be unchanged. * \return Zero if the object could be found. Otherwise an error code, * which is compatible with the HLT framework, is returned. @@ -273,10 +273,10 @@ protected: /** * Tries to find the string value associated with a certain parameter in a TMap. - * [in] \param map The TMap object to search in. - * [in] \param paramName The name of the parameter to search for. - * [out] \param value Will be filled with the object found. - * [in] \param prettyName Should be the name of the parameter which will + * \param [in] map The TMap object to search in. + * \param [in] paramName The name of the parameter to search for. + * \param [out] value Will be filled with the object found. + * \param [in] prettyName Should be the name of the parameter which will * be used when printing error messages. If this is set to NULL then * the paramName will be used instead (default is NULL). * \return Zero if the object could be found. Otherwise an error code, @@ -290,11 +290,11 @@ protected: /** * Tries to find a certain parameter in the TMap object and convert it to * an integer value. - * [in] \param map The TMap object to search in. - * [in] \param paramName The name of the parameter to search for. - * [out] \param value Will be filled with the integer value for the parameter, + * \param [in] map The TMap object to search in. + * \param [in] paramName The name of the parameter to search for. + * \param [out] value Will be filled with the integer value for the parameter, * if it was found and it was an integer value. - * [in] \param prettyName Should be the name of the parameter which will + * \param [in] prettyName Should be the name of the parameter which will * be used when printing error messages. If this is set to NULL then * the paramName will be used instead (default is NULL). * \return Zero if the object could be found and is valid. Otherwise an @@ -308,11 +308,11 @@ protected: /** * Tries to find a certain parameter in the TMap object and convert it to * a positive integer value. - * [in] \param map The TMap object to search in. - * [in] \param paramName The name of the parameter to search for. - * [out] \param value Will be filled with the integer value for the parameter, + * \param [in] map The TMap object to search in. + * \param [in] paramName The name of the parameter to search for. + * \param [out] value Will be filled with the integer value for the parameter, * if it was found and it was a positive integer value. - * [in] \param prettyName Should be the name of the parameter which will + * \param [in] prettyName Should be the name of the parameter which will * be used when printing error messages. If this is set to NULL then * the paramName will be used instead (default is NULL). * \return Zero if the object could be found and is valid. Otherwise an @@ -326,11 +326,11 @@ protected: /** * Tries to find a certain parameter in the TMap object and convert it to * an floating point value. - * [in] \param map The TMap object to search in. - * [in] \param paramName The name of the parameter to search for. - * [out] \param value Will be filled with the floating point value for the + * \param [in] map The TMap object to search in. + * \param [in] paramName The name of the parameter to search for. + * \param [out] value Will be filled with the floating point value for the * parameter, if it was found and it was a floating point value. - * [in] \param prettyName Should be the name of the parameter which will + * \param [in] prettyName Should be the name of the parameter which will * be used when printing error messages. If this is set to NULL then * the paramName will be used instead (default is NULL). * \return Zero if the object could be found and is valid. Otherwise an @@ -344,11 +344,11 @@ protected: /** * Tries to find a certain parameter in the TMap object and convert it to * an positive floating point value. - * [in] \param map The TMap object to search in. - * [in] \param paramName The name of the parameter to search for. - * [out] \param value Will be filled with the floating point value for the + * \param [in] map The TMap object to search in. + * \param [in] paramName The name of the parameter to search for. + * \param [out] value Will be filled with the floating point value for the * parameter, if it was found and it was a positive floating point value. - * [in] \param prettyName Should be the name of the parameter which will + * \param [in] prettyName Should be the name of the parameter which will * be used when printing error messages. If this is set to NULL then * the paramName will be used instead (default is NULL). * \return Zero if the object could be found and is valid. Otherwise an @@ -363,7 +363,7 @@ protected: * Loads the appropriate field integral from the CDB based on the currently * loaded global magnetic field in TGeoGlobalMagField. If the global field is * not loaded then we try load the GRP entry to figure out the correct integral. - * [out] \param bfieldintegral Will be filled with the dipole magnetic field + * \param [out] bfieldintegral Will be filled with the dipole magnetic field * integral value to use. * \return Zero if the field integral could be found and is valid. Otherwise an * error code is returned, which is compatible with the HLT framework. @@ -372,7 +372,7 @@ protected: /** * Fetches the reconstruction parameters object from the CDB for MUON. - * [out] \param params This will be filled with the reconstruction + * \param [out] params This will be filled with the reconstruction * parameters object found if a successful status code is returned. * Otherwise it will be unchanged. * \return Zero if the object could be found. Otherwise an error code, diff --git a/HLT/MUON/AliHLTMUONUtils.cxx b/HLT/MUON/AliHLTMUONUtils.cxx index 17e419428a1..12c13ff8326 100644 --- a/HLT/MUON/AliHLTMUONUtils.cxx +++ b/HLT/MUON/AliHLTMUONUtils.cxx @@ -117,9 +117,9 @@ void AliHLTMUONUtils::UnpackRecHitFlags( { /// This unpacks the AliHLTMUONRecHitStruct::fFlags bits into /// its component fields. - /// [in] @param flags The flags from an AliHLTMUONRecHitStruct structure. - /// [out] @param chamber Sets the chamber number in the range [0..13]. - /// [out] @param detElemId Sets the detector element ID number. + /// @param [in] flags The flags from an AliHLTMUONRecHitStruct structure. + /// @param [out] chamber Sets the chamber number in the range [0..13]. + /// @param [out] detElemId Sets the detector element ID number. chamber = (flags >> 12) & 0xF; detElemId = flags & 0xFFF; @@ -760,12 +760,12 @@ bool AliHLTMUONUtils::HeaderOk( { /// Method used to check if the header information corresponds to the /// supposed type of the raw dHLT data block. - /// [in] \param block The data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the header is not /// valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -808,12 +808,12 @@ bool AliHLTMUONUtils::HeaderOk( { /// Method used to check if the header information corresponds to the /// supposed type of the raw dHLT data block. - /// [in] \param block The data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the header is not /// valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -856,12 +856,12 @@ bool AliHLTMUONUtils::HeaderOk( { /// Method used to check if the header information corresponds to the /// supposed type of the raw dHLT data block. - /// [in] \param block The data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the header is not /// valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -904,12 +904,12 @@ bool AliHLTMUONUtils::HeaderOk( { /// Method used to check if the header information corresponds to the /// supposed type of the raw dHLT data block. - /// [in] \param block The data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the header is not /// valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -952,12 +952,12 @@ bool AliHLTMUONUtils::HeaderOk( { /// Method used to check if the header information corresponds to the /// supposed type of the raw dHLT data block. - /// [in] \param block The data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the header is not /// valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -1000,12 +1000,12 @@ bool AliHLTMUONUtils::HeaderOk( { /// Method used to check if the header information corresponds to the /// supposed type of the raw dHLT data block. - /// [in] \param block The data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the header is not /// valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -1048,12 +1048,12 @@ bool AliHLTMUONUtils::HeaderOk( { /// Method used to check if the header information corresponds to the /// supposed type of the raw dHLT data block. - /// [in] \param block The data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the header is not /// valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -1096,12 +1096,12 @@ bool AliHLTMUONUtils::HeaderOk( { /// Method used to check if the header information corresponds to the /// supposed type of the raw dHLT data block. - /// [in] \param block The data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the header is not /// valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -1144,12 +1144,12 @@ bool AliHLTMUONUtils::HeaderOk( { /// Method used to check if the header information corresponds to the /// supposed type of the raw dHLT data block. - /// [in] \param block The data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the header is not /// valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -1192,12 +1192,12 @@ bool AliHLTMUONUtils::HeaderOk( { /// Method used to check if the header information corresponds to the /// supposed type of the raw dHLT data block. - /// [in] \param block The data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the header is not /// valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -1241,12 +1241,12 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// trigger record structure is OK and returns true in that case. - /// [in] \param tr The trigger record structure to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] tr The trigger record structure to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the structure is /// not valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -1332,12 +1332,12 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// dHLT raw internal data block is OK and returns true in that case. - /// [in] \param block The trigger record data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The trigger record data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the data block is /// not valid. - /// [out] \param recordNum If this is not NULL, then it is assumed to point + /// \param [out] recordNum If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the number of the trigger record that had a problem. /// The value 'recordNum[i]' will only contain a valid value if @@ -1350,7 +1350,7 @@ bool AliHLTMUONUtils::IntegrityOk( /// - kInvalidChamberNumber /// \note You can use RecordNumberWasSet(reason[i]) to check if 'recordNum[i]' /// was set and is valid or not. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason' and 'recordNum'. It will be filled /// with the number of items actually filled into the arrays upon exit /// from this method. @@ -1410,12 +1410,12 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// trigger record debug information structure is OK and returns true in that case. - /// [in] \param trigInfo The trigger record debug information structure to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] trigInfo The trigger record debug information structure to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the structure is not /// valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -1468,13 +1468,13 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// dHLT raw internal data block is OK and returns true in that case. - /// [in] \param block The trigger record debugging information data block + /// \param [in] block The trigger record debugging information data block /// to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the data block is /// not valid. - /// [out] \param recordNum If this is not NULL, then it is assumed to point + /// \param [out] recordNum If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the number of the trigger record debug information /// structure that had a problem. @@ -1484,7 +1484,7 @@ bool AliHLTMUONUtils::IntegrityOk( /// - kInvalidDetElementNumber /// \note You can use RecordNumberWasSet(reason[i]) to check if 'recordNum[i]' /// was set and is valid or not. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason' and 'recordNum'. It will be filled /// with the number of items actually filled into the arrays upon exit /// from this method. @@ -1544,12 +1544,12 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// reconstructed hit structure is OK and returns true in that case. - /// [in] \param hit The reconstructed hit structure to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] hit The reconstructed hit structure to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the structure is /// not valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -1615,12 +1615,12 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// dHLT raw internal hits data block is OK and returns true in that case. - /// [in] \param block The reconstructed hits data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The reconstructed hits data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the data block is /// not valid. - /// [out] \param recordNum If this is not NULL, then it is assumed to point + /// \param [out] recordNum If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the number of the reconstructed hits that had a problem. /// The value 'recordNum[i]' will only contain a valid value if @@ -1630,7 +1630,7 @@ bool AliHLTMUONUtils::IntegrityOk( /// - kInvalidChamberNumber /// \note You can use RecordNumberWasSet(reason[i]) to check if 'recordNum[i]' /// was set and is valid or not. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason' and 'recordNum'. It will be filled /// with the number of items actually filled into the arrays upon exit /// from this method. @@ -1690,12 +1690,12 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// cluster structure is OK and returns true in that case. - /// [in] \param cluster The cluster structure to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] cluster The cluster structure to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the structure is /// not valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -1795,12 +1795,12 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// dHLT internal clusters data block is OK and returns true in that case. - /// [in] \param block The clusters data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The clusters data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the data block is /// not valid. - /// [out] \param recordNum If this is not NULL, then it is assumed to point + /// \param [out] recordNum If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the number of the cluster structure that had a problem. /// The value 'recordNum[i]' will only contain a valid value if @@ -1814,7 +1814,7 @@ bool AliHLTMUONUtils::IntegrityOk( /// - kInvalidChargeNB /// \note You can use RecordNumberWasSet(reason[i]) to check if 'recordNum[i]' /// was set and is valid or not. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason' and 'recordNum'. It will be filled /// with the number of items actually filled into the arrays upon exit /// from this method. @@ -1892,12 +1892,12 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// channel structure is OK and returns true in that case. - /// [in] \param cluster The channel structure to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] cluster The channel structure to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the structure is /// not valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -1993,12 +1993,12 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// dHLT internal channels data block is OK and returns true in that case. - /// [in] \param block The channels data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The channels data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the data block is /// not valid. - /// [out] \param recordNum If this is not NULL, then it is assumed to point + /// \param [out] recordNum If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the number of the channel structure that had a problem. /// The value 'recordNum[i]' will only contain a valid value if @@ -2011,7 +2011,7 @@ bool AliHLTMUONUtils::IntegrityOk( /// - kDataWordDifferent /// \note You can use RecordNumberWasSet(reason[i]) to check if 'recordNum[i]' /// was set and is valid or not. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason' and 'recordNum'. It will be filled /// with the number of items actually filled into the arrays upon exit /// from this method. @@ -2053,12 +2053,12 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// Manso track structure is OK and returns true in that case. - /// [in] \param track The track structure to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] track The track structure to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the structure is /// not valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -2179,12 +2179,12 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// dHLT internal Manso track data block is OK and returns true in that case. - /// [in] \param block The Manso track data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The Manso track data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the data block is /// not valid. - /// [out] \param recordNum If this is not NULL, then it is assumed to point + /// \param [out] recordNum If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the number of the Manso track that had a problem. /// The value 'recordNum[i]' will only contain a valid value if @@ -2200,7 +2200,7 @@ bool AliHLTMUONUtils::IntegrityOk( /// - kInvalidChamberNumber /// \note You can use RecordNumberWasSet(reason[i]) to check if 'recordNum[i]' /// was set and is valid or not. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason' and 'recordNum'. It will be filled /// with the number of items actually filled into the arrays upon exit /// from this method. @@ -2260,12 +2260,12 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// Manso track candidate structure is OK and returns true in that case. - /// [in] \param track The track candidate structure to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] track The track candidate structure to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the structure is /// not valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -2325,12 +2325,12 @@ bool AliHLTMUONUtils::IntegrityOk( /// This method is used to check more extensively if the integrity of the /// dHLT internal Manso candidates data block is OK and returns true in /// that case. - /// [in] \param block The Manso track candidate data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The Manso track candidate data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the data block is /// not valid. - /// [out] \param recordNum If this is not NULL, then it is assumed to point + /// \param [out] recordNum If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the number of the track candidate that had a problem. /// The value 'recordNum[i]' will only contain a valid value if @@ -2345,7 +2345,7 @@ bool AliHLTMUONUtils::IntegrityOk( /// - kHitNotWithinRoi /// \note You can use RecordNumberWasSet(reason[i]) to check if 'recordNum[i]' /// was set and is valid or not. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason' and 'recordNum'. It will be filled /// with the number of items actually filled into the arrays upon exit /// from this method. @@ -2405,12 +2405,12 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// full track structure is OK and returns true in that case. - /// [in] \param track The track structure to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] track The track structure to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the structure is /// not valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -2556,12 +2556,12 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// dHLT internal track data block is OK and returns true in that case. - /// [in] \param block The track data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The track data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the data block is /// not valid. - /// [out] \param recordNum If this is not NULL, then it is assumed to point + /// \param [out] recordNum If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the number of the Manso track that had a problem. /// The value 'recordNum[i]' will only contain a valid value if @@ -2579,7 +2579,7 @@ bool AliHLTMUONUtils::IntegrityOk( /// - kInvalidChamberNumber /// \note You can use RecordNumberWasSet(reason[i]) to check if 'recordNum[i]' /// was set and is valid or not. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason' and 'recordNum'. It will be filled /// with the number of items actually filled into the arrays upon exit /// from this method. @@ -2639,12 +2639,12 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// single track trigger decision structure is OK and returns true in that case. - /// [in] \param decision The trigger decision structure to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] decision The trigger decision structure to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the structure is not /// valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -2702,12 +2702,12 @@ bool AliHLTMUONUtils::IntegrityOk( /// This method is used to check more extensively if the integrity of the /// dHLT internal single track trigger decision data block is OK and returns /// true in that case. - /// [in] \param block The single track trigger decision data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The single track trigger decision data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the data block is /// not valid. - /// [out] \param recordNum If this is not NULL, then it is assumed to point + /// \param [out] recordNum If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the number of the trigger decision that had a problem. /// The value 'recordNum[i]' will only contain a valid value if @@ -2717,7 +2717,7 @@ bool AliHLTMUONUtils::IntegrityOk( /// - kPtValueNotValid /// \note You can use RecordNumberWasSet(reason[i]) to check if 'recordNum[i]' /// was set and is valid or not. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason' and 'recordNum'. It will be filled /// with the number of items actually filled into the arrays upon exit /// from this method. @@ -2777,12 +2777,12 @@ bool AliHLTMUONUtils::IntegrityOk( { /// This method is used to check more extensively if the integrity of the /// track pair trigger decision structure is OK and returns true in that case. - /// [in] \param decision The trigger decision structure to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] decision The trigger decision structure to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the structure is not /// valid. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason'. It will be filled with the number /// of items actually filled into the reason array upon exit from this /// method. @@ -2877,12 +2877,12 @@ bool AliHLTMUONUtils::IntegrityOk( /// This method is used to check more extensively if the integrity of the /// dHLT internal track pair trigger decision data block is OK and returns /// true in that case. - /// [in] \param block The track pair trigger decision data block to check. - /// [out] \param reason If this is not NULL, then it is assumed to point + /// \param [in] block The track pair trigger decision data block to check. + /// \param [out] reason If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the reason codes describing why the data block is /// not valid. - /// [out] \param recordNum If this is not NULL, then it is assumed to point + /// \param [out] recordNum If this is not NULL, then it is assumed to point /// to an array of at least 'reasonCount' number of elements. It will /// be filled with the number of the trigger decision that had a problem. /// The value 'recordNum[i]' will only contain a valid value if @@ -2895,7 +2895,7 @@ bool AliHLTMUONUtils::IntegrityOk( /// - kHighPtCountInvalid /// \note You can use RecordNumberWasSet(reason[i]) to check if 'recordNum[i]' /// was set and is valid or not. - /// [in/out] \param reasonCount This should initially specify the size of + /// \param [in,out] reasonCount This should initially specify the size of /// the array pointed to by 'reason' and 'recordNum'. It will be filled /// with the number of items actually filled into the arrays upon exit /// from this method. diff --git a/HLT/MUON/AliHLTMUONUtils.h b/HLT/MUON/AliHLTMUONUtils.h index 48cf384020d..205d9709321 100644 --- a/HLT/MUON/AliHLTMUONUtils.h +++ b/HLT/MUON/AliHLTMUONUtils.h @@ -64,9 +64,9 @@ public: /** * This unpacks the AliHLTMUONTriggerRecordStruct::fFlags bits into * its component fields. - * @param flags The flags from an AliHLTMUONTriggerRecordStruct structure. - * @param sign Sets this to the particle sign. - * @param hitset Sets the array elements to indicate if the corresponding + * @param [in] flags The flags from an AliHLTMUONTriggerRecordStruct structure. + * @param [out] sign Sets this to the particle sign. + * @param [out] hitset Sets the array elements to indicate if the corresponding * fHits[i] element was set/filled. */ static void UnpackTriggerRecordFlags( @@ -89,9 +89,9 @@ public: /** * This unpacks the AliHLTMUONRecHitStruct::fFlags bits into * its component fields. - * [in] @param flags The flags from an AliHLTMUONRecHitStruct structure. - * [out] @param chamber Sets the chamber number in the range [0..13]. - * [out] @param detElemId Sets the detector element ID number. + * @param [in] flags The flags from an AliHLTMUONRecHitStruct structure. + * @param [out] chamber Sets the chamber number in the range [0..13]. + * @param [out] detElemId Sets the detector element ID number. */ static void UnpackRecHitFlags( AliHLTUInt32_t flags, // [in] @@ -101,7 +101,7 @@ public: /** * Returns the detector element ID from the flags bits. - * [in] @param flags The flags from an AliHLTMUONRecHitStruct structure. + * @param [in] flags The flags from an AliHLTMUONRecHitStruct structure. */ static AliHLTUInt16_t GetDetElemIdFromFlags(AliHLTUInt32_t flags) { @@ -126,9 +126,9 @@ public: /** * This unpacks the AliHLTMUONMansoTrackStruct::fFlags bits into * its component fields. - * @param flags The flags from an AliHLTMUONMansoTrackStruct structure. - * @param sign Sets this to the particle sign. - * @param hitset Sets the array elements to indicate if the corresponding + * @param [in] flags The flags from an AliHLTMUONMansoTrackStruct structure. + * @param [out] sign Sets this to the particle sign. + * @param [out] hitset Sets the array elements to indicate if the corresponding * fHits[i] element was set/filled. */ static void UnpackMansoTrackFlags( @@ -155,9 +155,9 @@ public: /** * This unpacks the AliHLTMUONTrackStruct::fFlags bits into * its component fields. - * @param flags The flags from an AliHLTMUONTrackStruct structure. - * @param sign Sets this to the particle sign. - * @param hitset Sets the array elements to indicate if the corresponding + * @param [in] flags The flags from an AliHLTMUONTrackStruct structure. + * @param [out] sign Sets this to the particle sign. + * @param [out] hitset Sets the array elements to indicate if the corresponding * fHits[i] element was set/filled. */ static void UnpackTrackFlags( @@ -178,10 +178,10 @@ public: /** * This unpacks the AliHLTMUONTrackDecisionStruct::fTriggerBits bits into * its component fields. - * @param bits The trigger bits from an AliHLTMUONTrackDecisionStruct + * @param [in] bits The trigger bits from an AliHLTMUONTrackDecisionStruct * structure. - * @param highPt Sets this to the value of the high pt cut bit. - * @param lowPt Sets this to the value of the low pt cut bit. + * @param [out] highPt Sets this to the value of the high pt cut bit. + * @param [out] lowPt Sets this to the value of the low pt cut bit. */ static void UnpackTrackDecisionBits( AliHLTUInt32_t bits, // [in] @@ -213,13 +213,13 @@ public: /** * This unpacks the AliHLTMUONPairDecisionStruct::fTriggerBits bits into * its component fields. - * @param bits The trigger bits from an AliHLTMUONPairDecisionStruct + * @param [in] bits The trigger bits from an AliHLTMUONPairDecisionStruct * structure. - * @param highMass Sets this to the value of the high invariant mass cut bit. - * @param lowMass Sets this to the value of the low invariant mass cut bit. - * @param unlike Sets this if the pair is unlike sign. - * @param highPtCount Sets this to the high pt count bits. - * @param lowPtCount Sets this to the low pt count bits. + * @param [out] highMass Sets this to the value of the high invariant mass cut bit. + * @param [out] lowMass Sets this to the value of the low invariant mass cut bit. + * @param [out] unlike Sets this if the pair is unlike sign. + * @param [out] highPtCount Sets this to the high pt count bits. + * @param [out] lowPtCount Sets this to the low pt count bits. */ static void UnpackPairDecisionBits( AliHLTUInt32_t bits, // [in] @@ -247,8 +247,8 @@ public: /** * This unpacks the AliHLTMUONPairDecisionStruct::fTriggerBits bits into * its component fields. - * @param bits The Pub/Sub specification word from a data block descriptor. - * @param ddl The output list of DDLs forming part of the readout. ddl[0] + * @param [in] bits The Pub/Sub specification word from a data block descriptor. + * @param [out] ddl The output list of DDLs forming part of the readout. ddl[0] * indicates DDL number 2560, ddl[1] is for DDL 2561 and so * on up to ddl[19]. ddl[20] and ddl[21] will be for the * trigger DDLs 2816 and 2817 respectively. @@ -439,8 +439,8 @@ public: * supposed type of the trigger records data block. * This method will return either kHeaderContainsWrongType or * kHeaderContainsWrongRecordWidth as the reason code. - * [in] \param block The data block to check. - * [out] \param reason If this is not NULL, then the variable pointed to + * \param [in] block The data block to check. + * \param [out] reason If this is not NULL, then the variable pointed to * by this pointer will be filled with the reason code describing why * the header is not valid, if and only if a problem is found with * the data. @@ -457,8 +457,8 @@ public: * supposed type of the trigger debug information data block. * This method will return either kHeaderContainsWrongType or * kHeaderContainsWrongRecordWidth as the reason code. - * [in] \param block The data block to check. - * [out] \param reason If this is not NULL, then the variable pointed to + * \param [in] block The data block to check. + * \param [out] reason If this is not NULL, then the variable pointed to * by this pointer will be filled with the reason code describing why * the header is not valid, if and only if a problem is found with * the data. @@ -475,8 +475,8 @@ public: * supposed type of the reconstructed hits data block. * This method will return either kHeaderContainsWrongType or * kHeaderContainsWrongRecordWidth as the reason code. - * [in] \param block The data block to check. - * [out] \param reason If this is not NULL, then the variable pointed to + * \param [in] block The data block to check. + * \param [out] reason If this is not NULL, then the variable pointed to * by this pointer will be filled with the reason code describing why * the header is not valid, if and only if a problem is found with * the data. @@ -493,8 +493,8 @@ public: * supposed type of the clusters data block. * This method will return either kHeaderContainsWrongType or * kHeaderContainsWrongRecordWidth as the reason code. - * [in] \param block The data block to check. - * [out] \param reason If this is not NULL, then the variable pointed to + * \param [in] block The data block to check. + * \param [out] reason If this is not NULL, then the variable pointed to * by this pointer will be filled with the reason code describing why * the header is not valid, if and only if a problem is found with * the data. @@ -511,8 +511,8 @@ public: * supposed type of the channels data block. * This method will return either kHeaderContainsWrongType or * kHeaderContainsWrongRecordWidth as the reason code. - * [in] \param block The data block to check. - * [out] \param reason If this is not NULL, then the variable pointed to + * \param [in] block The data block to check. + * \param [out] reason If this is not NULL, then the variable pointed to * by this pointer will be filled with the reason code describing why * the header is not valid, if and only if a problem is found with * the data. @@ -529,8 +529,8 @@ public: * supposed type of the Manso tracks data block. * This method will return either kHeaderContainsWrongType or * kHeaderContainsWrongRecordWidth as the reason code. - * [in] \param block The data block to check. - * [out] \param reason If this is not NULL, then the variable pointed to + * \param [in] block The data block to check. + * \param [out] reason If this is not NULL, then the variable pointed to * by this pointer will be filled with the reason code describing why * the header is not valid, if and only if a problem is found with * the data. @@ -547,8 +547,8 @@ public: * supposed type of the Manso candidates data block. * This method will return either kHeaderContainsWrongType or * kHeaderContainsWrongRecordWidth as the reason code. - * [in] \param block The data block to check. - * [out] \param reason If this is not NULL, then the variable pointed to + * \param [in] block The data block to check. + * \param [out] reason If this is not NULL, then the variable pointed to * by this pointer will be filled with the reason code describing why * the header is not valid, if and only if a problem is found with * the data. @@ -565,8 +565,8 @@ public: * supposed type of the tracks data block given. * This method will return either kHeaderContainsWrongType or * kHeaderContainsWrongRecordWidth as the reason code. - * [in] \param block The data block to check. - * [out] \param reason If this is not NULL, then the variable pointed to + * \param [in] block The data block to check. + * \param [out] reason If this is not NULL, then the variable pointed to * by this pointer will be filled with the reason code describing why * the header is not valid, if and only if a problem is found with * the data. @@ -583,8 +583,8 @@ public: * supposed type of the single tracks dHLT trigger decision data block. * This method will return either kHeaderContainsWrongType or * kHeaderContainsWrongRecordWidth as the reason code. - * [in] \param block The data block to check. - * [out] \param reason If this is not NULL, then the variable pointed to + * \param [in] block The data block to check. + * \param [out] reason If this is not NULL, then the variable pointed to * by this pointer will be filled with the reason code describing why * the header is not valid, if and only if a problem is found with * the data. @@ -601,8 +601,8 @@ public: * supposed type of the track pairs dHLT trigger decision data block. * This method will return either kHeaderContainsWrongType or * kHeaderContainsWrongRecordWidth as the reason code. - * [in] \param block The data block to check. - * [out] \param reason If this is not NULL, then the variable pointed to + * \param [in] block The data block to check. + * \param [out] reason If this is not NULL, then the variable pointed to * by this pointer will be filled with the reason code describing why * the header is not valid, if and only if a problem is found with * the data. @@ -676,8 +676,8 @@ public: /** * This method is used to check more extensively if the integrity of the * trigger record structure is OK and returns true in that case. - * [in] \param tr The trigger record structure to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] tr The trigger record structure to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the structure is not valid, if and * only if a problem is found with the data. * \returns true if there is no problem with the structure and false otherwise. @@ -694,11 +694,11 @@ public: /** * This method is used to check more extensively if the integrity of the * dHLT raw internal data block is OK and returns true in that case. - * [in] \param block The trigger record data block to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] block The trigger record data block to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the data block is not valid, if and * only if a problem is found with the data. - * [out] \param recordNum If this is not NULL, then it will be filled with + * \param [out] recordNum If this is not NULL, then it will be filled with * the number of the trigger record that had a problem. This value will * only contain a valid value if the method RecordNumberWasSet(*reason) * returns true. Thus, 'reason' must be set. @@ -716,8 +716,8 @@ public: /** * This method is used to check more extensively if the integrity of the * trigger record debug information structure is OK and returns true in that case. - * [in] \param trigInfo The trigger record debug information structure to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] trigInfo The trigger record debug information structure to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the structure is not valid, if and * only if a problem is found with the data. * \returns true if there is no problem with the structure and false otherwise. @@ -734,11 +734,11 @@ public: /** * This method is used to check more extensively if the integrity of the * dHLT raw internal data block is OK and returns true in that case. - * [in] \param block The trigger record debugging information data block to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] block The trigger record debugging information data block to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the data block is not valid, if and * only if a problem is found with the data. - * [out] \param recordNum If this is not NULL, then it will be filled with + * \param [out] recordNum If this is not NULL, then it will be filled with * the number of the trigger record debug information structure that had * a problem. This value will only contain a valid value if the method * RecordNumberWasSet(*reason) returns true. Thus, 'reason' must be set. @@ -756,8 +756,8 @@ public: /** * This method is used to check more extensively if the integrity of the * reconstructed hit structure is OK and returns true in that case. - * [in] \param hit The reconstructed hit structure to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] hit The reconstructed hit structure to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the structure is not valid, if and * only if a problem is found with the data. * \returns true if there is no problem with the data and false otherwise. @@ -774,11 +774,11 @@ public: /** * This method is used to check more extensively if the integrity of the * dHLT raw internal data block is OK and returns true in that case. - * [in] \param block The reconstructed hits data block to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] block The reconstructed hits data block to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the data block is not valid, if and * only if a problem is found with the data. - * [out] \param recordNum If this is not NULL, then it will be filled with + * \param [out] recordNum If this is not NULL, then it will be filled with * the number of the cluster structure that had a problem. This value * will only contain a valid value if the method * RecordNumberWasSet(*reason) returns true. Thus, 'reason' must be set. @@ -796,8 +796,8 @@ public: /** * This method is used to check more extensively if the integrity of the * cluster data structure is OK and returns true in that case. - * [in] \param cluster The cluster structure to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] cluster The cluster structure to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the structure is not valid, if and * only if a problem is found with the data. * \returns true if there is no problem with the data and false otherwise. @@ -814,11 +814,11 @@ public: /** * This method is used to check more extensively if the integrity of the * dHLT raw internal data block is OK and returns true in that case. - * [in] \param block The clusters data block to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] block The clusters data block to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the data block is not valid, if and * only if a problem is found with the data. - * [out] \param recordNum If this is not NULL, then it will be filled with + * \param [out] recordNum If this is not NULL, then it will be filled with * the number of the cluster structure that had a problem. This value * will only contain a valid value if the method * RecordNumberWasSet(*reason) returns true. Thus, 'reason' must be set. @@ -836,8 +836,8 @@ public: /** * This method is used to check more extensively if the integrity of the * channel data structure is OK and returns true in that case. - * [in] \param cluster The channel structure to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] cluster The channel structure to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the structure is not valid, if and * only if a problem is found with the data. * \returns true if there is no problem with the data and false otherwise. @@ -854,11 +854,11 @@ public: /** * This method is used to check more extensively if the integrity of the * dHLT raw internal data block is OK and returns true in that case. - * [in] \param block The ADC channels data block to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] block The ADC channels data block to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the data block is not valid, if and * only if a problem is found with the data. - * [out] \param recordNum If this is not NULL, then it will be filled with + * \param [out] recordNum If this is not NULL, then it will be filled with * the number of the channel structure that had a problem. This value * will only contain a valid value if the method * RecordNumberWasSet(*reason) returns true. Thus, 'reason' must be set. @@ -876,8 +876,8 @@ public: /** * This method is used to check more extensively if the integrity of the * Manso track structure is OK and returns true in that case. - * [in] \param track The Manso track structure to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] track The Manso track structure to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the structure is not valid, if and * only if a problem is found with the data. * \returns true if there is no problem with the structure and false otherwise. @@ -894,11 +894,11 @@ public: /** * This method is used to check more extensively if the integrity of the * dHLT raw internal data block is OK and returns true in that case. - * [in] \param block The Manso track data block to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] block The Manso track data block to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the data block is not valid, if and * only if a problem is found with the data. - * [out] \param recordNum If this is not NULL, then it will be filled with + * \param [out] recordNum If this is not NULL, then it will be filled with * the number of the Manso track structure that had a problem. * This value will only contain a valid value if the method * RecordNumberWasSet(*reason) returns true. Thus, 'reason' must be set. @@ -916,8 +916,8 @@ public: /** * This method is used to check more extensively if the integrity of the * Manso track candidate structure is OK and returns true in that case. - * [in] \param candidate The Manso track candidate structure to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] candidate The Manso track candidate structure to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the structure is not valid, if and * only if a problem is found with the data. * \returns true if there is no problem with the structure and false otherwise. @@ -934,11 +934,11 @@ public: /** * This method is used to check more extensively if the integrity of the * dHLT raw internal data block is OK and returns true in that case. - * [in] \param block The Manso track candidate data block to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] block The Manso track candidate data block to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the data block is not valid, if and * only if a problem is found with the data. - * [out] \param recordNum If this is not NULL, then it will be filled with + * \param [out] recordNum If this is not NULL, then it will be filled with * the number of the Manso track candidate structure that had a problem. * This value will only contain a valid value if the method * RecordNumberWasSet(*reason) returns true. Thus, 'reason' must be set. @@ -956,8 +956,8 @@ public: /** * This method is used to check more extensively if the integrity of the * full track structure is OK and returns true in that case. - * [in] \param track The track structure to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] track The track structure to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the structure is not valid, if and * only if a problem is found with the data. * \returns true if there is no problem with the structure and false otherwise. @@ -974,11 +974,11 @@ public: /** * This method is used to check more extensively if the integrity of the * dHLT raw internal data block is OK and returns true in that case. - * [in] \param block The track data block to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] block The track data block to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the data block is not valid, if and * only if a problem is found with the data. - * [out] \param recordNum If this is not NULL, then it will be filled with + * \param [out] recordNum If this is not NULL, then it will be filled with * the number of the Manso track structure that had a problem. * This value will only contain a valid value if the method * RecordNumberWasSet(*reason) returns true. Thus, 'reason' must be set. @@ -996,8 +996,8 @@ public: /** * This method is used to check more extensively if the integrity of the * single track trigger decision structure is OK and returns true in that case. - * [in] \param decision The trigger decision structure to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] decision The trigger decision structure to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the structure is not valid, if and * only if a problem is found with the data. * \returns true if there is no problem with the structure and false otherwise. @@ -1014,11 +1014,11 @@ public: /** * This method is used to check more extensively if the integrity of the * dHLT raw internal data block is OK and returns true in that case. - * [in] \param block The single track trigger decision data block to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] block The single track trigger decision data block to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the data block is not valid, if and * only if a problem is found with the data. - * [out] \param recordNum If this is not NULL, then it will be filled with + * \param [out] recordNum If this is not NULL, then it will be filled with * the number of the single track trigger decision structure that had * a problem. This value will only contain a valid value if the method * RecordNumberWasSet(*reason) returns true. Thus, 'reason' must be set. @@ -1036,8 +1036,8 @@ public: /** * This method is used to check more extensively if the integrity of the * track pair trigger decision structure is OK and returns true in that case. - * [in] \param decision The trigger decision structure to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] decision The trigger decision structure to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the structure is not valid, if and * only if a problem is found with the data. * \returns true if there is no problem with the structure and false otherwise. @@ -1054,11 +1054,11 @@ public: /** * This method is used to check more extensively if the integrity of the * dHLT raw internal data block is OK and returns true in that case. - * [in] \param block The track pair trigger decision data block to check. - * [out] \param reason If this is not NULL, then it will be filled with + * \param [in] block The track pair trigger decision data block to check. + * \param [out] reason If this is not NULL, then it will be filled with * the reason code describing why the data block is not valid, if and * only if a problem is found with the data. - * [out] \param recordNum If this is not NULL, then it will be filled with + * \param [out] recordNum If this is not NULL, then it will be filled with * the number of the track pairs trigger decision structure that had * a problem. This value will only contain a valid value if the method * RecordNumberWasSet(*reason) returns true. Thus, 'reason' must be set. diff --git a/HLT/MUON/OfflineInterface/AliHLTMUONAgent.cxx b/HLT/MUON/OfflineInterface/AliHLTMUONAgent.cxx index eb97aab3fcd..b3fb83b60ed 100644 --- a/HLT/MUON/OfflineInterface/AliHLTMUONAgent.cxx +++ b/HLT/MUON/OfflineInterface/AliHLTMUONAgent.cxx @@ -112,8 +112,8 @@ const char* AliHLTMUONAgent::GetReconstructionChains(AliRawReader* rawReader, /// Inherited from AliHLTModuleAgent. /// Returns the top processing chain configurations for local event /// reconstruction. - /// @param rawReader [in] AliRoot rawreader instance. - /// @param runloader [in] AliRoot runloader + /// @param [in] rawReader AliRoot rawreader instance. + /// @param [in] runloader AliRoot runloader /// @return string containing the top configurations separated by blanks. /// /// If rawReader is not NULL then the standard dHLT chain is run taking @@ -241,9 +241,9 @@ int AliHLTMUONAgent::CreateConfigurations( { /// Register all processing configurations belonging to the dimuon HLT /// library with the AliHLTConfigurationHandler. - /// @param handler the configuration handler - /// @param rawReader [in] AliRoot rawreader instance. - /// @param runloader AliRoot runloader + /// @param [in] handler the configuration handler + /// @param [in] rawReader AliRoot rawreader instance. + /// @param [in] runloader AliRoot runloader /// @return Zero on success and error code if failed. /// /// Chains available: @@ -463,7 +463,7 @@ int AliHLTMUONAgent::RegisterComponents(AliHLTComponentHandler* pHandler) const { /// /// Registers all available components of this module. - /// @param pHandler [in] instance of the component handler. + /// @param [in] pHandler instance of the component handler. /// if (pHandler == NULL) return -EINVAL; diff --git a/HLT/MUON/OfflineInterface/AliHLTMUONAgent.h b/HLT/MUON/OfflineInterface/AliHLTMUONAgent.h index 56a528cf4cd..8d49e86caa3 100644 --- a/HLT/MUON/OfflineInterface/AliHLTMUONAgent.h +++ b/HLT/MUON/OfflineInterface/AliHLTMUONAgent.h @@ -46,7 +46,7 @@ public: /** * Returns the top processing chain configurations for local event * reconstruction. - * @param runloader [in] AliRoot runloader + * @param [in] runloader AliRoot runloader * @return string containing the top configurations separated by blanks. */ virtual const char* GetReconstructionChains(AliRawReader* rawReader=NULL, @@ -60,15 +60,15 @@ public: /** * Registers all available components of this module. - * @param pHandler [in] instance of the component handler. + * @param [in] pHandler instance of the component handler. */ virtual int RegisterComponents(AliHLTComponentHandler* pHandler) const; /** * Get handler decription for dHLT data in the HLTOUT data stream. - * @param dt [in] data type of the block - * @param spec [in] specification of the block - * @param desc [out] handler description + * @param [in] dt data type of the block + * @param [in] spec specification of the block + * @param [out] desc handler description * @return 1 if the agent can provide a handler, 0 if not. */ virtual int GetHandlerDescription( @@ -79,8 +79,8 @@ public: /** * Get specific handler for dHLT data in the HLTOUT data stream. - * @param dt [in] data type of the block - * @param spec [in] specification of the block + * @param [in] dt data type of the block + * @param [in] spec specification of the block * @return pointer to handler */ virtual AliHLTOUTHandler* GetOutputHandler( diff --git a/HLT/MUON/OfflineInterface/AliHLTMUONESDMaker.h b/HLT/MUON/OfflineInterface/AliHLTMUONESDMaker.h index 1f14c3f2d75..487239e9b1e 100644 --- a/HLT/MUON/OfflineInterface/AliHLTMUONESDMaker.h +++ b/HLT/MUON/OfflineInterface/AliHLTMUONESDMaker.h @@ -94,12 +94,12 @@ private: /** * Finds the trigger record with the specified ID in the list of trigger records * and then fills the ESD muon track structure with the information. - * [in] \param triggerRecords The list of trigger records to search in. - * [in] \param trigRecId The trigger record ID to seach for. - * [in] \param trackId The track ID of the track structure where the trigger + * \param [in] triggerRecords The list of trigger records to search in. + * \param [in] trigRecId The trigger record ID to seach for. + * \param [in] trackId The track ID of the track structure where the trigger * record ID comes from. - * [out] \param muTrack The track structure to fill. - * [in/out] \param nHits The number of hits added. Will increment this value + * \param [out] muTrack The track structure to fill. + * \param [in,out] nHits The number of hits added. Will increment this value * for every new hit added. */ void FillTriggerInfo( diff --git a/HLT/MUON/OnlineAnalysis/AliHLTMUONHitReconstructor.h b/HLT/MUON/OnlineAnalysis/AliHLTMUONHitReconstructor.h index 626092038b0..7aad952a38f 100644 --- a/HLT/MUON/OnlineAnalysis/AliHLTMUONHitReconstructor.h +++ b/HLT/MUON/OnlineAnalysis/AliHLTMUONHitReconstructor.h @@ -59,8 +59,8 @@ public: * Fills the output clusters array with the extra cluster information generated. * If the method GenerateClusterInfo(true) was not called, then no cluster information * is generated and this method will not do anything. - * [out] \param clusters This is the output array that will be filled. - * [in/out] \param nofClusters Initially this contains the maximum number of elements + * \param [out] clusters This is the output array that will be filled. + * \param [in,out] nofClusters Initially this contains the maximum number of elements * that can be stored in the clusters array. The method will fill this with * the actual number of elements stored. * \returns true if all elements were copied and false if there is not enough space in @@ -72,8 +72,8 @@ public: * Fills the output channels array with the extra channel information generated. * If the method GenerateChannelInfo(true) was not called, then no extra channel * information is generated and this method will not do anything. - * [out] \param channels This is the output array that will be filled. - * [in/out] \param nofChannels Initially this contains the maximum number of elements + * \param [out] channels This is the output array that will be filled. + * \param [in,out] nofChannels Initially this contains the maximum number of elements * that can be stored in the channels array. The method will fill this with * the actual number of elements stored. * \returns true if all elements were copied and false if there is not enough space in diff --git a/HLT/MUON/OnlineAnalysis/AliHLTMUONTriggerReconstructor.cxx b/HLT/MUON/OnlineAnalysis/AliHLTMUONTriggerReconstructor.cxx index fd95f186044..b29eac286ae 100644 --- a/HLT/MUON/OnlineAnalysis/AliHLTMUONTriggerReconstructor.cxx +++ b/HLT/MUON/OnlineAnalysis/AliHLTMUONTriggerReconstructor.cxx @@ -84,13 +84,13 @@ bool AliHLTMUONTriggerReconstructor::Run( ) { /// Runs the trigger reconstruction algorithm on the raw data. - /// [in] \param rawData Pointer to the raw data DDL payload. - /// [in] \param rawDataSize Size of the raw data DDL payload in bytes. - /// [in] \param scalarEvent Indicates if the raw data should contain + /// \param [in] rawData Pointer to the raw data DDL payload. + /// \param [in] rawDataSize Size of the raw data DDL payload in bytes. + /// \param [in] scalarEvent Indicates if the raw data should contain /// scalar data also. - /// [out] \param trigRecord Pointer to output buffer for reconstructed + /// \param [out] trigRecord Pointer to output buffer for reconstructed /// trigger records. - /// [in/out] \param nofTrigRec Initialy should indicate the number of + /// \param [in,out] nofTrigRec Initialy should indicate the number of /// elements that can be stored in the trigRecord array. It will /// contain the number of elements filled after this method has returned. /// \return true if raw data was decoded and false if there was a problem @@ -203,8 +203,8 @@ bool AliHLTMUONTriggerReconstructor::AliDecoderHandler::FindStripsOnMT1( { /// This method will find the X and Y strip positions on stations MT1 of the /// trigger system which were fired for the current L0 local trigger decision. - /// [out] \param xPos The X strip that was fired. - /// [out] \param yPos The Y strip that was fired. + /// \param [out] xPos The X strip that was fired. + /// \param [out] yPos The Y strip that was fired. /// \return true is returned if a strip was fired, otherwise a warning is /// generated and false is returned. /// \note Values for xPos and yPos are in the range [0..15]. @@ -413,9 +413,9 @@ void AliHLTMUONTriggerReconstructor::AliDecoderHandler::FindXStrips( ) { /// Finds the X strips that were fired in the local trigger structures. - /// [in] \param startPos The first X strip location to start looking from. - /// [in] \param strips The X strip patterns for chambers 11 to 14 to use. - /// [out] \param pos Array of X strip positions on chambers 11 to 14. pos[0] + /// \param [in] startPos The first X strip location to start looking from. + /// \param [in] strips The X strip patterns for chambers 11 to 14 to use. + /// \param [out] pos Array of X strip positions on chambers 11 to 14. pos[0] /// is for chamber 11, pos[1] for chamber 12 and so on. /// The elements of the array will contain -1 if no valid strip position /// was found for that chamber. @@ -545,9 +545,9 @@ void AliHLTMUONTriggerReconstructor::AliDecoderHandler::FindYStrips( ) { /// Finds the Y strips that were fired in the local trigger structures. - /// [in] \param startPos The first Y strip location to start looking from. - /// [in] \param strips Array of Y strip patterns to look in for chamber 11 to 14. - /// [out] \param pos Array of Y strip positions on chambers 11 to 14. pos[0] + /// \param [in] startPos The first Y strip location to start looking from. + /// \param [in] strips Array of Y strip patterns to look in for chamber 11 to 14. + /// \param [out] pos Array of Y strip positions on chambers 11 to 14. pos[0] /// is for chamber 11, pos[1] for chamber 12 and so on. /// The elements of the array will contain -1 if no valid strip position /// was found for that chamber. @@ -673,13 +673,13 @@ void AliHLTMUONTriggerReconstructor::AliDecoderHandler::ReconstructHit( { /// Reconstructs the hit coordinates for the given chamber from the /// strip and fired strip information provided. - /// [in] \param xStrips The X strip pattern for the given chamber. - /// [in] \param yStrips The Y strip pattern for the given chamber. - /// [in] \param xPos The position of the X strip that was fired. - /// [in] \param yPos The position of the Y strip that was fired. - /// [in] \param chamber The chamber on which the strips were found. + /// \param [in] xStrips The X strip pattern for the given chamber. + /// \param [in] yStrips The Y strip pattern for the given chamber. + /// \param [in] xPos The position of the X strip that was fired. + /// \param [in] yPos The position of the Y strip that was fired. + /// \param [in] chamber The chamber on which the strips were found. /// Valid range [0..3]. - /// [out] \param hit This will be filled with the reconstructed hit. + /// \param [out] hit This will be filled with the reconstructed hit. assert( 0 <= xPos and xPos < 48 ); assert( 0 <= yPos and yPos < 16 ); diff --git a/HLT/MUON/OnlineAnalysis/AliHLTMUONTriggerReconstructor.h b/HLT/MUON/OnlineAnalysis/AliHLTMUONTriggerReconstructor.h index 89cd4ea6e22..aa7a544999e 100644 --- a/HLT/MUON/OnlineAnalysis/AliHLTMUONTriggerReconstructor.h +++ b/HLT/MUON/OnlineAnalysis/AliHLTMUONTriggerReconstructor.h @@ -355,7 +355,7 @@ private: /** * Selects the correct X strip patterns to use in FindXStrips. - * [out] \param strips Resulting array of X strip patterns to use + * \param [out] strips Resulting array of X strip patterns to use * for chambers 11 to 14. */ void SelectXPatterns(AliHLTUInt64_t strips[4]); @@ -363,10 +363,10 @@ private: /** * Selects the correct Y strip patterns to use in FindYStrips and local IDs for * finding the correct row in the lookup table. - * [in] \param xpos Array of X strip positions generated by FindXStrips. + * \param [in] xpos Array of X strip positions generated by FindXStrips. * Values are in the range [0..47]. - * [out] \param strips Resulting array of Y strip patterns to use. - * [out] \param locId Resulting array of local IDs to use for the lookup table. + * \param [out] strips Resulting array of Y strip patterns to use. + * \param [out] locId Resulting array of local IDs to use for the lookup table. */ void SelectYPatterns(AliHLTInt32_t xpos[4], AliHLTUInt32_t strips[4], AliHLTUInt8_t locId[4]); diff --git a/HLT/MUON/macros/CreateCDBFieldIntegrals.C b/HLT/MUON/macros/CreateCDBFieldIntegrals.C index 2e3a5d74d54..2191fe9137d 100644 --- a/HLT/MUON/macros/CreateCDBFieldIntegrals.C +++ b/HLT/MUON/macros/CreateCDBFieldIntegrals.C @@ -56,11 +56,11 @@ using std::endl; /** * Calculates the average magnetic field integral for the dipole magnet given the * L3 solenoid current and dipole magnet current. - * [in] \param currentL3 The current in the L3 solenoid magnet. - * [in] \param currentDip The current in the dipole magnet. - * [out] \param result The magnetic field integral result. - * [in] \param sqrts The centre of mass energy for the beams. - * [in] \param beamtype The beam type as given the AliMagF, eg. p-p, A-A or none. + * \param [in] currentL3 The current in the L3 solenoid magnet. + * \param [in] currentDip The current in the dipole magnet. + * \param [out] result The magnetic field integral result. + * \param [in] sqrts The centre of mass energy for the beams. + * \param [in] beamtype The beam type as given the AliMagF, eg. p-p, A-A or none. * \note The sign of the current indicates the polarity setting for the magnet. * \returns true if the magnetic field was calculated successfully and false otherwise. */ diff --git a/HLT/MUON/utils/dHLTdumpraw.cxx b/HLT/MUON/utils/dHLTdumpraw.cxx index 6e5c3c5e63f..08596c8fc2d 100644 --- a/HLT/MUON/utils/dHLTdumpraw.cxx +++ b/HLT/MUON/utils/dHLTdumpraw.cxx @@ -2387,13 +2387,13 @@ int CheckIfDDLStream(const char* buffer, unsigned long bufferSize) /** * Parses the buffer and prints the contents to screen. - * [in] \param buffer The pointer to the buffer to parse. - * [in] \param bufferSize The size of the buffer in bytes. - * [in] \param continueParse If specified then the we try to continue parsing the + * \param [in] buffer The pointer to the buffer to parse. + * \param [in] bufferSize The size of the buffer in bytes. + * \param [in] continueParse If specified then the we try to continue parsing the * buffer as much as possible. - * [in] \param tryrecover Indicates if the DDL decoders should have special + * \param [in] tryrecover Indicates if the DDL decoders should have special * recovery logic enabled. - * [in/out] \param type Initialy this should indicate the type of the data block + * \param [in,out] type Initialy this should indicate the type of the data block * or kUnknownDataBlock if not known. On exit it will be filled with * the type of the data block as discovered by this routine if type * initially contained kUnknownDataBlock. @@ -2610,11 +2610,11 @@ namespace /** * Performs basic data integrity checks of the data block using the * AliHLTMUONDataCheckerComponent. - * [in] \param sys The HLT system framework. - * [in] \param filename The name of the file containing the data block to check. - * [in] \param type Must indicate the type of the data block. - * [in] \param dataspec The data specification of the data block. NULL if none. - * [in] \param maxLogging If set to true then full logging is turned on for AliHLTSystem. + * \param [in] sys The HLT system framework. + * \param [in] filename The name of the file containing the data block to check. + * \param [in] type Must indicate the type of the data block. + * \param [in] dataspec The data specification of the data block. NULL if none. + * \param [in] maxLogging If set to true then full logging is turned on for AliHLTSystem. * \returns The error code indicating the problem. EXIT_SUCCESS is returned * on success. */ -- 2.39.3