From 692de412b81f16738d28897496efdbb2e9e1ba0a Mon Sep 17 00:00:00 2001 From: ivana Date: Thu, 22 Sep 2005 11:12:40 +0000 Subject: [PATCH] - Modified comment lines to be compatible with Doxygen (brief class description, ingroup directive; member function comments in geometry classes) - Added Copyright, CVS Id where missing --- MUON/AliMUON.h | 4 + MUON/AliMUONChamber.h | 4 + MUON/AliMUONChamberTrigger.h | 4 + MUON/AliMUONClusterFinderAZ.h | 4 + MUON/AliMUONClusterFinderVS.h | 10 +- MUON/AliMUONClusterInput.h | 4 + MUON/AliMUONClusterReconstructor.h | 10 +- MUON/AliMUONCommonGeometryBuilder.cxx | 13 +- MUON/AliMUONCommonGeometryBuilder.h | 16 +- MUON/AliMUONConstants.h | 4 + MUON/AliMUONDDLTracker.h | 5 + MUON/AliMUONDDLTrigger.h | 5 + MUON/AliMUONData.h | 12 +- MUON/AliMUONDataInterface.h | 4 + MUON/AliMUONDigit.h | 4 + MUON/AliMUONDigitizer.h | 4 + MUON/AliMUONDigitizerv2.h | 7 + MUON/AliMUONDisplay.h | 4 + MUON/AliMUONFactoryV2.h | 10 +- MUON/AliMUONFactoryV3.h | 4 + MUON/AliMUONGeometryBuilder.cxx | 44 ++--- MUON/AliMUONGeometryBuilder.h | 12 +- MUON/AliMUONGeometryConstituent.cxx | 18 +- MUON/AliMUONGeometryConstituent.h | 10 +- MUON/AliMUONGeometryDEIndexing.cxx | 18 +- MUON/AliMUONGeometryDEIndexing.h | 32 ++-- MUON/AliMUONGeometryDetElement.cxx | 56 +++--- MUON/AliMUONGeometryDetElement.h | 14 +- MUON/AliMUONGeometryDirection.h | 11 +- MUON/AliMUONGeometryEnvelope.cxx | 60 +++--- MUON/AliMUONGeometryEnvelope.h | 14 +- MUON/AliMUONGeometryEnvelopeStore.cxx | 101 +++++----- MUON/AliMUONGeometryEnvelopeStore.h | 16 +- MUON/AliMUONGeometryModule.cxx | 104 ++++------- MUON/AliMUONGeometryModule.h | 17 +- MUON/AliMUONGeometrySVMap.cxx | 84 ++++----- MUON/AliMUONGeometrySVMap.h | 32 ++-- MUON/AliMUONGeometrySegmentation.cxx | 205 +++++++++------------ MUON/AliMUONGeometrySegmentation.h | 17 +- MUON/AliMUONGeometryStore.cxx | 29 +-- MUON/AliMUONGeometryStore.h | 18 +- MUON/AliMUONGlobalTrigger.h | 4 + MUON/AliMUONHit.h | 19 +- MUON/AliMUONHitForRec.h | 4 + MUON/AliMUONHitMapA1.h | 4 + MUON/AliMUONLoader.h | 20 +- MUON/AliMUONLocalTrigger.h | 4 + MUON/AliMUONMathieson.h | 4 + MUON/AliMUONPixel.h | 4 + MUON/AliMUONPoints.h | 4 + MUON/AliMUONRawCluster.h | 10 +- MUON/AliMUONRawData.h | 11 +- MUON/AliMUONRawStream.h | 8 +- MUON/AliMUONRecoCheck.h | 6 + MUON/AliMUONRecoTrack.h | 7 +- MUON/AliMUONReconstructor.h | 4 + MUON/AliMUONResponse.h | 4 + MUON/AliMUONResponseTrigger.h | 4 + MUON/AliMUONResponseTriggerV1.h | 4 + MUON/AliMUONResponseV0.h | 4 + MUON/AliMUONSDigitizerv1.h | 10 +- MUON/AliMUONScalerEventTrigger.h | 5 + MUON/AliMUONSegment.h | 10 +- MUON/AliMUONSegmentIndex.h | 4 + MUON/AliMUONSegmentManuIndex.h | 4 + MUON/AliMUONSegmentPosition.h | 6 +- MUON/AliMUONSegmentationDetectionElement.h | 4 + MUON/AliMUONSegmentationManager.h | 4 + MUON/AliMUONSlatGeometryBuilder.h | 12 +- MUON/AliMUONSt12QuadrantSegmentation.h | 4 + MUON/AliMUONSt1Decoder.h | 26 +-- MUON/AliMUONSt1ElectronicElement.h | 22 ++- MUON/AliMUONSt1GeometryBuilder.h | 16 +- MUON/AliMUONSt1IniReader.h | 26 +-- MUON/AliMUONSt1Response.h | 16 +- MUON/AliMUONSt1ResponseParameter.h | 18 +- MUON/AliMUONSt1ResponseRule.h | 18 +- MUON/AliMUONSt1SpecialMotif.h | 15 +- MUON/AliMUONSt2GeometryBuilder.h | 13 +- MUON/AliMUONSt2GeometryBuilderV2.h | 14 +- MUON/AliMUONSt345SlatSegmentation.h | 18 +- MUON/AliMUONSt345SlatSegmentationV2.h | 9 + MUON/AliMUONSubEventTracker.h | 5 + MUON/AliMUONSubEventTrigger.h | 5 + MUON/AliMUONTest.h | 10 +- MUON/AliMUONTrack.h | 11 +- MUON/AliMUONTrackHit.h | 10 +- MUON/AliMUONTrackK.h | 4 + MUON/AliMUONTrackParam.h | 10 +- MUON/AliMUONTrackReconstructor.h | 16 +- MUON/AliMUONTransientDigit.h | 4 + MUON/AliMUONTriggerCircuit.h | 6 +- MUON/AliMUONTriggerConstants.h | 4 + MUON/AliMUONTriggerDecision.h | 10 +- MUON/AliMUONTriggerGeometryBuilder.h | 12 +- MUON/AliMUONTriggerLut.h | 4 + MUON/AliMUONTriggerSegmentation.h | 6 +- MUON/AliMUONTriggerTrack.h | 10 +- MUON/AliMUONVGeometryBuilder.h | 12 +- MUON/AliMUONVGeometryDEIndexing.h | 18 +- MUON/AliMUONVGeometryDESegmentation.h | 19 +- MUON/AliMUONv1.h | 4 + 102 files changed, 917 insertions(+), 710 deletions(-) diff --git a/MUON/AliMUON.h b/MUON/AliMUON.h index de3695d433f..4e63afa4114 100644 --- a/MUON/AliMUON.h +++ b/MUON/AliMUON.h @@ -6,6 +6,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup base +/// \class AliMUON +/// \brief AliDetector Class for MUON subsystem + //////////////////////////////////////////////// // AliDetector Class for MUON subsystem // //////////////////////////////////////////////// diff --git a/MUON/AliMUONChamber.h b/MUON/AliMUONChamber.h index 22c1f14667e..f8a013fe1d9 100644 --- a/MUON/AliMUONChamber.h +++ b/MUON/AliMUONChamber.h @@ -5,6 +5,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +// +/// \ingroup base +/// \class AliMUONChamber +/// \brief MUON tracking chamber class #include #include diff --git a/MUON/AliMUONChamberTrigger.h b/MUON/AliMUONChamberTrigger.h index de4a5262c76..ac410c73ee1 100644 --- a/MUON/AliMUONChamberTrigger.h +++ b/MUON/AliMUONChamberTrigger.h @@ -6,6 +6,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +// +/// \ingroup base +/// \class AliMUONChamberTrigger +/// \brief Muon trigger chamber class #include "AliMUONChamber.h" diff --git a/MUON/AliMUONClusterFinderAZ.h b/MUON/AliMUONClusterFinderAZ.h index 5544ebc1e85..d046e1f8409 100644 --- a/MUON/AliMUONClusterFinderAZ.h +++ b/MUON/AliMUONClusterFinderAZ.h @@ -6,6 +6,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup rec +/// \class AliMUONClusterFinderAZ +/// \brief Cluster finder in MUON arm of ALICE + #include "AliMUONClusterFinderVS.h" class TH2F; diff --git a/MUON/AliMUONClusterFinderVS.h b/MUON/AliMUONClusterFinderVS.h index d3ccb5c3837..8dfe5021d01 100644 --- a/MUON/AliMUONClusterFinderVS.h +++ b/MUON/AliMUONClusterFinderVS.h @@ -6,9 +6,13 @@ /* $Id$ */ // Revision of includes 07/05/2004 -//////////////////////////////////////////////// -// MUON Cluster Finder Class // -//////////////////////////////////////////////// +/// \ingroup rec +/// \class AliMUONClusterFinderVS +/// \brief Class for clustering and reconstruction of space points +/// +///////////////////////////////////////////////// +/// MUON Cluster Finder Class // +///////////////////////////////////////////////// #include diff --git a/MUON/AliMUONClusterInput.h b/MUON/AliMUONClusterInput.h index 97d443cb318..970f48c864b 100644 --- a/MUON/AliMUONClusterInput.h +++ b/MUON/AliMUONClusterInput.h @@ -6,6 +6,10 @@ /* $Id $*/ // Revision of includes 07/05/2004 +/// \ingroup rec +/// \class AliMUONClusterInput +/// \brief Global data service for hit reconstruction + #include #include // needed for inline function Digit #include "AliMUONGeometrySegmentation.h" diff --git a/MUON/AliMUONClusterReconstructor.h b/MUON/AliMUONClusterReconstructor.h index 812859c478f..087c85f12d5 100644 --- a/MUON/AliMUONClusterReconstructor.h +++ b/MUON/AliMUONClusterReconstructor.h @@ -6,9 +6,13 @@ /*$Id$*/ // Revision of includes 07/05/2004 -//////////////////////////////////// -// MUON event reconstructor in ALICE -//////////////////////////////////// +/// \ingroup rec +/// \class AliMUONClusterReconstructor +/// \brief MUON cluster reconstructor in ALICE +/// +///////////////////////////////////// +/// MUON event reconstructor in ALICE +///////////////////////////////////// #include #include "AliMUONClusterFinderVS.h" //AZ diff --git a/MUON/AliMUONCommonGeometryBuilder.cxx b/MUON/AliMUONCommonGeometryBuilder.cxx index cc43617751c..76ceb152882 100644 --- a/MUON/AliMUONCommonGeometryBuilder.cxx +++ b/MUON/AliMUONCommonGeometryBuilder.cxx @@ -37,7 +37,7 @@ AliMUONCommonGeometryBuilder::AliMUONCommonGeometryBuilder(AliMUON* muon) : AliMUONVGeometryBuilder("", 0), fMUON(muon) { -// Standars constructor +/// Standars constructor } //______________________________________________________________________________//___________________________________________ @@ -45,7 +45,7 @@ AliMUONCommonGeometryBuilder::AliMUONCommonGeometryBuilder() : AliMUONVGeometryBuilder(), fMUON(0) { -// Default constructor +/// Default constructor } //______________________________________________________________________________ @@ -53,7 +53,7 @@ AliMUONCommonGeometryBuilder::AliMUONCommonGeometryBuilder( const AliMUONCommonGeometryBuilder& right) : AliMUONVGeometryBuilder(right) { - // copy constructor (not implemented) + /// copy constructor (not implemented) AliFatal("Copy constructor not provided."); } @@ -61,14 +61,14 @@ AliMUONCommonGeometryBuilder::AliMUONCommonGeometryBuilder( //______________________________________________________________________________ AliMUONCommonGeometryBuilder::~AliMUONCommonGeometryBuilder() { -// Destructor +/// Destructor } //______________________________________________________________________________ AliMUONCommonGeometryBuilder& AliMUONCommonGeometryBuilder::operator=(const AliMUONCommonGeometryBuilder& right) { - // assignement operator (not implemented) + /// assignement operator (not implemented) // check assignement to self if (this == &right) return *this; @@ -85,8 +85,7 @@ AliMUONCommonGeometryBuilder::operator=(const AliMUONCommonGeometryBuilder& righ //_____________________________________________________________________________ void AliMUONCommonGeometryBuilder::CreateMaterials() { - // Definition of common materials - // -- +/// Definition of common materials // // Ar-CO2 gas (80%+20%) diff --git a/MUON/AliMUONCommonGeometryBuilder.h b/MUON/AliMUONCommonGeometryBuilder.h index 44e439e1e81..55bf37fef1f 100644 --- a/MUON/AliMUONCommonGeometryBuilder.h +++ b/MUON/AliMUONCommonGeometryBuilder.h @@ -2,12 +2,14 @@ * See cxx source for full Copyright notice */ // $Id$ -// -// Class AliMUONCommonGeometryBuilder -// ---------------------------------- -// Geometry construction common to all stations -// (material definition). -// separated from AliMUONGeometryBuilder + +/// \ingroup base +/// \class AliMUONCommonGeometryBuilder +/// \brief Class to build common materials +/// +/// Geometry construction common to all stations +/// (material definition). +/// separated from AliMUONGeometryBuilder #ifndef ALI_MUON_COMMON_GEOMETRY_BUILDER_H #define ALI_MUON_COMMON_GEOMETRY_BUILDER_H @@ -35,7 +37,7 @@ class AliMUONCommonGeometryBuilder : public AliMUONVGeometryBuilder private: // data members - AliMUON* fMUON; // MUON detector + AliMUON* fMUON; // Class to build common materials ClassDef(AliMUONCommonGeometryBuilder,1) // Common MUON geometry definitions }; diff --git a/MUON/AliMUONConstants.h b/MUON/AliMUONConstants.h index 65ef0522e30..53e30d177fe 100644 --- a/MUON/AliMUONConstants.h +++ b/MUON/AliMUONConstants.h @@ -5,6 +5,10 @@ /* $Id$*/ // Revision of includes 07/05/2004 +// +/// \ingroup base +/// \class AliMUONConstants +/// \brief MUON global constants #include diff --git a/MUON/AliMUONDDLTracker.h b/MUON/AliMUONDDLTracker.h index d768d349ea9..2d8114925e1 100644 --- a/MUON/AliMUONDDLTracker.h +++ b/MUON/AliMUONDDLTracker.h @@ -3,6 +3,11 @@ /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. * * See cxx source for full Copyright notice */ +/*$Id$*/ + +/// \ingroup rec +/// \class AliMUONDDLTracker +/// \brief MUON DDL tracker #include #include "AliRawDataHeader.h" diff --git a/MUON/AliMUONDDLTrigger.h b/MUON/AliMUONDDLTrigger.h index 52f370f9a06..907b239a457 100644 --- a/MUON/AliMUONDDLTrigger.h +++ b/MUON/AliMUONDDLTrigger.h @@ -3,6 +3,11 @@ /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. * * See cxx source for full Copyright notice */ +/*$Id$*/ + +/// \ingroup rec +/// \class AliMUONDDLTrigger +/// \brief MUON DDL Trigger #include #include "AliRawDataHeader.h" diff --git a/MUON/AliMUONData.h b/MUON/AliMUONData.h index 350c0c7d828..d7af64582b2 100644 --- a/MUON/AliMUONData.h +++ b/MUON/AliMUONData.h @@ -6,11 +6,15 @@ /* $Id$ */ // Revision of includes 07/05/2004 - -// AliMUONData -// Class containing MUON data: hits, digits, rawclusters, globaltrigger, localtrigger, etc ... -// Gines Martinez, Subatech, September 2003 // +/// \ingroup base +/// \class AliMUONData +/// \brief MUON data +/// +/// Class containing MUON data: hits, digits, rawclusters, globaltrigger, +/// localtrigger, etc ... +/// +/// Author: Gines Martinez, Subatech, September 2003 #include #include diff --git a/MUON/AliMUONDataInterface.h b/MUON/AliMUONDataInterface.h index 0768793b926..76c926d8426 100644 --- a/MUON/AliMUONDataInterface.h +++ b/MUON/AliMUONDataInterface.h @@ -5,6 +5,10 @@ /* $Id$ */ // Includes revised 07/05/2004 +// +/// \ingroup base +/// \class AliMUONDataInterface +/// \brief An easy to use interface to data in the MUON module // Author: Artur Szostak // email: artur@alice.phy.uct.ac.za diff --git a/MUON/AliMUONDigit.h b/MUON/AliMUONDigit.h index bdf75392f85..e8af975c2c3 100644 --- a/MUON/AliMUONDigit.h +++ b/MUON/AliMUONDigit.h @@ -6,6 +6,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup base +/// \class AliMUONDigit +/// \brief MUON digit + #include static const Int_t kMAXTRACKS=10; diff --git a/MUON/AliMUONDigitizer.h b/MUON/AliMUONDigitizer.h index 6f17812881a..7ba024332f8 100644 --- a/MUON/AliMUONDigitizer.h +++ b/MUON/AliMUONDigitizer.h @@ -6,6 +6,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup sim +/// \class AliMUONDigitizer +/// \brief Class for MUON merging/digitization + #include "AliDigitizer.h" #include "AliMUONDigit.h" diff --git a/MUON/AliMUONDigitizerv2.h b/MUON/AliMUONDigitizerv2.h index 1a5d1d5aed0..ef1ad9b09dd 100644 --- a/MUON/AliMUONDigitizerv2.h +++ b/MUON/AliMUONDigitizerv2.h @@ -6,6 +6,13 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup sim +/// \class AliMUONDigitizerv2 +/// \brief Class produces Digits from SDigits. +/// +/// Do the Digitization (Digit) from summable Digits (SDigit) +/// Allow the merging of signal file with background file(s). + #include "AliMUONDigitizer.h" #include "AliMUONDigit.h" diff --git a/MUON/AliMUONDisplay.h b/MUON/AliMUONDisplay.h index aa0db661e63..7d70669d3b5 100644 --- a/MUON/AliMUONDisplay.h +++ b/MUON/AliMUONDisplay.h @@ -7,6 +7,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup base +/// \class AliMUONDisplay +/// \brief Utility class to display MUON events + ////////////////////////////////////////////////////////////////////////// // // // AliDisplay // diff --git a/MUON/AliMUONFactoryV2.h b/MUON/AliMUONFactoryV2.h index 9da6437441b..a7e5dc88741 100644 --- a/MUON/AliMUONFactoryV2.h +++ b/MUON/AliMUONFactoryV2.h @@ -6,10 +6,14 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup sim +/// \class AliMUONFactoryV2 +/// \brief Factory for muon chambers, segmentations and response +/// //////////////////////////////////////////////////////////// -// Factory for muon chambers, segmentations and response -// The number 2 is refering to new segmentation -// +/// Factory for muon chambers, segmentations and response +/// The number 2 is refering to new segmentation +/// //////////////////////////////////////////////////////////// #include diff --git a/MUON/AliMUONFactoryV3.h b/MUON/AliMUONFactoryV3.h index 8adefbcbe1c..22bd8b354c4 100644 --- a/MUON/AliMUONFactoryV3.h +++ b/MUON/AliMUONFactoryV3.h @@ -5,6 +5,10 @@ /* $Id$ */ +/// \ingroup sim +/// \class AliMUONFactoryV3 +/// \brief Factory for muon chambers, segmentations and response +/// //////////////////////////////////////////////////////////// // Factory for muon chambers, segmentations and response //////////////////////////////////////////////////////////// diff --git a/MUON/AliMUONGeometryBuilder.cxx b/MUON/AliMUONGeometryBuilder.cxx index 2cfd668a431..35f773db51e 100644 --- a/MUON/AliMUONGeometryBuilder.cxx +++ b/MUON/AliMUONGeometryBuilder.cxx @@ -47,7 +47,7 @@ AliMUONGeometryBuilder::AliMUONGeometryBuilder(AliModule* module) fGlobalTransformation(), fGeometryBuilders(0) { -// Standard constructor +/// Standard constructor fGeometryBuilders = new TObjArray(100); } @@ -60,14 +60,14 @@ AliMUONGeometryBuilder::AliMUONGeometryBuilder() fGlobalTransformation(), fGeometryBuilders(0) { -// Default constructor +/// Default constructor } //______________________________________________________________________________ AliMUONGeometryBuilder::AliMUONGeometryBuilder(const AliMUONGeometryBuilder& right) : TObject(right) { - // copy constructor (not implemented) +/// Copy constructor (not implemented) AliFatal("Copy constructor not provided."); } @@ -75,7 +75,7 @@ AliMUONGeometryBuilder::AliMUONGeometryBuilder(const AliMUONGeometryBuilder& rig //______________________________________________________________________________ AliMUONGeometryBuilder::~AliMUONGeometryBuilder() { -// Destructor +/// Destructor if (fGeometryBuilders){ fGeometryBuilders->Delete(); delete fGeometryBuilders; @@ -86,7 +86,7 @@ AliMUONGeometryBuilder::~AliMUONGeometryBuilder() AliMUONGeometryBuilder& AliMUONGeometryBuilder::operator=(const AliMUONGeometryBuilder& right) { - // assignement operator (not implemented) +/// Assignement operator (not implemented) // check assignement to self if (this == &right) return *this; @@ -105,8 +105,7 @@ void AliMUONGeometryBuilder::PlaceVolume(const TString& name, const TString& mNa Int_t copyNo, const TGeoHMatrix& matrix, Int_t npar, Double_t* param, const char* only) const { -// Place the volume specified by name with the given transformation matrix -// --- +/// Place the volume specified by name with the given transformation matrix // Do not apply global transformation // if mother volume was already placed in @@ -170,9 +169,8 @@ void AliMUONGeometryBuilder::PlaceVolume(const TString& name, const TString& mNa void AliMUONGeometryBuilder::FillGlobalTransformations( AliMUONVGeometryBuilder* builder) { -// Compute and set global transformations to detection elements -// for each chamber geometry -// --- +/// Compute and set global transformations to detection elements +/// for each chamber geometry for (Int_t j=0; jNofGeometries(); j++) { @@ -215,8 +213,7 @@ void AliMUONGeometryBuilder::FillGlobalTransformations( //_____________________________________________________________________________ void AliMUONGeometryBuilder::AddBuilder(AliMUONVGeometryBuilder* geomBuilder) { -// Adds the geometry builder to the list -// --- +/// Adds the geometry builder to the list fGeometryBuilders->Add(geomBuilder); } @@ -224,9 +221,7 @@ void AliMUONGeometryBuilder::AddBuilder(AliMUONVGeometryBuilder* geomBuilder) //______________________________________________________________________________ void AliMUONGeometryBuilder::CreateGeometry() { -// -// Construct geometry using geometry builders. -// +/// Construct geometry using geometry builders. for (Int_t i=0; iGetEntriesFast(); i++) { @@ -350,9 +345,7 @@ void AliMUONGeometryBuilder::CreateGeometry() //_____________________________________________________________________________ void AliMUONGeometryBuilder::CreateMaterials() { -// -// Construct materials specific to modules via builders -// +/// Construct materials specific to modules via builders for (Int_t i=0; iGetEntriesFast(); i++) { @@ -368,8 +361,7 @@ void AliMUONGeometryBuilder::CreateMaterials() //______________________________________________________________________________ void AliMUONGeometryBuilder::InitGeometry() { - // Initialize geometry - // --- +/// Initialize geometry // Set the chamber (sensitive region) GEANT identifier // @@ -401,8 +393,7 @@ void AliMUONGeometryBuilder::InitGeometry() //______________________________________________________________________________ void AliMUONGeometryBuilder::WriteTransformations() { - // Writes transformations into files per builder - // --- +/// Writes transformations into files per builder for (Int_t i=0; iGetEntriesFast(); i++) { @@ -418,8 +409,7 @@ void AliMUONGeometryBuilder::WriteTransformations() //______________________________________________________________________________ void AliMUONGeometryBuilder::WriteSVMaps(Bool_t rebuild) { - // Writes sensitive volume maps into files per builder - // --- +/// Writes sensitive volume maps into files per builder for (Int_t i=0; iGetEntriesFast(); i++) { @@ -436,8 +426,7 @@ void AliMUONGeometryBuilder::WriteSVMaps(Bool_t rebuild) void AliMUONGeometryBuilder::SetGlobalTransformation( const TGeoCombiTrans& transform) { -// Sets the global transformation -// --- +/// Sets the global transformation fGlobalTransformation = transform; } @@ -445,8 +434,7 @@ void AliMUONGeometryBuilder::SetGlobalTransformation( //_____________________________________________________________________________ void AliMUONGeometryBuilder::SetAlign(Bool_t align) { -// Sets the option for alignement -// --- +/// Sets the option for alignement fAlign = align; diff --git a/MUON/AliMUONGeometryBuilder.h b/MUON/AliMUONGeometryBuilder.h index c27774fb896..476356103c4 100644 --- a/MUON/AliMUONGeometryBuilder.h +++ b/MUON/AliMUONGeometryBuilder.h @@ -2,12 +2,12 @@ * See cxx source for full Copyright notice */ // $Id$ -// -// Class AliMUONGeometryBuilder -// ---------------------------- -// Manager class for geometry construction via geometry builders. -// -// Author: Ivana Hrivnacova, IPN Orsay + +/// \ingroup geometry +/// \class AliMUONGeometryBuilder +/// \brief Manager class for geometry construction via geometry builders. +/// +/// Author: Ivana Hrivnacova, IPN Orsay #ifndef ALI_MUON_GEOMETRY_BUILDER_H #define ALI_MUON_GEOMETRY_BUILDER_H diff --git a/MUON/AliMUONGeometryConstituent.cxx b/MUON/AliMUONGeometryConstituent.cxx index 241a4abf846..88ef8c537e5 100644 --- a/MUON/AliMUONGeometryConstituent.cxx +++ b/MUON/AliMUONGeometryConstituent.cxx @@ -36,6 +36,8 @@ AliMUONGeometryConstituent::AliMUONGeometryConstituent(const TString& name, fNpar(npar), fParam(0) { +/// Standard constructor for a constituent without translation & rotation + // fTransformation = new TGeoCombiTrans(name); // would be nice to be so simple @@ -59,6 +61,8 @@ AliMUONGeometryConstituent::AliMUONGeometryConstituent(const TString& name, fParam(0), fTransformation(0) { +/// Standard constructor for a constituent with translation + // Create the constituent transformation fTransformation = new TGeoCombiTrans(translation, TGeoRotation()); @@ -82,6 +86,8 @@ AliMUONGeometryConstituent::AliMUONGeometryConstituent(const TString& name, fParam(0), fTransformation(0) { +/// Standard constructor for a constituent with translation and rotation + // Create the constituent transformation fTransformation = new TGeoCombiTrans(translation, rotation); @@ -104,6 +110,9 @@ AliMUONGeometryConstituent::AliMUONGeometryConstituent(const TString& name, fParam(0), fTransformation(0) { +/// Standard constructor for a constituent with translation and rotation +/// defined via TGeoCombiTrans + // Create the constituent transformation fTransformation = new TGeoCombiTrans(transform); @@ -122,7 +131,7 @@ AliMUONGeometryConstituent::AliMUONGeometryConstituent() fParam(0), fTransformation(0) { -// Default constructor +/// Default constructor } @@ -131,13 +140,16 @@ AliMUONGeometryConstituent::AliMUONGeometryConstituent( const AliMUONGeometryConstituent& rhs) : TNamed(rhs) { +/// Protected copy constructor + AliFatal("Copy constructor is not implemented."); } //______________________________________________________________________________ AliMUONGeometryConstituent::~AliMUONGeometryConstituent() { -// +/// Destructor + delete fTransformation; delete [] fParam; } @@ -146,6 +158,8 @@ AliMUONGeometryConstituent::~AliMUONGeometryConstituent() AliMUONGeometryConstituent& AliMUONGeometryConstituent::operator = (const AliMUONGeometryConstituent& rhs) { +/// Protected assignment operator + // check assignement to self if (this == &rhs) return *this; diff --git a/MUON/AliMUONGeometryConstituent.h b/MUON/AliMUONGeometryConstituent.h index f7b9f9a61d3..72c77ce2bbe 100644 --- a/MUON/AliMUONGeometryConstituent.h +++ b/MUON/AliMUONGeometryConstituent.h @@ -4,11 +4,11 @@ // $Id$ // Revision of includes 07/05/2004 // -// Class AliMUONGeometryConstituent -// -------------------------------- -// Helper class for definititon of an assembly of volumes. -// -// Author: Ivana Hrivnacova, IPN Orsay +/// \ingroup geometry +/// \class AliMUONGeometryConstituent +/// \brief Helper class for definititon of an assembly of volumes. +/// +/// Author: Ivana Hrivnacova, IPN Orsay #ifndef ALI_MUON_GEOMETRY_CONSTITUENT_H #define ALI_MUON_GEOMETRY_CONSTITUENT_H diff --git a/MUON/AliMUONGeometryDEIndexing.cxx b/MUON/AliMUONGeometryDEIndexing.cxx index dd4caa79624..4a8563b2e52 100644 --- a/MUON/AliMUONGeometryDEIndexing.cxx +++ b/MUON/AliMUONGeometryDEIndexing.cxx @@ -44,7 +44,7 @@ AliMUONGeometryDEIndexing::AliMUONGeometryDEIndexing( fModuleId(moduleId), fNofDetElements(nofDetElements) { -// Standard constructor +/// Standard constructor } //______________________________________________________________________________ @@ -53,12 +53,13 @@ AliMUONGeometryDEIndexing::AliMUONGeometryDEIndexing() fModuleId(0), fNofDetElements(0) { -// Ddefault constructor +/// Default constructor } //______________________________________________________________________________ -AliMUONGeometryDEIndexing::~AliMUONGeometryDEIndexing() { -// +AliMUONGeometryDEIndexing::~AliMUONGeometryDEIndexing() +{ +/// Destructor } // @@ -68,8 +69,7 @@ AliMUONGeometryDEIndexing::~AliMUONGeometryDEIndexing() { //______________________________________________________________________________ Int_t AliMUONGeometryDEIndexing::GetFirstDetElemId() const { -// Get first detection element Id for chamber specified by moduleId -// --- +/// Get first detection element Id for chamber specified by moduleId return (fModuleId+1)*100; } @@ -81,8 +81,7 @@ Int_t AliMUONGeometryDEIndexing::GetFirstDetElemId() const //______________________________________________________________________________ Int_t AliMUONGeometryDEIndexing::GetDetElementIndex(Int_t detElemId) const { -// Returns the index of detector element specified by detElemId -// --- +/// Returns the index of detector element specified by detElemId if ( fNofDetElements == 0 ) { AliFatal("The number of detection elements has not been set."); @@ -99,8 +98,7 @@ Int_t AliMUONGeometryDEIndexing::GetDetElementIndex(Int_t detElemId) const //______________________________________________________________________________ Int_t AliMUONGeometryDEIndexing::GetDetElementId(Int_t detElemIndex) const { -// Returns the ID of detector element specified by index -// --- +/// Returns the ID of detector element specified by index if ( fNofDetElements == 0 ) { AliFatal("The number of detection elements has not been set."); diff --git a/MUON/AliMUONGeometryDEIndexing.h b/MUON/AliMUONGeometryDEIndexing.h index 80b227b6b58..d088faad765 100644 --- a/MUON/AliMUONGeometryDEIndexing.h +++ b/MUON/AliMUONGeometryDEIndexing.h @@ -2,20 +2,22 @@ * See cxx source for full Copyright notice */ // $Id$ -// -// Class AliMUONGeometryDEIndexing -// ------------------------------- -// The class that provides conversion between the detection element Id -// and the index in the array. -// Used in storing DE transformations and segmentations. -// The detection elements numbering: -// DetElemId = chamberId*100 + [50] + detElemNum -// where chamberId = 1, 2, ..., 14 -// detElemNum = 0, 1, ... -// The number 50 is added to distinguish detector elements -// in the left and the right hemispheres. -// -// Author: Ivana Hrivnacova, IPN Orsay + +/// \ingroup base +/// \class AliMUONGeometryDEIndexing +/// \brief Conversion between the detection element Id and the array index +/// +/// The class that provides conversion between the detection element Id +/// and the index in the array. +/// Used in storing DE transformations and segmentations. +/// The detection elements numbering: +/// DetElemId = chamberId*100 + [50] + detElemNum +/// where chamberId = 1, 2, ..., 14 +/// detElemNum = 0, 1, ... +/// The number 50 is added to distinguish detector elements +/// in the left and the right hemispheres. +/// +/// Author: Ivana Hrivnacova, IPN Orsay #ifndef ALI_MUON_GEOMETRY_DE_INDEXING_H #define ALI_MUON_GEOMETRY_DE_INDEXING_H @@ -48,7 +50,7 @@ class AliMUONGeometryDEIndexing : public AliMUONVGeometryDEIndexing Int_t fModuleId; // module Id Int_t fNofDetElements; // number of detection elements in the module - ClassDef(AliMUONGeometryDEIndexing,1) // MUON transformations store + ClassDef(AliMUONGeometryDEIndexing,1) // Conversion between the DE Id and the array index }; // inline functions diff --git a/MUON/AliMUONGeometryDetElement.cxx b/MUON/AliMUONGeometryDetElement.cxx index c72e2cfd024..1ad1313ea78 100644 --- a/MUON/AliMUONGeometryDetElement.cxx +++ b/MUON/AliMUONGeometryDetElement.cxx @@ -40,7 +40,7 @@ AliMUONGeometryDetElement::AliMUONGeometryDetElement( fLocalTransformation(0), fGlobalTransformation(0) { -// Standard constructor +/// Standard constructor SetUniqueID(detElemId); fLocalTransformation = new TGeoCombiTrans(relTransform); @@ -53,7 +53,7 @@ AliMUONGeometryDetElement::AliMUONGeometryDetElement() fLocalTransformation(0), fGlobalTransformation(0) { -// Default constructor +/// Default constructor } //______________________________________________________________________________ @@ -61,12 +61,16 @@ AliMUONGeometryDetElement::AliMUONGeometryDetElement( const AliMUONGeometryDetElement& rhs) : TObject(rhs) { +/// Protected copy constructor + AliFatal("Copy constructor is not implemented."); } //______________________________________________________________________________ -AliMUONGeometryDetElement::~AliMUONGeometryDetElement() { -// +AliMUONGeometryDetElement::~AliMUONGeometryDetElement() +{ +/// Destructor + delete fLocalTransformation; delete fGlobalTransformation; } @@ -75,6 +79,8 @@ AliMUONGeometryDetElement::~AliMUONGeometryDetElement() { AliMUONGeometryDetElement& AliMUONGeometryDetElement::operator = (const AliMUONGeometryDetElement& rhs) { +/// Protected assignement operator + // check assignement to self if (this == &rhs) return *this; @@ -91,8 +97,7 @@ AliMUONGeometryDetElement::operator = (const AliMUONGeometryDetElement& rhs) void AliMUONGeometryDetElement::PrintTransform( const TGeoCombiTrans* transform) const { -// Prints the detection element transformation -// --- +/// Prints the detection element transformation cout << "DetElemId: " << GetUniqueID(); cout << " name: " << fAlignedVolume << endl; @@ -138,10 +143,9 @@ void AliMUONGeometryDetElement::Global2Local( Float_t xg, Float_t yg, Float_t zg, Float_t& xl, Float_t& yl, Float_t& zl) const { -// Transforms point from the global reference frame (ALIC) -// to the local reference frame of the detection element specified -// by detElemId. -// --- +/// Transforms point from the global reference frame (ALIC) +/// to the local reference frame of the detection element specified +/// by detElemId. Double_t dxg = xg; Double_t dyg = yg; @@ -160,10 +164,9 @@ void AliMUONGeometryDetElement::Global2Local( Double_t xg, Double_t yg, Double_t zg, Double_t& xl, Double_t& yl, Double_t& zl) const { -// Transforms point from the global reference frame (ALIC) -// to the local reference frame of the detection element specified -// by detElemId. -// --- +/// Transforms point from the global reference frame (ALIC) +/// to the local reference frame of the detection element specified +/// by detElemId. // Check transformation if (!fGlobalTransformation) { @@ -188,9 +191,8 @@ void AliMUONGeometryDetElement::Local2Global( Float_t xl, Float_t yl, Float_t zl, Float_t& xg, Float_t& yg, Float_t& zg) const { -// Transforms point from the local reference frame of the detection element -// specified by detElemId to the global reference frame (ALIC). -// --- +/// Transforms point from the local reference frame of the detection element +/// specified by detElemId to the global reference frame (ALIC). Double_t dxl = xl; Double_t dyl = yl; @@ -209,9 +211,8 @@ void AliMUONGeometryDetElement::Local2Global( Double_t xl, Double_t yl, Double_t zl, Double_t& xg, Double_t& yg, Double_t& zg) const { -// Transforms point from the local reference frame of the detection element -// specified by detElemId to the global reference frame (ALIC). -// --- +/// Transforms point from the local reference frame of the detection element +/// specified by detElemId to the global reference frame (ALIC). // Check transformation if (!fGlobalTransformation) { @@ -235,9 +236,8 @@ void AliMUONGeometryDetElement::Local2Global( void AliMUONGeometryDetElement::SetGlobalTransformation( const TGeoCombiTrans& transform) { -// Sets global transformation; -// gives warning if the global transformation is already defined. -// --- +/// Sets global transformation; +/// gives warning if the global transformation is already defined. if (fGlobalTransformation) { delete fGlobalTransformation; @@ -250,9 +250,8 @@ void AliMUONGeometryDetElement::SetGlobalTransformation( //______________________________________________________________________________ void AliMUONGeometryDetElement::PrintLocalTransform() const { -// Prints detection element relative transformation -// (the transformation wrt module frame) -// +/// Prints detection element relative transformation +/// (the transformation wrt module frame) PrintTransform(fLocalTransformation); } @@ -260,9 +259,8 @@ void AliMUONGeometryDetElement::PrintLocalTransform() const //______________________________________________________________________________ void AliMUONGeometryDetElement::PrintGlobalTransform() const { -// Prints detection element global transformation -// (the transformation wrt global frame) -// +/// Prints detection element global transformation +/// (the transformation wrt global frame) PrintTransform(fLocalTransformation); } diff --git a/MUON/AliMUONGeometryDetElement.h b/MUON/AliMUONGeometryDetElement.h index 0272f9d63e3..6c0ab428ff1 100644 --- a/MUON/AliMUONGeometryDetElement.h +++ b/MUON/AliMUONGeometryDetElement.h @@ -2,12 +2,14 @@ * See cxx source for full Copyright notice */ // $Id$ -// -// Class AliMUONGeometryDetElement -// -------------------------------- -// The class defines the detection element. -// -// Author: Ivana Hrivnacova, IPN Orsay + +/// \ingroup geometry +/// \class AliMUONGeometryDetElement +/// \brief Detection element +/// +/// The class defines the detection element. +/// +/// Author: Ivana Hrivnacova, IPN Orsay #ifndef ALI_MUON_GEOMETRY_DET_ELEMENT_H #define ALI_MUON_GEOMETRY_DET_ELEMENT_H diff --git a/MUON/AliMUONGeometryDirection.h b/MUON/AliMUONGeometryDirection.h index 91f495ef1ec..fdb3cdcc2b5 100644 --- a/MUON/AliMUONGeometryDirection.h +++ b/MUON/AliMUONGeometryDirection.h @@ -3,12 +3,11 @@ /* $Id$ */ -// -// Enum AliMUONGeometryDirection -// ----------------------------- -// Enumeration for the directions in a plane. -// -// Author:Ivana Hrivnacova, IPN Orsay +/// \ingroup geometry +/// \enum AliMUONGeometryDirection +/// \brief Enumeration for the directions in a plane. +/// +/// Author:Ivana Hrivnacova, IPN Orsay #ifndef ALI_MUON_GEOMETRY_DIRECTION_H #define ALI_MUON_GEOMETRY_DIRECTION_H diff --git a/MUON/AliMUONGeometryEnvelope.cxx b/MUON/AliMUONGeometryEnvelope.cxx index 10201526846..f92f689815c 100644 --- a/MUON/AliMUONGeometryEnvelope.cxx +++ b/MUON/AliMUONGeometryEnvelope.cxx @@ -43,7 +43,7 @@ AliMUONGeometryEnvelope::AliMUONGeometryEnvelope(const TString& name, fTransformation(0), fConstituents(0) { -// Standard constructor +/// Standard constructor if (TString(only) == TString("MANY")) fIsMANY = true; @@ -68,7 +68,8 @@ AliMUONGeometryEnvelope::AliMUONGeometryEnvelope(const TString& name, fTransformation(0), fConstituents(0) { -// Standard constructor +/// Standard constructor for a non virtual enevelope with a specified copy +/// number if (TString(only) == TString("MANY")) fIsMANY = true; @@ -90,7 +91,7 @@ AliMUONGeometryEnvelope::AliMUONGeometryEnvelope() fTransformation(0), fConstituents(0) { -// Default constructor +/// Default constructor } @@ -99,13 +100,16 @@ AliMUONGeometryEnvelope::AliMUONGeometryEnvelope( const AliMUONGeometryEnvelope& rhs) : TNamed(rhs) { +/// Protected copy constructor + AliFatal("Copy constructor is not implemented."); } //______________________________________________________________________________ AliMUONGeometryEnvelope::~AliMUONGeometryEnvelope() { -// +/// Destructor + // Add deleting rotation matrices delete fTransformation; @@ -120,6 +124,8 @@ AliMUONGeometryEnvelope::~AliMUONGeometryEnvelope() AliMUONGeometryEnvelope& AliMUONGeometryEnvelope::operator = (const AliMUONGeometryEnvelope& rhs) { +/// Protected assignement operator + // check assignement to self if (this == &rhs) return *this; @@ -135,9 +141,8 @@ AliMUONGeometryEnvelope::operator = (const AliMUONGeometryEnvelope& rhs) //______________________________________________________________________________ void AliMUONGeometryEnvelope::AddConstituent(const TString& name, Int_t copyNo) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. fConstituents->Add(new AliMUONGeometryConstituent(name, copyNo, 0, 0)); } @@ -146,9 +151,8 @@ void AliMUONGeometryEnvelope::AddConstituent(const TString& name, Int_t copyNo) void AliMUONGeometryEnvelope::AddConstituent(const TString& name, Int_t copyNo, const TGeoTranslation& translation) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. fConstituents ->Add(new AliMUONGeometryConstituent(name, copyNo, translation, 0, 0)); @@ -159,9 +163,8 @@ void AliMUONGeometryEnvelope::AddConstituent(const TString& name, Int_t copyNo, const TGeoTranslation& translation, const TGeoRotation& rotation) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. fConstituents ->Add(new AliMUONGeometryConstituent( @@ -172,9 +175,8 @@ void AliMUONGeometryEnvelope::AddConstituent(const TString& name, Int_t copyNo, void AliMUONGeometryEnvelope::AddConstituent(const TString& name, Int_t copyNo, const TGeoCombiTrans& transform ) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. fConstituents ->Add(new AliMUONGeometryConstituent( @@ -185,9 +187,8 @@ void AliMUONGeometryEnvelope::AddConstituent(const TString& name, Int_t copyNo, void AliMUONGeometryEnvelope::AddConstituentParam(const TString& name, Int_t copyNo, Int_t npar, Double_t* param) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. fConstituents ->Add(new AliMUONGeometryConstituent(name, copyNo, npar, param)); @@ -198,9 +199,8 @@ void AliMUONGeometryEnvelope::AddConstituentParam(const TString& name, Int_t copyNo, const TGeoTranslation& translation, Int_t npar, Double_t* param) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. fConstituents ->Add(new AliMUONGeometryConstituent( @@ -213,9 +213,8 @@ void AliMUONGeometryEnvelope::AddConstituentParam(const TString& name, const TGeoRotation& rotation, Int_t npar, Double_t* param) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. fConstituents ->Add(new AliMUONGeometryConstituent( @@ -228,9 +227,8 @@ void AliMUONGeometryEnvelope::AddConstituentParam(const TString& name, const TGeoCombiTrans& transform, Int_t npar, Double_t* param) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. fConstituents ->Add(new AliMUONGeometryConstituent( @@ -240,8 +238,7 @@ void AliMUONGeometryEnvelope::AddConstituentParam(const TString& name, //______________________________________________________________________________ void AliMUONGeometryEnvelope::SetTranslation(const TGeoTranslation& translation) { -// Sets the envelope position -// --- +/// Set the envelope position fTransformation ->SetTranslation(const_cast(translation.GetTranslation())); @@ -250,8 +247,7 @@ void AliMUONGeometryEnvelope::SetTranslation(const TGeoTranslation& translation //______________________________________________________________________________ void AliMUONGeometryEnvelope::SetRotation(const TGeoRotation& rotation) { -// Sets the enevlope rotation -// --- +/// Set the enevlope rotation TGeoRotation* rot = new TGeoRotation(); rot->SetMatrix(const_cast(rotation.GetRotationMatrix())); diff --git a/MUON/AliMUONGeometryEnvelope.h b/MUON/AliMUONGeometryEnvelope.h index 7258c3b8d9e..fea08d334ea 100644 --- a/MUON/AliMUONGeometryEnvelope.h +++ b/MUON/AliMUONGeometryEnvelope.h @@ -3,12 +3,14 @@ // $Id$ // Revision of includes 07/05/2004 -// -// Class AliMUONGeometryEnvelope -// ----------------------------- -// Helper class for definititon an assembly of volumes. -// -// Author: Ivana Hrivnacova, IPN Orsay + +/// \ingroup geometry +/// \class AliMUONGeometryEnvelope +/// \brief Geometry envelope helper class +/// +/// Helper class for definititon of an assembly of volumes. +/// +/// Author: Ivana Hrivnacova, IPN Orsay #ifndef ALI_MUON_GEOMETRY_ENVELOPE_H #define ALI_MUON_GEOMETRY_ENVELOPE_H diff --git a/MUON/AliMUONGeometryEnvelopeStore.cxx b/MUON/AliMUONGeometryEnvelopeStore.cxx index 1f7daac8d00..63664707e2e 100644 --- a/MUON/AliMUONGeometryEnvelopeStore.cxx +++ b/MUON/AliMUONGeometryEnvelopeStore.cxx @@ -46,7 +46,7 @@ AliMUONGeometryEnvelopeStore::AliMUONGeometryEnvelopeStore( fDebug(false), fAlign(false) { -// Standard constructor +/// Standard constructor fEnvelopes = new TObjArray(100); } @@ -60,7 +60,7 @@ AliMUONGeometryEnvelopeStore::AliMUONGeometryEnvelopeStore() fDebug(false), fAlign(false) { -// Default constructor +/// Default constructor } @@ -74,7 +74,7 @@ AliMUONGeometryEnvelopeStore::AliMUONGeometryEnvelopeStore(const AliMUONGeometry //______________________________________________________________________________ AliMUONGeometryEnvelopeStore::~AliMUONGeometryEnvelopeStore() { -// +/// Destructor // Add deleting rotation matrices @@ -88,6 +88,8 @@ AliMUONGeometryEnvelopeStore::~AliMUONGeometryEnvelopeStore() AliMUONGeometryEnvelopeStore& AliMUONGeometryEnvelopeStore::operator = (const AliMUONGeometryEnvelopeStore& rhs) { +/// Protected assignement operator + // check assignement to self if (this == &rhs) return *this; @@ -104,8 +106,7 @@ AliMUONGeometryEnvelopeStore::operator = (const AliMUONGeometryEnvelopeStore& rh AliMUONGeometryEnvelope* AliMUONGeometryEnvelopeStore::FindEnvelope(const TString& name) const { -// Finds the envelope specified by name. -// --- +/// Find the envelope specified by name. for (Int_t i=0; iGetEntriesFast(); i++) { AliMUONGeometryEnvelope* envelope @@ -121,10 +122,9 @@ AliMUONGeometryEnvelopeStore::FindEnvelope(const TString& name) const Bool_t AliMUONGeometryEnvelopeStore::AlignEnvelope( AliMUONGeometryEnvelope* envelope) const { -// Find transformation by the detection element Id (if not 0) -// (= unique ID of enevelope) and set it to the envelope. -// Return true if transformation is applied, false otherwise. -// --- +/// Find transformation by the detection element Id (if not 0) +/// (= unique ID of enevelope) and set it to the envelope. +/// Return true if transformation is applied, false otherwise. Int_t detElemId = envelope->GetUniqueID(); if (detElemId == 0) return false; @@ -150,9 +150,8 @@ void AliMUONGeometryEnvelopeStore::AddEnvelope(const TString& name, Bool_t isVirtual, const char* only) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. if (!isVirtual) AliDebug(1,Form("Adding non-virtual envelope %s id %d",name.Data(),id)); // else AliDebug(1,Form("Adding virtual envelope %s id %d",name.Data(),id)); @@ -172,9 +171,8 @@ void AliMUONGeometryEnvelopeStore::AddEnvelope(const TString& name, const TGeoTranslation& translation, const char* only) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. if (fDebug) { cout << "... Adding "; @@ -204,9 +202,8 @@ void AliMUONGeometryEnvelopeStore::AddEnvelope(const TString& name, const TGeoRotation& rotation, const char* only) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. if (fDebug) { cout << "... Adding "; @@ -251,9 +248,8 @@ void AliMUONGeometryEnvelopeStore::AddEnvelope(const TString& name, const TGeoCombiTrans& transform, const char* only) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. if (fDebug) { cout << "... Adding "; @@ -284,9 +280,8 @@ void AliMUONGeometryEnvelopeStore::AddEnvelope(const TString& name, Int_t copyNo, const char* only) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. if (fDebug) { cout << "... Adding " @@ -310,9 +305,8 @@ void AliMUONGeometryEnvelopeStore::AddEnvelope(const TString& name, const TGeoTranslation& translation, const char* only) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. if (fDebug) { cout << "... Adding " @@ -342,9 +336,8 @@ void AliMUONGeometryEnvelopeStore::AddEnvelope(const TString& name, const TGeoRotation& rotation, const char* only) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. if (fDebug) { cout << "... Adding " @@ -378,9 +371,8 @@ void AliMUONGeometryEnvelopeStore::AddEnvelope(const TString& name, const TGeoCombiTrans& transform, const char* only) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. if (fDebug) { cout << "... Adding " @@ -409,9 +401,8 @@ void AliMUONGeometryEnvelopeStore::AddEnvelope(const TString& name, void AliMUONGeometryEnvelopeStore::AddEnvelopeConstituent(const TString& name, const TString& envName, Int_t copyNo) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. if (fDebug) { cout << "... Adding constituent " << name @@ -434,9 +425,8 @@ void AliMUONGeometryEnvelopeStore::AddEnvelopeConstituent(const TString& name, const TString& envName, Int_t copyNo, const TGeoTranslation& translation) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. if (fDebug) { cout << "... Adding constituent " << name @@ -461,9 +451,8 @@ void AliMUONGeometryEnvelopeStore::AddEnvelopeConstituent(const TString& name, const TGeoTranslation& translation, const TGeoRotation& rotation) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. if (fDebug) { cout << "... Adding constituent " << name @@ -487,9 +476,8 @@ void AliMUONGeometryEnvelopeStore::AddEnvelopeConstituent(const TString& name, const TString& envName, Int_t copyNo, const TGeoCombiTrans& transform) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. if (fDebug) { cout << "... Adding constituent " << name @@ -513,9 +501,8 @@ void AliMUONGeometryEnvelopeStore::AddEnvelopeConstituentParam(const TString& n const TString& envName, Int_t copyNo, Int_t npar, Double_t* param) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. if (fDebug) { cout << "... Adding parameterised constituent " << name @@ -539,9 +526,8 @@ void AliMUONGeometryEnvelopeStore::AddEnvelopeConstituentParam(const TString& n const TGeoTranslation& translation, Int_t npar, Double_t* param) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. if (fDebug) { cout << "... Adding parameterised constituent " << name @@ -567,9 +553,8 @@ void AliMUONGeometryEnvelopeStore::AddEnvelopeConstituentParam(const TString& n const TGeoRotation& rotation, Int_t npar, Double_t* param) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. if (fDebug) { cout << "... Adding parameterised constituent " << name @@ -594,9 +579,8 @@ void AliMUONGeometryEnvelopeStore::AddEnvelopeConstituentParam(const TString& n const TGeoCombiTrans& transform, Int_t npar, Double_t* param) { -// Adds the volume with the specified name and transformation -// to the list of envelopes. -// --- +/// Add the volume with the specified name and transformation +/// to the list of envelopes. if (fDebug) { cout << "... Adding parameterised constituent " << name @@ -618,8 +602,7 @@ void AliMUONGeometryEnvelopeStore::AddEnvelopeConstituentParam(const TString& n //______________________________________________________________________________ Int_t AliMUONGeometryEnvelopeStore::GetNofDetElements() const { -// Returns the number od envelopes with detElemId>0. -// --- +/// Return the number od envelopes with detElemId>0. Int_t nofDetElems = 0; diff --git a/MUON/AliMUONGeometryEnvelopeStore.h b/MUON/AliMUONGeometryEnvelopeStore.h index a60574559df..15ae23f4af4 100644 --- a/MUON/AliMUONGeometryEnvelopeStore.h +++ b/MUON/AliMUONGeometryEnvelopeStore.h @@ -2,13 +2,15 @@ * See cxx source for full Copyright notice */ // $Id$ -// -// Class AliMUONGeometryEnvelopeStore -// ---------------------------------- -// Class for definititon of the temporary volume envelopes -// used in geometry construction -// -// Author: Ivana Hrivnacova, IPN Orsay + +/// \ingroup geometry +/// \class AliMUONGeometryEnvelopeStore +/// \brief Store for temporary volumes envelopes +/// +/// Class for definititon of the temporary volume envelopes +/// used in geometry construction +/// +/// Author: Ivana Hrivnacova, IPN Orsay #ifndef ALI_MUON_GEOMETRY_ENVELOPE_STORE_H #define ALI_MUON_GEOMETRY_ENVELOPE_STORE_H diff --git a/MUON/AliMUONGeometryModule.cxx b/MUON/AliMUONGeometryModule.cxx index 1ce97cadab0..3f8fa951631 100644 --- a/MUON/AliMUONGeometryModule.cxx +++ b/MUON/AliMUONGeometryModule.cxx @@ -56,7 +56,7 @@ AliMUONGeometryModule::AliMUONGeometryModule(Int_t moduleId) fDetElements(0), fSVMap(0) { -// Standard constructor +/// Standard constructor // Chamber transformation fTransformation = new TGeoCombiTrans(""); @@ -93,7 +93,7 @@ AliMUONGeometryModule::AliMUONGeometryModule() fDetElements(0), fSVMap(0) { -// Default constructor +/// Default constructor } @@ -101,12 +101,15 @@ AliMUONGeometryModule::AliMUONGeometryModule() AliMUONGeometryModule::AliMUONGeometryModule(const AliMUONGeometryModule& rhs) : TObject(rhs) { +/// Protected copy constructor + AliFatal("Copy constructor is not implemented."); } //______________________________________________________________________________ -AliMUONGeometryModule::~AliMUONGeometryModule() { -// +AliMUONGeometryModule::~AliMUONGeometryModule() +{ +/// Destructor delete fTransformation; delete fSVVolumeIds; @@ -120,6 +123,8 @@ AliMUONGeometryModule::~AliMUONGeometryModule() { AliMUONGeometryModule& AliMUONGeometryModule::operator = (const AliMUONGeometryModule& rhs) { +/// Protected assignement operator + // check assignement to self if (this == &rhs) return *this; @@ -135,9 +140,9 @@ AliMUONGeometryModule::operator = (const AliMUONGeometryModule& rhs) //______________________________________________________________________________ Int_t AliMUONGeometryModule::GetSVIndex(Int_t svVolId) const { -// Returns the index of the volume specified by volId -// if it is present in the list of sensitive volumes -// (or -1 if not present). +/// Return the index of the volume specified by volId +/// if it is present in the list of sensitive volumes +/// (or -1 if not present). for (Int_t i=0; iAt(i) == svVolId) return i; @@ -154,10 +159,9 @@ void AliMUONGeometryModule::Global2Local(Int_t detElemId, Float_t xg, Float_t yg, Float_t zg, Float_t& xl, Float_t& yl, Float_t& zl) const { -// Transforms point from the global reference frame (ALIC) -// to the local reference frame of the detection element specified -// by detElemId. -// --- +/// Transform point from the global reference frame (ALIC) +/// to the local reference frame of the detection element specified +/// by detElemId. // Get detection element AliMUONGeometryDetElement* detElement = GetDetElement(detElemId); @@ -172,10 +176,9 @@ void AliMUONGeometryModule::Global2Local(Int_t detElemId, Double_t xg, Double_t yg, Double_t zg, Double_t& xl, Double_t& yl, Double_t& zl) const { -// Transforms point from the global reference frame (ALIC) -// to the local reference frame of the detection element specified -// by detElemId. -// --- +/// Transform point from the global reference frame (ALIC) +/// to the local reference frame of the detection element specified +/// by detElemId. // Get detection element AliMUONGeometryDetElement* detElement = GetDetElement(detElemId); @@ -190,9 +193,8 @@ void AliMUONGeometryModule::Local2Global(Int_t detElemId, Float_t xl, Float_t yl, Float_t zl, Float_t& xg, Float_t& yg, Float_t& zg) const { -// Transforms point from the local reference frame of the detection element -// specified by detElemId to the global reference frame (ALIC). -// --- +/// Transform point from the local reference frame of the detection element +/// specified by detElemId to the global reference frame (ALIC). // Get detection element AliMUONGeometryDetElement* detElement = GetDetElement(detElemId); @@ -207,9 +209,8 @@ void AliMUONGeometryModule::Local2Global(Int_t detElemId, Double_t xl, Double_t yl, Double_t zl, Double_t& xg, Double_t& yg, Double_t& zg) const { -// Transforms point from the local reference frame of the detection element -// specified by detElemId to the global reference frame (ALIC). -// --- +/// Transform point from the local reference frame of the detection element +/// specified by detElemId to the global reference frame (ALIC). // Get detection element AliMUONGeometryDetElement* detElement = GetDetElement(detElemId); @@ -222,8 +223,8 @@ void AliMUONGeometryModule::Local2Global(Int_t detElemId, //______________________________________________________________________________ void AliMUONGeometryModule::SetVolume(const TString& volumeName) { -// Sets the concrete volume associated with this module. -// The module in not virtual in this case +/// Set the concrete volume associated with this module. +/// The module in not virtual in this case fVolume = volumeName; fIsVirtual = false; @@ -232,8 +233,7 @@ void AliMUONGeometryModule::SetVolume(const TString& volumeName) //______________________________________________________________________________ void AliMUONGeometryModule::SetTranslation(const TGeoTranslation& translation) { -// Sets the module position wrt world. -// --- +/// Set the module position wrt world. fTransformation ->SetTranslation(const_cast(translation.GetTranslation())); @@ -242,8 +242,7 @@ void AliMUONGeometryModule::SetTranslation(const TGeoTranslation& translation) //______________________________________________________________________________ void AliMUONGeometryModule::SetRotation(const TGeoRotation& rotation) { -// Sets the module rotation wrt ALIC. -// --- +/// Set the module rotation wrt ALIC. TGeoRotation* rot = new TGeoRotation(); rot->SetMatrix(const_cast(rotation.GetRotationMatrix())); @@ -254,9 +253,8 @@ void AliMUONGeometryModule::SetRotation(const TGeoRotation& rotation) //______________________________________________________________________________ void AliMUONGeometryModule::SetSensitiveVolume(Int_t svVolId) { -// Adds the volume specified by volId to the list of sensitive -// volumes -// --- +/// Add the volume specified by volId to the list of sensitive +/// volumes // Resize TArrayI if needed if (fSVVolumeIds->GetSize() == fNofSVs) fSVVolumeIds->Set(2*fNofSVs); @@ -267,9 +265,8 @@ void AliMUONGeometryModule::SetSensitiveVolume(Int_t svVolId) //______________________________________________________________________________ void AliMUONGeometryModule::SetSensitiveVolume(const TString& volName) { -// Adds the volume specified by volName to the list of sensitive -// volumes -// --- +/// Add the volume specified by volName to the list of sensitive +/// volumes SetSensitiveVolume(gMC->VolId(volName)); } @@ -277,8 +274,7 @@ void AliMUONGeometryModule::SetSensitiveVolume(const TString& volName) //______________________________________________________________________________ void AliMUONGeometryModule::SetAlign(Bool_t align) { -// Sets alignement option to enevelope store. -// --- +/// Set alignement option to enevelope store. fEnvelopes->SetAlign(align); } @@ -287,8 +283,7 @@ void AliMUONGeometryModule::SetAlign(Bool_t align) AliMUONGeometryDetElement* AliMUONGeometryModule::FindBySensitiveVolume(const TString& sensVolume) const { -// Finds TGeoCombiTrans for the detector element Id specified by aligned volume -// --- +/// Find TGeoCombiTrans for the detector element Id specified by aligned volume Int_t detElemId = fSVMap->GetDetElemId(sensVolume); @@ -301,9 +296,8 @@ AliMUONGeometryModule::FindBySensitiveVolume(const TString& sensVolume) const //______________________________________________________________________________ Bool_t AliMUONGeometryModule::IsSensitiveVolume(Int_t volId) const { -// Checks if the volume specified by volId is present in the list -// of sensitive volumes. -// --- +/// Check if the volume specified by volId is present in the list +/// of sensitive volumes. for (Int_t i=0; iAt(i) == volId) return kTRUE; @@ -314,9 +308,8 @@ Bool_t AliMUONGeometryModule::IsSensitiveVolume(Int_t volId) const //______________________________________________________________________________ Bool_t AliMUONGeometryModule::IsSensitiveVolume(const TString& volName) const { -// Checks if the volume specified by volName is present in the list -// of sensitive volumes. -// --- +/// Check if the volume specified by volName is present in the list +/// of sensitive volumes. return IsSensitiveVolume(gMC->VolId(volName)); } @@ -325,9 +318,8 @@ Bool_t AliMUONGeometryModule::IsSensitiveVolume(const TString& volName) const AliMUONGeometryDetElement* AliMUONGeometryModule::GetDetElement(Int_t detElemId) const { -// Returns thethe detection element specified by detElemId. -// Gives error if detection element is not defined. -// --- +/// Return the detection element specified by detElemId. +/// Give error if detection element is not defined. // Get detection element AliMUONGeometryDetElement* detElement @@ -342,23 +334,3 @@ AliMUONGeometryModule::GetDetElement(Int_t detElemId) const return detElement; } - -/* -//______________________________________________________________________________ -Int_t AliMUONGeometryModule::GetNofDetElements() const -{ -// Returns the number of detection elements -// --- - - return fDEIndexing->GetNofDetElements(); -} - -//______________________________________________________________________________ -Int_t AliMUONGeometryModule::GetDetElemId(Int_t i) const -{ -// Returns the i-th detection element id -// --- - - return fDEIndexing->GetDetElementId(i); -} -*/ diff --git a/MUON/AliMUONGeometryModule.h b/MUON/AliMUONGeometryModule.h index 5dda9805bf6..f0997cefa4e 100644 --- a/MUON/AliMUONGeometryModule.h +++ b/MUON/AliMUONGeometryModule.h @@ -4,14 +4,15 @@ /* $Id$ */ // Revision of includes 07/05/2004 -// -// Class AliMUONGeometryModule -// ----------------------------- -// Class for definition of the detector module parameters -// (the transformations of detection elements, mapping between -// sensitive volumes and detection elements). -// -// Author: Ivana Hrivnacova, IPN Orsay +/// \ingroup geometry +/// \class AliMUONGeometryModule +/// \brief Geometry parameters for detector module +/// +/// Class for definition of the detector module parameters +/// (the transformations of detection elements, mapping between +/// sensitive volumes and detection elements). +/// +/// Author: Ivana Hrivnacova, IPN Orsay #ifndef ALI_MUON_MODULE_GEOMETRY_H #define ALI_MUON_MODULE_GEOMETRY_H diff --git a/MUON/AliMUONGeometrySVMap.cxx b/MUON/AliMUONGeometrySVMap.cxx index 2149e886f97..d7881ac357a 100644 --- a/MUON/AliMUONGeometrySVMap.cxx +++ b/MUON/AliMUONGeometrySVMap.cxx @@ -50,7 +50,7 @@ AliMUONStringIntMap::AliMUONStringIntMap() fFirstArray(100), fSecondArray(100) { -// Standard constructor +/// Standard constructor fFirstArray.SetOwner(true); } @@ -59,13 +59,25 @@ AliMUONStringIntMap::AliMUONStringIntMap() AliMUONStringIntMap::AliMUONStringIntMap(const AliMUONStringIntMap& rhs) : TObject(rhs) { +/// Protected copy constructor + AliFatal("Copy constructor is not implemented."); } +//______________________________________________________________________________ +AliMUONStringIntMap::~AliMUONStringIntMap() +{ +/// Destructor + + fFirstArray.Delete(); +} + //______________________________________________________________________________ AliMUONStringIntMap& AliMUONStringIntMap::operator = (const AliMUONStringIntMap& rhs) { +/// Protected assignement operator + // check assignement to self if (this == &rhs) return *this; @@ -74,20 +86,15 @@ AliMUONStringIntMap::operator = (const AliMUONStringIntMap& rhs) return *this; } -//______________________________________________________________________________ -AliMUONStringIntMap::~AliMUONStringIntMap() -{ -// Destructor - - fFirstArray.Delete(); -} +// +// public methods +// //______________________________________________________________________________ Bool_t AliMUONStringIntMap::Add(const TString& first, Int_t second) { -// Add map element if first not yet present -// --- +/// Add map element if first not yet present Int_t second2 = Get(first); if ( second2 > 0 ) { @@ -108,8 +115,7 @@ Bool_t AliMUONStringIntMap::Add(const TString& first, Int_t second) //______________________________________________________________________________ Int_t AliMUONStringIntMap::Get(const TString& first) const { -// Find the element with specified key (first) -// --- +/// Find the element with specified key (first) for (Int_t i=0; iGetString() == first ) @@ -122,8 +128,7 @@ Int_t AliMUONStringIntMap::Get(const TString& first) const //______________________________________________________________________________ Int_t AliMUONStringIntMap::GetNofItems() const { -// Returns the number of elements -// --- +/// Return the number of elements return fNofItems; } @@ -131,8 +136,7 @@ Int_t AliMUONStringIntMap::GetNofItems() const //______________________________________________________________________________ void AliMUONStringIntMap::Clear(Option_t* /*option*/) { -// Deletes the elements -// --- +/// Delete the elements fNofItems = 0; fFirstArray.Delete(); @@ -142,7 +146,7 @@ void AliMUONStringIntMap::Clear(Option_t* /*option*/) //______________________________________________________________________________ void AliMUONStringIntMap::Print(const char* /*option*/) const { -// Prints the map elements +/// Print the map elements for (Int_t i=0; iGetDEIndexing(), false); @@ -64,7 +64,7 @@ AliMUONGeometrySegmentation::AliMUONGeometrySegmentation() fGeometryModule(0), fDESegmentations(0) { -// Default Constructor +/// Default Constructor } //______________________________________________________________________________ @@ -72,13 +72,15 @@ AliMUONGeometrySegmentation::AliMUONGeometrySegmentation( const AliMUONGeometrySegmentation& rhs) : TObject(rhs) { -// Copy constructor +/// Protected copy constructor + AliFatal("Copy constructor is not implemented."); } //______________________________________________________________________________ -AliMUONGeometrySegmentation::~AliMUONGeometrySegmentation() { -// Destructor +AliMUONGeometrySegmentation::~AliMUONGeometrySegmentation() +{ +/// Destructor delete fDESegmentations; } @@ -91,7 +93,7 @@ AliMUONGeometrySegmentation::~AliMUONGeometrySegmentation() { AliMUONGeometrySegmentation& AliMUONGeometrySegmentation::operator=(const AliMUONGeometrySegmentation& rhs) { -// Copy operator +/// Protected assignment operator // check assignement to self if (this == &rhs) return *this; @@ -108,10 +110,9 @@ AliMUONGeometrySegmentation::operator=(const AliMUONGeometrySegmentation& rhs) //______________________________________________________________________________ Bool_t AliMUONGeometrySegmentation::OwnNotify(Int_t detElemId) const { -// Updates current detection element and segmentation, -// and checks if they exist. -// Returns true if success. -// --- +/// Update current detection element and segmentation, +/// and checks if they exist. +/// Return true if success. if (detElemId != fCurrentDetElemId) { @@ -147,8 +148,7 @@ Bool_t AliMUONGeometrySegmentation::OwnNotify(Int_t detElemId) const void AliMUONGeometrySegmentation::Add(Int_t detElemId, AliMUONVGeometryDESegmentation* segmentation) { -// Add detection element segmentation -// --- +/// Add detection element segmentation fDESegmentations->Add(detElemId, segmentation); } @@ -158,7 +158,7 @@ void AliMUONGeometrySegmentation::Add(Int_t detElemId, const AliMUONVGeometryDESegmentation* AliMUONGeometrySegmentation::GetDESegmentation(Int_t detElemId) const { -// Return the DE segmentation +/// Return the DE segmentation if (!OwnNotify(detElemId)) return 0; @@ -169,8 +169,8 @@ AliMUONGeometrySegmentation::GetDESegmentation(Int_t detElemId) const AliMUONGeometryDirection AliMUONGeometrySegmentation::GetDirection(Int_t detElemId) const { -// Return direction with a constant pad size -// (Direction or coordinate where the resolution is the best) +/// Return direction with a constant pad size +/// (Direction or coordinate where the resolution is the best) if (!OwnNotify(detElemId)) return kDirUndefined; @@ -192,8 +192,7 @@ void AliMUONGeometrySegmentation::Print(Option_t* opt) const //______________________________________________________________________________ void AliMUONGeometrySegmentation::SetPadSize(Float_t p1, Float_t p2) { -// Set pad size Dx*Dy to all detection element segmentations -// --- +/// Set pad size Dx*Dy to all detection element segmentations for (Int_t i=0; iGetNofEntries(); i++) { AliMUONVGeometryDESegmentation* segmentation @@ -205,8 +204,7 @@ void AliMUONGeometrySegmentation::SetPadSize(Float_t p1, Float_t p2) //______________________________________________________________________________ void AliMUONGeometrySegmentation::SetDAnod(Float_t d) { -// Set anod pitch to all detection element segmentations -// --- +/// Set anod pitch to all detection element segmentations for (Int_t i=0; iGetNofEntries(); i++) { AliMUONVGeometryDESegmentation* segmentation @@ -218,11 +216,10 @@ void AliMUONGeometrySegmentation::SetDAnod(Float_t d) //______________________________________________________________________________ Float_t AliMUONGeometrySegmentation::GetAnod(Int_t detElemId, Float_t xhit) const { -// Anod wire coordinate closest to xhit -// Returns for a hit position xhit the position of the nearest anode wire -// !!! xhit is understand a a distance, not as a position in the space -// CHECK -// --- +/// Anod wire coordinate closest to xhit +/// Returns for a hit position xhit the position of the nearest anode wire +/// !!! xhit is understand a a distance, not as a position in the space +/// CHECK if (!OwnNotify(detElemId)) return 0; @@ -234,8 +231,7 @@ Bool_t AliMUONGeometrySegmentation::GetPadI(Int_t detElemId, Float_t xg, Float_t yg, Float_t zg, Int_t& ix, Int_t& iy) { -// Returns pad coordinates (ix,iy) for given real coordinates (x,y) -// --- +/// Return pad coordinates (ix,iy) for given real coordinates (x,y) if (!OwnNotify(detElemId)) return false; @@ -264,8 +260,7 @@ Bool_t AliMUONGeometrySegmentation::GetPadC(Int_t detElemId, Int_t ix, Int_t iy, Float_t& xg, Float_t& yg, Float_t& zg) { -// Transform from pad to real coordinates -// --- +/// Transform from pad to real coordinates if (!OwnNotify(detElemId)) return false; @@ -283,8 +278,7 @@ Bool_t AliMUONGeometrySegmentation::GetPadE(Int_t detElemId, Int_t &ix, Int_t &iy, AliMUONSegmentManuIndex* connect) { -// Get pads for a given electronic connection -// --- +/// Get pads for a given electronic connection if (!OwnNotify(detElemId)) return false; @@ -298,8 +292,7 @@ Bool_t AliMUONGeometrySegmentation::GetPadE(Int_t detElemId, AliMUONSegmentManuIndex* AliMUONGeometrySegmentation:: GetMpConnection(Int_t detElemId, Int_t ix, Int_t iy) { -// Get electronic connection for given pads -// --- +/// Get electronic connection for given pads if (!OwnNotify(detElemId)) return 0x0; @@ -331,9 +324,8 @@ AliMUONSegmentManuIndex* AliMUONGeometrySegmentation:: GetMpConnection(Int_t det //______________________________________________________________________________ void AliMUONGeometrySegmentation::Init(Int_t chamber) { -// Initialize segmentation. -// Check that all detection elements have segmanetation set -// --- +/// Initialize segmentation. +/// Check that all detection elements have segmanetation set // Loop over detection elements AliMUONGeometryStore* detElements = fGeometryModule->GetDetElementStore(); @@ -358,8 +350,7 @@ void AliMUONGeometrySegmentation::Init(Int_t chamber) //______________________________________________________________________________ Float_t AliMUONGeometrySegmentation::Dpx(Int_t detElemId) const { -// Get pad size in x -// --- +/// Get pad size in x if (!OwnNotify(detElemId)) return 0.; @@ -369,8 +360,7 @@ Float_t AliMUONGeometrySegmentation::Dpx(Int_t detElemId) const //______________________________________________________________________________ Float_t AliMUONGeometrySegmentation::Dpy(Int_t detElemId) const { -// Get pad size in y -// --- +/// Get pad size in y if (!OwnNotify(detElemId)) return 0.; @@ -380,8 +370,7 @@ Float_t AliMUONGeometrySegmentation::Dpy(Int_t detElemId) const //______________________________________________________________________________ Float_t AliMUONGeometrySegmentation::Dpx(Int_t detElemId, Int_t isector) const { -// Pad size in x by sector -// --- +/// Pad size in x by sector if (!OwnNotify(detElemId)) return 0.; @@ -391,8 +380,7 @@ Float_t AliMUONGeometrySegmentation::Dpx(Int_t detElemId, Int_t isector) const //______________________________________________________________________________ Float_t AliMUONGeometrySegmentation::Dpy(Int_t detElemId, Int_t isector) const { -// Pad size in x, y by Sector -// --- +/// Pad size in x, y by Sector if (!OwnNotify(detElemId)) return 0.; @@ -402,8 +390,7 @@ Float_t AliMUONGeometrySegmentation::Dpy(Int_t detElemId, Int_t isector) const //______________________________________________________________________________ Int_t AliMUONGeometrySegmentation::Npx(Int_t detElemId) const { -// Maximum number of Pads in x -// --- +/// Maximum number of Pads in x if (!OwnNotify(detElemId)) return 0; @@ -413,8 +400,7 @@ Int_t AliMUONGeometrySegmentation::Npx(Int_t detElemId) const //______________________________________________________________________________ Int_t AliMUONGeometrySegmentation::Npy(Int_t detElemId) const { -// Maximum number of Pads in y -// --- +/// Maximum number of Pads in y if (!OwnNotify(detElemId)) return 0; @@ -424,11 +410,10 @@ Int_t AliMUONGeometrySegmentation::Npy(Int_t detElemId) const //______________________________________________________________________________ void AliMUONGeometrySegmentation::SetPad(Int_t detElemId, Int_t ix, Int_t iy) { -// Set pad position. -// Sets virtual pad coordinates, needed for evaluating pad response -// outside the tracking program. -// From AliMUONGeometrySegmentationV01. -// --- +/// Set pad position. +/// Sets virtual pad coordinates, needed for evaluating pad response +/// outside the tracking program. +/// From AliMUONGeometrySegmentationV01. if (!OwnNotify(detElemId)) return; @@ -439,10 +424,10 @@ void AliMUONGeometrySegmentation::SetPad(Int_t detElemId, Int_t ix, Int_t iy) void AliMUONGeometrySegmentation::SetHit(Int_t detElemId, Float_t xghit, Float_t yghit, Float_t zghit) { -// Set hit position -// Sets virtual hit position, needed for evaluating pad response -// outside the tracking program -// From AliMUONGeometrySegmentationV01. +/// Set hit position +/// Sets virtual hit position, needed for evaluating pad response +/// outside the tracking program +/// From AliMUONGeometrySegmentationV01. if (!OwnNotify(detElemId)) return; @@ -457,8 +442,7 @@ void AliMUONGeometrySegmentation::FirstPad(Int_t detElemId, Float_t xghit, Float_t yghit, Float_t zghit, Float_t dx, Float_t dy) { -// Iterate over pads - initialiser -// --- +/// Iterate over pads - initialiser if (!OwnNotify(detElemId)) return; @@ -471,8 +455,7 @@ void AliMUONGeometrySegmentation::FirstPad(Int_t detElemId, //______________________________________________________________________________ void AliMUONGeometrySegmentation::NextPad(Int_t detElemId) { -// Iterate over pads - stepper -// --- +/// Iterate over pads - stepper if (!OwnNotify(detElemId)) return; @@ -482,8 +465,7 @@ void AliMUONGeometrySegmentation::NextPad(Int_t detElemId) //______________________________________________________________________________ Int_t AliMUONGeometrySegmentation::MorePads(Int_t detElemId) { -// Iterate over pads - condition -// --- +/// Iterate over pads - condition if (!OwnNotify(detElemId)) return 0; @@ -496,9 +478,8 @@ Float_t AliMUONGeometrySegmentation::Distance2AndOffset(Int_t detElemId, Float_t xg, Float_t yg, Float_t zg, Int_t* dummy) { -// Returns the square of the distance between 1 pad -// labelled by its channel numbers and a coordinate -// --- +/// Return the square of the distance between 1 pad +/// labelled by its channel numbers and a coordinate if (!OwnNotify(detElemId)) return 0.; @@ -513,10 +494,9 @@ void AliMUONGeometrySegmentation::GetNParallelAndOffset(Int_t detElemId, Int_t ix, Int_t iy, Int_t* nparallel, Int_t* offset) { -// Number of pads read in parallel and offset to add to x -// (specific to LYON, but mandatory for display) -// CHECK -// --- +/// Number of pads read in parallel and offset to add to x +/// (specific to LYON, but mandatory for display) +/// CHECK if (!OwnNotify(detElemId)) return; @@ -530,8 +510,7 @@ void AliMUONGeometrySegmentation::Neighbours(Int_t detElemId, Int_t* nlist, Int_t xlist[10], Int_t ylist[10]) { -// Get next neighbours -// --- +/// Get next neighbours if (!OwnNotify(detElemId)) return; @@ -541,9 +520,8 @@ void AliMUONGeometrySegmentation::Neighbours(Int_t detElemId, //______________________________________________________________________________ Int_t AliMUONGeometrySegmentation::Ix() { -// Current pad cursor during disintegration -// x, y-coordinate -// --- +/// Current pad cursor during disintegration +/// x, y-coordinate return fCurrentSegmentation->Ix(); } @@ -551,9 +529,8 @@ Int_t AliMUONGeometrySegmentation::Ix() //______________________________________________________________________________ Int_t AliMUONGeometrySegmentation::Iy() { -// Current pad cursor during disintegration -// x, y-coordinate -// --- +/// Current pad cursor during disintegration +/// x, y-coordinate return fCurrentSegmentation->Iy(); } @@ -561,9 +538,8 @@ Int_t AliMUONGeometrySegmentation::Iy() //______________________________________________________________________________ Int_t AliMUONGeometrySegmentation::DetElemId() { -// Current pad cursor during disintegration -// x, y-coordinate -// --- +/// Current pad cursor during disintegration +/// x, y-coordinate return fCurrentDetElemId; } @@ -571,8 +547,7 @@ Int_t AliMUONGeometrySegmentation::DetElemId() //______________________________________________________________________________ Int_t AliMUONGeometrySegmentation::ISector() { -// Current sector -// --- +/// Current sector return fCurrentSegmentation->ISector(); } @@ -580,8 +555,7 @@ Int_t AliMUONGeometrySegmentation::ISector() //______________________________________________________________________________ Int_t AliMUONGeometrySegmentation::Sector(Int_t detElemId, Int_t ix, Int_t iy) { -// Calculate sector from pad coordinates -// --- +/// Calculate sector from pad coordinates if (!OwnNotify(detElemId)) return 0; @@ -592,8 +566,7 @@ Int_t AliMUONGeometrySegmentation::Sector(Int_t detElemId, Int_t ix, Int_t iy) Int_t AliMUONGeometrySegmentation::Sector(Int_t detElemId, Float_t xg, Float_t yg, Float_t zg) { -// Calculate sector from pad coordinates -// --- +/// Calculate sector from pad coordinates if (!OwnNotify(detElemId)) return 0; @@ -608,8 +581,7 @@ void AliMUONGeometrySegmentation::IntegrationLimits(Int_t detElemId, Float_t& x1, Float_t& x2, Float_t& y1, Float_t& y2) { -// Current integration limits -// --- +/// Current integration limits if (!OwnNotify(detElemId)) return; @@ -620,19 +592,18 @@ void AliMUONGeometrySegmentation::IntegrationLimits(Int_t detElemId, Int_t AliMUONGeometrySegmentation::SigGenCond(Int_t detElemId, Float_t xg, Float_t yg, Float_t zg) { -// Signal Generation Condition during Stepping -// 0: don't generate signal -// 1: generate signal -// Comments: -// -// Crossing of pad boundary and mid plane between neighbouring wires is checked. -// To correctly simulate the dependence of the spatial resolution on the angle -// of incidence signal must be generated for constant steps on -// the projection of the trajectory along the anode wire. -// -// Signal will be generated if particle crosses pad boundary or -// boundary between two wires. -// --- +/// Signal Generation Condition during Stepping +/// 0: don't generate signal \n +/// 1: generate signal \n +/// Comments: \n +/// \n +/// Crossing of pad boundary and mid plane between neighbouring wires is checked. +/// To correctly simulate the dependence of the spatial resolution on the angle +/// of incidence signal must be generated for constant steps on +/// the projection of the trajectory along the anode wire. +/// \n +/// Signal will be generated if particle crosses pad boundary or +/// boundary between two wires. if (!OwnNotify(detElemId)) return 0; @@ -646,10 +617,9 @@ Int_t AliMUONGeometrySegmentation::SigGenCond(Int_t detElemId, void AliMUONGeometrySegmentation::SigGenInit(Int_t detElemId, Float_t xg, Float_t yg, Float_t zg) { -// Initialise signal generation at coord (x,y,z) -// Initialises pad and wire position during stepping. -// From AliMUONGeometrySegmentationV01 -// --- +/// Initialise signal generation at coord (x,y,z) +/// Initialise pad and wire position during stepping. +/// From AliMUONGeometrySegmentationV01 if (!OwnNotify(detElemId)) return; @@ -672,11 +642,10 @@ void AliMUONGeometrySegmentation::GiveTestPoints(Int_t /*detElemId*/, Int_t& /*n*/, Float_t* /*xg*/, Float_t* /*yg*/) const { -// Test points for auto calibration -// Returns test point on the pad plane. -// Used during determination of the segmoid correction of the COG-method -// From AliMUONGeometrySegmentationV01 -// --- +/// Test points for auto calibration +/// Return test point on the pad plane. +/// Used during determination of the segmoid correction of the COG-method +/// From AliMUONGeometrySegmentationV01 // Requires change of interface // to convert points from local to global we need z coordinate @@ -686,8 +655,7 @@ void AliMUONGeometrySegmentation::GiveTestPoints(Int_t /*detElemId*/, //______________________________________________________________________________ void AliMUONGeometrySegmentation::Draw(const char* opt) { -// Draws the segmentation zones for all detElemId -// --- +/// Draw the segmentation zones for all detElemId for (Int_t i=0; iGetNofEntries(); i++) { AliMUONVGeometryDESegmentation* segmentation @@ -699,8 +667,7 @@ void AliMUONGeometrySegmentation::Draw(const char* opt) //______________________________________________________________________________ void AliMUONGeometrySegmentation::Draw(Int_t detElemId, const char* opt) { -// Draw the segmentation zones for a given detElemId. -// --- +/// Draw the segmentation zones for a given detElemId. if (!OwnNotify(detElemId)) return; @@ -711,9 +678,8 @@ void AliMUONGeometrySegmentation::Draw(Int_t detElemId, const char* opt) void AliMUONGeometrySegmentation::SetCorrFunc(Int_t detElemId, Int_t isec, TF1* func) { -// Set the correction function. -// From AliMUONGeometrySegmentationV01 -// --- +/// Set the correction function. +/// From AliMUONGeometrySegmentationV01 if (!OwnNotify(detElemId)) return; @@ -723,9 +689,8 @@ void AliMUONGeometrySegmentation::SetCorrFunc(Int_t detElemId, //______________________________________________________________________________ TF1* AliMUONGeometrySegmentation::CorrFunc(Int_t detElemId, Int_t isec) const { -// Get the correction Function. -// From AliMUONGeometrySegmentationV01 -// --- +/// Get the correction Function. +/// From AliMUONGeometrySegmentationV01 if (!OwnNotify(detElemId)) return 0; diff --git a/MUON/AliMUONGeometrySegmentation.h b/MUON/AliMUONGeometrySegmentation.h index 819b34e33ae..65c0b78678f 100644 --- a/MUON/AliMUONGeometrySegmentation.h +++ b/MUON/AliMUONGeometrySegmentation.h @@ -3,14 +3,15 @@ /* $Id$ */ -// -// Class AliMUONGeometrySegmentation -// ---------------------------------- -// New class for the geometry segmentation -// composed of the segmentations of detection elements. -// Applies transformations defined in geometry. -// -// Author:Ivana Hrivnacova, IPN Orsay +/// \ingroup geometry +/// \class AliMUONGeometrySegmentation +/// \brief Segmentation for a geometry module +/// +/// New class for the geometry segmentation +/// composed of the segmentations of detection elements. +/// Applies transformations defined in geometry. +/// +/// Author:Ivana Hrivnacova, IPN Orsay #ifndef ALI_MUON_GEOMETRY_SEGMENTATION_H #define ALI_MUON_GEOMETRY_SEGMENTATION_H diff --git a/MUON/AliMUONGeometryStore.cxx b/MUON/AliMUONGeometryStore.cxx index b449d3548ec..d086035de3c 100644 --- a/MUON/AliMUONGeometryStore.cxx +++ b/MUON/AliMUONGeometryStore.cxx @@ -43,7 +43,7 @@ AliMUONGeometryStore::AliMUONGeometryStore( fObjects(fgkInitSize), fDEIndexing(indexing) { -// Standard constructor +/// Standard constructor fObjects.SetOwner(isOwner); for (Int_t i=0; iGetDetElementIndex(objectId) << endl; @@ -117,8 +120,7 @@ void AliMUONGeometryStore::Add(Int_t objectId, TObject* object) TObject* AliMUONGeometryStore::Get(Int_t objectId, Bool_t warn) const { -// Returns transformation for the specified detector element Id -// --- +/// Returns the object for the specified detector element Id Int_t index = fDEIndexing->GetDetElementIndex(objectId); @@ -133,7 +135,8 @@ AliMUONGeometryStore::Get(Int_t objectId, Bool_t warn) const //______________________________________________________________________________ Int_t AliMUONGeometryStore::GetNofEntries() const { -// Add check if the array is already filled +/// Return number of entries +/// Add check if the array is already filled return fObjects.GetEntriesFast(); } @@ -143,8 +146,8 @@ Int_t AliMUONGeometryStore::GetNofEntries() const TObject* AliMUONGeometryStore::GetEntry(Int_t index) const { -// -// Add check if the array is already filled +/// Return entry at specified index. +/// Add check if the array is already filled return (TObject*) fObjects.At(index); } diff --git a/MUON/AliMUONGeometryStore.h b/MUON/AliMUONGeometryStore.h index 32d8cadaa9e..736062d2a4e 100644 --- a/MUON/AliMUONGeometryStore.h +++ b/MUON/AliMUONGeometryStore.h @@ -2,14 +2,16 @@ * See cxx source for full Copyright notice */ // $Id$ -// -// Class AliMUONGeometryStore -// -------------------------- -// The class contains the array of the detection elements, -// which are sorted using the AliMUONVGeometryDEIndexing class. -// The class provides fast access to detection element via detElemId. -// -// Author: Ivana Hrivnacova, IPN Orsay + +/// \ingroup geometry +/// \class AliMUONGeometryStore +/// \brief Array of objects sorted using the AliMUONVGeometryDEIndexing class +/// +/// The class contains the array of objects (derived from TObject), +/// which are sorted using the AliMUONVGeometryDEIndexing class. +/// The class provides fast access to detection element via detElemId. +/// +/// Author: Ivana Hrivnacova, IPN Orsay #ifndef ALI_MUON_GEOMETRY_STORE_H #define ALI_MUON_GEOMETRY_STORE_H diff --git a/MUON/AliMUONGlobalTrigger.h b/MUON/AliMUONGlobalTrigger.h index e117a681c16..139dc81e3d7 100644 --- a/MUON/AliMUONGlobalTrigger.h +++ b/MUON/AliMUONGlobalTrigger.h @@ -7,6 +7,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup base +/// \class AliMUONGlobalTrigger +/// \brief Reconstructed global trigger object + #include class AliMUONGlobalTrigger : public TObject { diff --git a/MUON/AliMUONHit.h b/MUON/AliMUONHit.h index d093fbf1f9f..06f8d829334 100644 --- a/MUON/AliMUONHit.h +++ b/MUON/AliMUONHit.h @@ -6,14 +6,17 @@ /* $Id$ */ // Revision of includes 07/05/2004 -// MUON classe for MonteCarlo Hits, inherited from AliHit for the -// In addition to the ALiHit data member fX, fY, fZ and fTrack, AliMUONHit contains some info about the particle crossing the chamber: -// Impulsion: fPtot, fPx, fPy and fPz -// Reference position at the center of the chamber (wire plane) fXref, fYref and fZref -// Cumulated path along the active volume fTlength for spliting of hits for very inclined tracks -// Energy loss of the particle inside the gas active volume. -// Incident fTheta and fPhi angle with respect of the wire plane of the chamber. -// +/// \ingroup base +/// \class AliMUONHit +/// \brief MonteCarlo hit +/// +/// MUON classe for MonteCarlo Hits, inherited from AliHit for the +/// In addition to the ALiHit data member fX, fY, fZ and fTrack, AliMUONHit contains some info about the particle crossing the chamber: +/// Impulsion: fPtot, fPx, fPy and fPz +/// Reference position at the center of the chamber (wire plane) fXref, fYref and fZref +/// Cumulated path along the active volume fTlength for spliting of hits for very inclined tracks +/// Energy loss of the particle inside the gas active volume. +/// Incident fTheta and fPhi angle with respect of the wire plane of the chamber. #include "AliHit.h" diff --git a/MUON/AliMUONHitForRec.h b/MUON/AliMUONHitForRec.h index 83a15f996a6..d45e53ca6af 100644 --- a/MUON/AliMUONHitForRec.h +++ b/MUON/AliMUONHitForRec.h @@ -6,6 +6,10 @@ /*$Id$*/ // Revision of includes 07/05/2004 +/// \ingroup rec +/// \class AliMUONHitForRec +/// \brief Hit for reconstruction in ALICE dimuon spectrometer + #include class AliTrackReference; diff --git a/MUON/AliMUONHitMapA1.h b/MUON/AliMUONHitMapA1.h index 08d358fa660..ea0da7b3c43 100644 --- a/MUON/AliMUONHitMapA1.h +++ b/MUON/AliMUONHitMapA1.h @@ -7,6 +7,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup base +/// \class AliMUONHitMapA1 +/// \brief Implements HitMap as a 1-dim array + #include "AliHitMap.h" class TObjArray; diff --git a/MUON/AliMUONLoader.h b/MUON/AliMUONLoader.h index c3f00bec8a4..b6af2a32b33 100644 --- a/MUON/AliMUONLoader.h +++ b/MUON/AliMUONLoader.h @@ -1,23 +1,15 @@ #ifndef ALIMUONLOADER_H #define ALIMUONLOADER_H -/************************************************************************** - * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. * - * * - * Author: The ALICE Off-line Project. * - * Contributors are mentioned in the code where appropriate. * - * * - * Permission to use, copy, modify and distribute this software and its * - * documentation strictly for non-commercial purposes is hereby granted * - * without fee, provided that the above copyright notice appears in all * - * copies and that both the copyright notice and this permission notice * - * appear in the supporting documentation. The authors make no claims * - * about the suitability of this software for any purpose. It is * - * provided "as is" without express or implied warranty. * - **************************************************************************/ +/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. * + * See cxx source for full Copyright notice */ /* $Id$ */ // Revision of includes 07/05/2004 +// +/// \ingroup base +/// \class AliMUONDataLoader +/// \brief MUON loader #include "AliLoader.h" diff --git a/MUON/AliMUONLocalTrigger.h b/MUON/AliMUONLocalTrigger.h index 82968312981..3b068c5c94a 100644 --- a/MUON/AliMUONLocalTrigger.h +++ b/MUON/AliMUONLocalTrigger.h @@ -7,6 +7,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup base +/// \class AliMUONLocalTrigger +/// \brief Reconstructed Local Trigger object + #include #include diff --git a/MUON/AliMUONMathieson.h b/MUON/AliMUONMathieson.h index ef8d4d51948..dbed0a6d4e1 100644 --- a/MUON/AliMUONMathieson.h +++ b/MUON/AliMUONMathieson.h @@ -5,6 +5,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +// +/// \ingroup base +/// \class AliMUONMathieson +/// \brief Implementation of Mathieson response class AliMUONGeometrySegmentation; diff --git a/MUON/AliMUONPixel.h b/MUON/AliMUONPixel.h index 09def66b5d1..40973438bb4 100644 --- a/MUON/AliMUONPixel.h +++ b/MUON/AliMUONPixel.h @@ -6,6 +6,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup rec +/// \class AliMUONPixel +/// \brief Pixel for MLEM method of cluster finding + #include class AliMUONPixel : public TObject { diff --git a/MUON/AliMUONPoints.h b/MUON/AliMUONPoints.h index a320b57ec67..3628a920a8b 100644 --- a/MUON/AliMUONPoints.h +++ b/MUON/AliMUONPoints.h @@ -6,6 +6,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +// +/// \ingroup base +/// \class AliMUONPoints +/// \brief Class to draw detector clusters (is PolyMarker3D) #include "AliPoints.h" diff --git a/MUON/AliMUONRawCluster.h b/MUON/AliMUONRawCluster.h index 36a13803fba..8bab9a0e26c 100644 --- a/MUON/AliMUONRawCluster.h +++ b/MUON/AliMUONRawCluster.h @@ -7,9 +7,13 @@ /* $Id$ */ // Revision of includes 07/05/2004 -// Class for the MUON RecPoint -// It contains the propeorties of the physics cluters found in the tracking chambers -// RawCluster contains also the information from the both cathode of the chambers. +/// \ingroup base +/// \class AliMUONRawCluster +/// \brief MUON raw cluster +/// +/// Class for the MUON RecPoint +/// It contains the propeorties of the physics cluters found in the tracking chambers +/// RawCluster contains also the information from the both cathode of the chambers. #include diff --git a/MUON/AliMUONRawData.h b/MUON/AliMUONRawData.h index 3f945b7ca1a..7d06af4d35a 100644 --- a/MUON/AliMUONRawData.h +++ b/MUON/AliMUONRawData.h @@ -3,9 +3,14 @@ /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. * * See cxx source for full Copyright notice */ -/* Raw data class for trigger and tracker chambers */ -#include -#include +/*$Id$*/ + +/// \ingroup rec +/// \class AliMUONRawData +/// \brief Raw data class for trigger and tracker chambers +/// +/// Raw data class for trigger and tracker chambers + #include #include #include "AliMUONSubEventTracker.h" diff --git a/MUON/AliMUONRawStream.h b/MUON/AliMUONRawStream.h index 2fcaccc8183..44acef016d2 100644 --- a/MUON/AliMUONRawStream.h +++ b/MUON/AliMUONRawStream.h @@ -3,9 +3,15 @@ /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. * * See cxx source for full Copyright notice */ +/*$Id$*/ + +/// \ingroup rec +/// \class AliMUONRawStream +/// \brief Class for reading MUON raw digits +/// /////////////////////////////////////////////////////////////////////////////// /// -/// This class provides access to TPC digits in raw data. +/// This class provides access to MUON digits in raw data. /// /////////////////////////////////////////////////////////////////////////////// diff --git a/MUON/AliMUONRecoCheck.h b/MUON/AliMUONRecoCheck.h index e2a56dfdc6f..28d3cc366f6 100644 --- a/MUON/AliMUONRecoCheck.h +++ b/MUON/AliMUONRecoCheck.h @@ -4,6 +4,12 @@ /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. * * See cxx source for full Copyright notice */ +/* $Id$ */ + +/// \ingroup base +/// \class AliMUONRecoCheck +/// \brief Utility class to check reconstruction + ////////////////////////////////////////////////////////////////////////// // // // AliMUONRecoCheck // diff --git a/MUON/AliMUONRecoTrack.h b/MUON/AliMUONRecoTrack.h index adf11ba457e..211ae849b77 100644 --- a/MUON/AliMUONRecoTrack.h +++ b/MUON/AliMUONRecoTrack.h @@ -6,8 +6,11 @@ /*$Id$*/ - -// Authors : M.Gheata, A.Gheata 09/10/00 +/// \ingroup rec +/// \class AliMUONRecoTrack +/// \brief A reconstructed muon track +/// +/// Authors : M.Gheata, A.Gheata 09/10/00 #include #include diff --git a/MUON/AliMUONReconstructor.h b/MUON/AliMUONReconstructor.h index 91c0b269eb9..9cae9359f63 100644 --- a/MUON/AliMUONReconstructor.h +++ b/MUON/AliMUONReconstructor.h @@ -6,6 +6,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup rec +/// \class AliMUONReconstructor +/// \brief Class for the MUON reconstruction + #include "AliReconstructor.h" class AliMUONReconstructor: public AliReconstructor diff --git a/MUON/AliMUONResponse.h b/MUON/AliMUONResponse.h index 30c7ae5c997..71b53196625 100644 --- a/MUON/AliMUONResponse.h +++ b/MUON/AliMUONResponse.h @@ -6,6 +6,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup sim +/// \class AliMUONResponse +/// \brief Chamber response base class + #include class TF1; diff --git a/MUON/AliMUONResponseTrigger.h b/MUON/AliMUONResponseTrigger.h index 3485136331a..868cb512d72 100644 --- a/MUON/AliMUONResponseTrigger.h +++ b/MUON/AliMUONResponseTrigger.h @@ -6,6 +6,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup sim +/// \class AliMUONResponseTrigger +/// \brief Implementation of RPC response + #include "AliMUONResponse.h" class AliMUONResponseTrigger : public AliMUONResponse diff --git a/MUON/AliMUONResponseTriggerV1.h b/MUON/AliMUONResponseTriggerV1.h index f1a1b1c783f..394ed987752 100644 --- a/MUON/AliMUONResponseTriggerV1.h +++ b/MUON/AliMUONResponseTriggerV1.h @@ -6,6 +6,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup sim +/// \class AliMUONResponseTriggerV1 +/// \brief Implementation of RPC response + #include "AliMUONResponseTrigger.h" class AliMUONResponseTriggerV1 : public AliMUONResponseTrigger diff --git a/MUON/AliMUONResponseV0.h b/MUON/AliMUONResponseV0.h index 94f3fe52a81..e4cb526eba9 100644 --- a/MUON/AliMUONResponseV0.h +++ b/MUON/AliMUONResponseV0.h @@ -6,6 +6,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup sim +/// \class AliMUONResponseV0 +/// \brief Implementation of Mathieson response + #include "AliMUONResponse.h" #include "AliMUONMathieson.h" diff --git a/MUON/AliMUONSDigitizerv1.h b/MUON/AliMUONSDigitizerv1.h index a075ce078bf..7632425db51 100644 --- a/MUON/AliMUONSDigitizerv1.h +++ b/MUON/AliMUONSDigitizerv1.h @@ -6,9 +6,11 @@ /* $Id$ */ // Revision of includes 07/05/2004 -// The AliMUONSDigitizer produces -// SDigits from Hits -// J.P Cussonneau Subatech Feb 2004 +/// \ingroup sim +/// \class AliMUONSDigitizerv1 +/// \brief Class produces SDigits from Hits +/// +/// Author: J.P Cussonneau Subatech Feb 2004 #include "AliMUONDigitizer.h" @@ -47,7 +49,7 @@ class AliMUONSDigitizerv1 : public AliMUONDigitizer Int_t /*digitindex*/ ) {return;} - ClassDef(AliMUONSDigitizerv1, 0) + ClassDef(AliMUONSDigitizerv1, 0) //Class produces SDigits from Hits }; #endif diff --git a/MUON/AliMUONScalerEventTrigger.h b/MUON/AliMUONScalerEventTrigger.h index 6dd5b6392fa..70cd0861199 100644 --- a/MUON/AliMUONScalerEventTrigger.h +++ b/MUON/AliMUONScalerEventTrigger.h @@ -3,6 +3,11 @@ /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. * * See cxx source for full Copyright notice */ +/*$Id$*/ + +/// \ingroup rec +/// \class AliMUONScalerEventTrigger +/// \brief MUON scaler event trigger #include diff --git a/MUON/AliMUONSegment.h b/MUON/AliMUONSegment.h index f91c3862c71..e0050d8f1f2 100644 --- a/MUON/AliMUONSegment.h +++ b/MUON/AliMUONSegment.h @@ -6,9 +6,13 @@ /*$Id$*/ // Revision of includes 07/05/2004 -/////////////////////////////////////////////////////////// -// Segment for reconstruction in ALICE dimuon spectrometer -/////////////////////////////////////////////////////////// +/// \ingroup rec +/// \class AliMUONSegment +/// \brief Segment for reconstruction in ALICE dimuon spectrometer +/// +//////////////////////////////////////////////////////////// +/// Segment for reconstruction in ALICE dimuon spectrometer +//////////////////////////////////////////////////////////// #include diff --git a/MUON/AliMUONSegmentIndex.h b/MUON/AliMUONSegmentIndex.h index c91fc06d666..c2359cc0473 100644 --- a/MUON/AliMUONSegmentIndex.h +++ b/MUON/AliMUONSegmentIndex.h @@ -5,6 +5,10 @@ /* $Id$ */ +/// \ingroup base +/// \class AliMUONSegmentIndex +/// \brief Segment element indexing in a detection element + //=================================================================== // Segment element indexing in a detection element // Gines MARTINEZ, SUBATECH July 04 diff --git a/MUON/AliMUONSegmentManuIndex.h b/MUON/AliMUONSegmentManuIndex.h index ed804749b59..ac5ce6826bf 100644 --- a/MUON/AliMUONSegmentManuIndex.h +++ b/MUON/AliMUONSegmentManuIndex.h @@ -5,6 +5,10 @@ /* $Id$ */ +/// \ingroup base +/// \class AliMUONSegmentManuIndex +/// \brief Segment element indexing in a detection element for electronics + //=================================================================== // Segment element indexing in a detection element for electronics // Gines MARTINEZ, SUBATECH July 04 diff --git a/MUON/AliMUONSegmentPosition.h b/MUON/AliMUONSegmentPosition.h index e431eb20b41..5636713997a 100644 --- a/MUON/AliMUONSegmentPosition.h +++ b/MUON/AliMUONSegmentPosition.h @@ -5,6 +5,10 @@ /* $Id$ */ +/// \ingroup base +/// \class AliMUONSegmentPosition +/// \brief Local positions of segments + //=================================================================== // Segment element position in local coordinates of the detection element // Gines MARTINEZ, SUBATECH July 04 @@ -48,7 +52,7 @@ class AliMUONSegmentPosition : public TNamed static Float_t fUnit; // Unit for generation of the name 3mm has been choses - ClassDef(AliMUONSegmentPosition,1) // Loal positions of segments + ClassDef(AliMUONSegmentPosition,1) // Local positions of segments }; #endif diff --git a/MUON/AliMUONSegmentationDetectionElement.h b/MUON/AliMUONSegmentationDetectionElement.h index d7feb8bfd2b..a42d5ac6538 100644 --- a/MUON/AliMUONSegmentationDetectionElement.h +++ b/MUON/AliMUONSegmentationDetectionElement.h @@ -5,6 +5,10 @@ /* $Id$ */ +/// \ingroup base +/// \class AliMUONSegmentationDetectionElement +/// \brief Segmentation class for detection element + //=========================================================== // Segmentation classes for MUON Detection Elements // Gines MARTINEZ, SUBATECH July 04 diff --git a/MUON/AliMUONSegmentationManager.h b/MUON/AliMUONSegmentationManager.h index f9fb9745b63..50b526f4f56 100644 --- a/MUON/AliMUONSegmentationManager.h +++ b/MUON/AliMUONSegmentationManager.h @@ -6,6 +6,10 @@ /* $Id$ */ +/// \ingroup base +/// \class AliMUONSegmentationManager +/// \brief Segmentation manager + #ifndef ROOT_TObject #include "TObject.h" #endif diff --git a/MUON/AliMUONSlatGeometryBuilder.h b/MUON/AliMUONSlatGeometryBuilder.h index f208d05bc58..c286519cf9a 100644 --- a/MUON/AliMUONSlatGeometryBuilder.h +++ b/MUON/AliMUONSlatGeometryBuilder.h @@ -4,11 +4,11 @@ // $Id$ // Revision of includes 07/05/2004 // -// Class AliMUONSlatGeometryBuilder -// ----------------------------- -// MUON Station3 geometry construction class. -// -// Author: Eric Dumonteil (dumontei@cea.fr) +/// \ingroup base +/// \class AliMUONSlatGeometryBuilder +/// \brief MUON Station3 geometry construction class +/// +/// Author: Eric Dumonteil (dumontei@cea.fr) #ifndef ALI_MUON_SLAT_GEOMETRY_BUILDER_H @@ -41,7 +41,7 @@ class AliMUONSlatGeometryBuilder : public AliMUONVGeometryBuilder AliMUON* fMUON; // the MUON detector class - ClassDef(AliMUONSlatGeometryBuilder,1) // MUON chamber geometry base class + ClassDef(AliMUONSlatGeometryBuilder,1) //MUON Station3 geometry construction class }; #endif //ALI_MUON_SLAT_GEOMETRY_BUILDER_H diff --git a/MUON/AliMUONSt12QuadrantSegmentation.h b/MUON/AliMUONSt12QuadrantSegmentation.h index cf5bccdee7b..cff3da8c872 100644 --- a/MUON/AliMUONSt12QuadrantSegmentation.h +++ b/MUON/AliMUONSt12QuadrantSegmentation.h @@ -7,6 +7,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup base +/// \class AliMUONSt12QuadrantSegmentation +/// \brief Segmentation for MUON quadrants of stations 1 and 2 + // Class AliMUONSt12QuadrantSegmentation // ------------------------------------- // Segmentation for MUON quadrants of stations 1 and 2 using diff --git a/MUON/AliMUONSt1Decoder.h b/MUON/AliMUONSt1Decoder.h index 1b7164d799d..c4d04aeb622 100644 --- a/MUON/AliMUONSt1Decoder.h +++ b/MUON/AliMUONSt1Decoder.h @@ -6,18 +6,20 @@ /* $Id$ */ // Revision of includes 07/05/2004 -// Authors: David Guez, Ivana Hrivnacova, Marion MacCormick; IPN Orsay -// -// Class AliMUONSt1Decoder -// ----------------------- -// A generic set of functions (defined in the namespace). -// Used to decode formatted strings, eg. a list of integer ranges, -// or a list of sub-strings separated by delimiters such as '(','{','[', ... . -// Example: -// (string 1) (string 2) [string3] {string4} [ (string5.1) (string5.2) ] -// note : |_____________________| -// | -// this is just ONE substring. +/// \ingroup sim +/// \class AliMUONSt1Decoder +/// \brief Set of functions to decode formatted strings +/// +/// A generic set of functions (defined in the namespace). +/// Used to decode formatted strings, eg. a list of integer ranges, +/// or a list of sub-strings separated by delimiters such as '(','{','[', ... . +/// Example: \n +/// (string 1) (string 2) [string3] {string4} [ (string5.1) (string5.2) ] \n +/// note : |_____________________| \n +/// | \n +/// this is just ONE substring. \n +/// +/// Authors: David Guez, Ivana Hrivnacova, Marion MacCormick; IPN Orsay #include #include diff --git a/MUON/AliMUONSt1ElectronicElement.h b/MUON/AliMUONSt1ElectronicElement.h index b5cfa4715f7..08761d371c9 100644 --- a/MUON/AliMUONSt1ElectronicElement.h +++ b/MUON/AliMUONSt1ElectronicElement.h @@ -6,16 +6,18 @@ /* $Id$ */ // Revision of includes 07/05/2004 -// Authors: David Guez, Ivana Hrivnacova, Marion MacCormick; IPN Orsay -// -// Class AliMUONSt1ElectronicElement -// --------------------------------- -// Describes a set of pads either by defining -// a range of indices, or -// a range of (centimeters) positions or -// a range of electronic channel numbers or -// a range of MANU numbers or, finally, -// a range of gassiplex/MANAS numbers, in a given range of MANU addresses +/// \ingroup sim +/// \class AliMUONSt1ElectronicElement +/// \brief Describes a set of pads defined by different ways +/// +/// Describes a set of pads either by defining +/// - a range of indices, or +/// - a range of (centimeters) positions or +/// - a range of electronic channel numbers or +/// - a range of MANU numbers or, finally, +/// - a range of gassiplex/MANAS numbers, in a given range of MANU addresses +/// +/// Authors: David Guez, Ivana Hrivnacova, Marion MacCormick; IPN Orsay #include diff --git a/MUON/AliMUONSt1GeometryBuilder.h b/MUON/AliMUONSt1GeometryBuilder.h index b8d8edb80c4..988a69ae44a 100644 --- a/MUON/AliMUONSt1GeometryBuilder.h +++ b/MUON/AliMUONSt1GeometryBuilder.h @@ -3,13 +3,13 @@ // $Id$ // Revision of includes 07/05/2004 -// -// Class AliMUONSt1GeometryBuilder -// ----------------------------- -// MUON Station1 coarse geometry construction class. -// -// Extracted from AliMUONv1 -// by Ivana Hrivnacova, IPN Orsay + +/// \ingroup base +/// \class AliMUONCommonGeometryBuilder +/// \brief MUON Station1 coarse geometry construction class +/// +/// Extracted from AliMUONv1 +/// by Ivana Hrivnacova, IPN Orsay #ifndef ALI_MUON_ST1_GEOMETRY_BUILDER_H #define ALI_MUON_ST1_GEOMETRY_BUILDER_H @@ -39,7 +39,7 @@ class AliMUONSt1GeometryBuilder : public AliMUONVGeometryBuilder private: AliMUON* fMUON; // the MUON detector class - ClassDef(AliMUONSt1GeometryBuilder,1) // MUON chamber geometry base class + ClassDef(AliMUONSt1GeometryBuilder,1) //MUON Station1 coarse geometry construction class }; #endif //ALI_MUON_ST1_GEOMETRY_BUILDER_H diff --git a/MUON/AliMUONSt1IniReader.h b/MUON/AliMUONSt1IniReader.h index d182a306d4b..647a750a39a 100644 --- a/MUON/AliMUONSt1IniReader.h +++ b/MUON/AliMUONSt1IniReader.h @@ -6,18 +6,20 @@ /* $Id$ */ // Revision of includes 07/05/2004 -// Authors: David Guez, Ivana Hrivnacova, Marion MacCormick; IPN Orsay -// -// Class AliMUONIniReader -// ---------------------- -// General class to read data in ASCII file format, -// similar to the Windows ".ini" files (a set of sections tagged by a -// [ sectionName ] -// and values defined in the way: -// parameterName = value -// -// comment lines can be introduced if the first non-blank character -// is either ';' or '#' +/// \ingroup sim +/// \class AliMUONSt1IniReader +/// \brief General class to read data in a special ASCII file format +/// +/// General class to read data in ASCII file format, +/// similar to the Windows ".ini" files (a set of sections tagged by a \n +/// [ sectionName ] \n +/// and values defined in the way: \n +/// parameterName = value \n +/// +/// comment lines can be introduced if the first non-blank character +/// is either ';' or '#' +/// +/// Authors: David Guez, Ivana Hrivnacova, Marion MacCormick; IPN Orsay #include diff --git a/MUON/AliMUONSt1Response.h b/MUON/AliMUONSt1Response.h index 72784e3750e..57899388c9e 100644 --- a/MUON/AliMUONSt1Response.h +++ b/MUON/AliMUONSt1Response.h @@ -7,13 +7,15 @@ /* $Id$ */ // Revision of includes 07/05/2004 -// Authors: David Guez, Ivana Hrivnacova, Marion MacCormick; IPN Orsay -// -// Class AliMUONSt1Response -// ---------------------------- -// Response class for station 1 including electronics and detector response. -// Individual pedestals or noise levels can be controlled separately. -// The current pulse height responses do not contain any physics +/// \ingroup sim +/// \class AliMUONSt1Response +/// \brief Detailed response class for station 1 +/// +/// Response class for station 1 including electronics and detector response. +/// Individual pedestals or noise levels can be controlled separately. +/// The current pulse height responses do not contain any physics +/// +/// Authors: David Guez, Ivana Hrivnacova, Marion MacCormick; IPN Orsay #include #include diff --git a/MUON/AliMUONSt1ResponseParameter.h b/MUON/AliMUONSt1ResponseParameter.h index d86cda8253e..ce936595969 100644 --- a/MUON/AliMUONSt1ResponseParameter.h +++ b/MUON/AliMUONSt1ResponseParameter.h @@ -7,14 +7,16 @@ /* $Id$ */ // Revision of includes 07/05/2004 -// Authors: David Guez, Ivana Hrivnacova, Marion MacCormick; IPN Orsay -// -// Class AliMUONSt1ResponseParameter -// --------------------------------- -// Describes a set of filters to be applied to a digital value -// in order to simulate electronics characteristics -// (pedestal, noise, sticky bits, etc....) -// Threshold levels for the MANU zero supression algorithm are included. +/// \ingroup sim +/// \class AliMUONSt1ResponseParameter +/// \brief Describes a set of filters to be applied to a digital value +/// +/// Describes a set of filters to be applied to a digital value +/// in order to simulate electronics characteristics +/// (pedestal, noise, sticky bits, etc....) +/// Threshold levels for the MANU zero supression algorithm are included. +/// +/// Authors: David Guez, Ivana Hrivnacova, Marion MacCormick; IPN Orsay #include diff --git a/MUON/AliMUONSt1ResponseRule.h b/MUON/AliMUONSt1ResponseRule.h index 0a12c628632..4a6347c8eaf 100644 --- a/MUON/AliMUONSt1ResponseRule.h +++ b/MUON/AliMUONSt1ResponseRule.h @@ -6,14 +6,16 @@ /* $Id$ */ // Revision of includes 07/05/2004 -// Authors: David Guez, Ivana Hrivnacova, Marion MacCormick; IPN Orsay -// -// Class AliMUONSt1ResponseRule -// ----------------------------- -// Describes a response rule. -// A "rule" is defined as being a set of electronic filters to be applied -// (ie. a set of AliMUONSt1ResponseParameter) and a set of cathode pads to -// which these filters should be applied (set of AliMUONSt1ElectronicElement) +/// \ingroup sim +/// \class AliMUONSt1ResponseRule +/// \brief Describes a response rule +/// +/// Describes a response rule. +/// A "rule" is defined as being a set of electronic filters to be applied +/// (ie. a set of AliMUONSt1ResponseParameter) and a set of cathode pads to +/// which these filters should be applied (set of AliMUONSt1ElectronicElement) +/// +/// Authors: David Guez, Ivana Hrivnacova, Marion MacCormick; IPN Orsay #include #include diff --git a/MUON/AliMUONSt1SpecialMotif.h b/MUON/AliMUONSt1SpecialMotif.h index 1cd2e0490fa..48c3c07f29a 100644 --- a/MUON/AliMUONSt1SpecialMotif.h +++ b/MUON/AliMUONSt1SpecialMotif.h @@ -6,12 +6,15 @@ /* $Id$ */ // Revision of includes 07/05/2004 -// Authors: David Guez, Ivana Hrivnacova, Marion MacCormick; IPN Orsay -// -// Class AliMUONSt1SpecialMotif -// ---------------------------- -// Encapsulate the distance between the center of a given daughter card -// and the pad/kapton connector. +/// \ingroup sim +/// \class AliMUONSt1SpecialMotif +/// \brief Helper class to encapsulate the distance between the daughter card +/// and the pad/kapton connector +/// +/// Encapsulate the distance between the center of a given daughter card +/// and the pad/kapton connector. +/// +/// Authors: David Guez, Ivana Hrivnacova, Marion MacCormick; IPN Orsay #include diff --git a/MUON/AliMUONSt2GeometryBuilder.h b/MUON/AliMUONSt2GeometryBuilder.h index 985220ab26a..128aa2b8d23 100644 --- a/MUON/AliMUONSt2GeometryBuilder.h +++ b/MUON/AliMUONSt2GeometryBuilder.h @@ -4,11 +4,12 @@ // $Id$ // Revision of includes 07/05/2004 // -// Class AliMUONSt2GeometryBuilder -// ----------------------------- -// MUON Station2 geometry construction class. -// -// Author: Ivana Hrivnacova, IPN Orsay +/// \ingroup base +/// \class AliMUONSt2GeometryBuilder +/// \brief MUON Station2 coarse geometry construction class +/// +/// Extracted from AliMUONv1 +/// by Ivana Hrivnacova, IPN Orsay #ifndef ALI_MUON_ST2_GEOMETRY_BUILDER_H #define ALI_MUON_ST2_GEOMETRY_BUILDER_H @@ -38,7 +39,7 @@ class AliMUONSt2GeometryBuilder : public AliMUONVGeometryBuilder private: AliMUON* fMUON; // the MUON detector class - ClassDef(AliMUONSt2GeometryBuilder,1) // MUON chamber geometry base class + ClassDef(AliMUONSt2GeometryBuilder,1) // MUON Station2 coarse geometry construction class }; #endif //ALI_MUON_ST2_GEOMETRY_BUILDER_H diff --git a/MUON/AliMUONSt2GeometryBuilderV2.h b/MUON/AliMUONSt2GeometryBuilderV2.h index 97b1626c04d..60fbedcd380 100644 --- a/MUON/AliMUONSt2GeometryBuilderV2.h +++ b/MUON/AliMUONSt2GeometryBuilderV2.h @@ -4,12 +4,12 @@ // $Id$ // Revision of includes 07/05/2004 // -// Class AliMUONSt2GeometryBuilderV2 -// ----------------------------- -// MUON Station2 geometry construction class. -// -// Author: SANJOY PAL ,Prof. SUKALYAN CHATTOPADHAYAY [SINP, KOLKATA] -// & Dr.SHAKEEL AHMAD (AMU), INDIA +/// \ingroup base +/// \class AliMUONSt2GeometryBuilderV2 +/// \brief MUON Station2 detailed geometry construction class +/// +/// Authors: SANJOY PAL ,Prof. SUKALYAN CHATTOPADHAYAY [SINP, KOLKATA] +/// & Dr.SHAKEEL AHMAD (AMU), INDIA #ifndef ALI_MUON_ST2_GEOMETRY_BUILDER_V2_H #define ALI_MUON_ST2_GEOMETRY_BUILDER_V2_H @@ -39,7 +39,7 @@ class AliMUONSt2GeometryBuilderV2 : public AliMUONVGeometryBuilder private: AliMUON* fMUON; // the MUON detector class - ClassDef(AliMUONSt2GeometryBuilderV2,1) // MUON chamber geometry base class + ClassDef(AliMUONSt2GeometryBuilderV2,1) //MUON Station2 detailed geometry construction class }; #endif //ALI_MUON_ST2_GEOMETRY_BUILDER_V2_H diff --git a/MUON/AliMUONSt345SlatSegmentation.h b/MUON/AliMUONSt345SlatSegmentation.h index 47f474dcc45..4be75022311 100644 --- a/MUON/AliMUONSt345SlatSegmentation.h +++ b/MUON/AliMUONSt345SlatSegmentation.h @@ -5,13 +5,17 @@ /* $Id$ */ -//********************************************************* -// Segmentation classes for slat modules -// This class works with local coordinates -// of the slats via the class AliMUONGeometrySegmentation -// This class contains the size of the slats and the -// and the differents PCB densities. -//********************************************************* +/// \ingroup base +/// \class AliMUONSt345SlatSegmentation +/// \brief Segmentation for slat modules +/// +///********************************************************* +/// Segmentation classes for slat modules +/// This class works with local coordinates +/// of the slats via the class AliMUONGeometrySegmentation +/// This class contains the size of the slats and the +/// and the differents PCB densities. +///********************************************************* #include "AliMUONVGeometryDESegmentation.h" diff --git a/MUON/AliMUONSt345SlatSegmentationV2.h b/MUON/AliMUONSt345SlatSegmentationV2.h index b441b0a8dd8..b55661ef37a 100644 --- a/MUON/AliMUONSt345SlatSegmentationV2.h +++ b/MUON/AliMUONSt345SlatSegmentationV2.h @@ -1,6 +1,15 @@ #ifndef ALIMUONST345SLATSEGMENTATIONV2_H #define ALIMUONST345SLATSEGMENTATIONV2_H +/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. * + * See cxx source for full Copyright notice */ + +/* $Id$ */ + +/// \ingroup base +/// \class AliMUONSt345SlatSegmentationV2 +/// \brief Segmentation for slat modules + #ifndef ALIMUONVGEOMETRYDESEGMENTATION_H #include "AliMUONVGeometryDESegmentation.h" #endif diff --git a/MUON/AliMUONSubEventTracker.h b/MUON/AliMUONSubEventTracker.h index 08b1e1a6fc5..d2a60f48c0c 100644 --- a/MUON/AliMUONSubEventTracker.h +++ b/MUON/AliMUONSubEventTracker.h @@ -3,6 +3,11 @@ /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. * * See cxx source for full Copyright notice */ +/*$Id$*/ + +/// \ingroup rec +/// \class AliMUONSubEventTracker +/// \brief MUON subevent tracker #include diff --git a/MUON/AliMUONSubEventTrigger.h b/MUON/AliMUONSubEventTrigger.h index 98cc2ef3a87..13e6c348726 100644 --- a/MUON/AliMUONSubEventTrigger.h +++ b/MUON/AliMUONSubEventTrigger.h @@ -3,6 +3,11 @@ /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. * * See cxx source for full Copyright notice */ +/*$Id$*/ + +/// \ingroup rec +/// \class AliMUONSubEventTrigger +/// \brief MUON subevent trigger #include diff --git a/MUON/AliMUONTest.h b/MUON/AliMUONTest.h index f0ba6629be7..f594d3c6c9a 100644 --- a/MUON/AliMUONTest.h +++ b/MUON/AliMUONTest.h @@ -3,11 +3,11 @@ // $Id$ // -// Class AliMUONTest -// ----------------- -// Class with functions for testing -// -// Author: Ivana Hrivnacova, IPN Orsay +/// \ingroup sim +/// \class AliMUONTest +/// \brief Class with functions for testing new segmentation +/// +/// Author: Ivana Hrivnacova, IPN Orsay #ifndef ALI_MUON_TEST_H #define ALI_MUON_TEST_H diff --git a/MUON/AliMUONTrack.h b/MUON/AliMUONTrack.h index d8ea82a35c1..128d7f0fc96 100644 --- a/MUON/AliMUONTrack.h +++ b/MUON/AliMUONTrack.h @@ -6,10 +6,13 @@ /*$Id$*/ // Revision of includes 07/05/2004 - -/////////////////////////////////////////////////// -// Reconstructed track in ALICE dimuon spectrometer -/////////////////////////////////////////////////// +/// \ingroup rec +/// \class AliMUONTrack +/// \brief Reconstructed track in ALICE dimuon spectrometer +/// +//////////////////////////////////////////////////// +/// Reconstructed track in ALICE dimuon spectrometer +//////////////////////////////////////////////////// #include diff --git a/MUON/AliMUONTrackHit.h b/MUON/AliMUONTrackHit.h index c83c5410412..d2f4d567e8b 100644 --- a/MUON/AliMUONTrackHit.h +++ b/MUON/AliMUONTrackHit.h @@ -6,9 +6,13 @@ /*$Id$*/ // Revision of includes 07/05/2004 -/////////////////////////////////////////////////////// -// Reconstructed track hit in ALICE dimuon spectrometer -/////////////////////////////////////////////////////// +/// \ingroup rec +/// \class AliMUONTrackHit +/// \brief Reconstructed track hit in ALICE dimuon spectrometer +/// +//////////////////////////////////////////////////////// +/// Reconstructed track hit in ALICE dimuon spectrometer +//////////////////////////////////////////////////////// #include #include "AliMUONTrackParam.h" // object belongs to the class diff --git a/MUON/AliMUONTrackK.h b/MUON/AliMUONTrackK.h index 6d489cb9589..c500d1244ce 100644 --- a/MUON/AliMUONTrackK.h +++ b/MUON/AliMUONTrackK.h @@ -6,6 +6,10 @@ /*$Id$*/ // Revision of includes 07/05/2004 +/// \ingroup rec +/// \class AliMUONTrack +/// \brief Kalman track in MUON arm of ALICE + #include #include "AliMUONTrack.h" //AZ diff --git a/MUON/AliMUONTrackParam.h b/MUON/AliMUONTrackParam.h index 8eda2da5021..3fadeaac32d 100644 --- a/MUON/AliMUONTrackParam.h +++ b/MUON/AliMUONTrackParam.h @@ -6,9 +6,13 @@ /*$Id$*/ // Revision of includes 07/05/2004 -/////////////////////////////////////////////////// -// Track parameters in ALICE dimuon spectrometer -/////////////////////////////////////////////////// +/// \ingroup rec +/// \class AliMUONTrackParam +/// \brief Track parameters in ALICE dimuon spectrometer +/// +//////////////////////////////////////////////////// +/// Track parameters in ALICE dimuon spectrometer +//////////////////////////////////////////////////// #include diff --git a/MUON/AliMUONTrackReconstructor.h b/MUON/AliMUONTrackReconstructor.h index f9e1de1a4f6..473835f9b29 100644 --- a/MUON/AliMUONTrackReconstructor.h +++ b/MUON/AliMUONTrackReconstructor.h @@ -1,9 +1,17 @@ #ifndef ALIMUONTRACKTRECONSTRUCTOR_H #define ALIMUONTRACKRECONSTRUCTOR_H - -//////////////////////////////////// -// MUON track reconstructor in ALICE -//////////////////////////////////// +/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. * + * See cxx source for full Copyright notice */ + +/* $Id$ */ + +/// \ingroup rec +/// \class AliMUONTrackReconstructor +/// \brief Class for the MUON track reconstruction +/// +///////////////////////////////////// +/// MUON track reconstructor in ALICE +///////////////////////////////////// #include #include "AliMUONConstants.h" diff --git a/MUON/AliMUONTransientDigit.h b/MUON/AliMUONTransientDigit.h index 23208714ec2..47e8019f7ed 100644 --- a/MUON/AliMUONTransientDigit.h +++ b/MUON/AliMUONTransientDigit.h @@ -7,6 +7,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup base +/// \class AliMUONTransientDigit +/// \brief MUON transient digit + #include "AliMUONDigit.h" class TObjArray; diff --git a/MUON/AliMUONTriggerCircuit.h b/MUON/AliMUONTriggerCircuit.h index cbf2f34c5bf..2b0d417325a 100644 --- a/MUON/AliMUONTriggerCircuit.h +++ b/MUON/AliMUONTriggerCircuit.h @@ -5,12 +5,14 @@ /* $Id$ */ // Revision of includes 07/05/2004 +// +/// \ingroup base +/// \class AliMUONTriggerCircuit +/// \brief MUON Trigger circuit #include #include -class AliMUONGeometrtSegmentation; - class TObjArray; class AliMUONTriggerCircuit : public TObject diff --git a/MUON/AliMUONTriggerConstants.h b/MUON/AliMUONTriggerConstants.h index d94395412b0..3b35149b081 100644 --- a/MUON/AliMUONTriggerConstants.h +++ b/MUON/AliMUONTriggerConstants.h @@ -6,6 +6,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +// +/// \ingroup base +/// \class AliMUONTriggerConstants +/// \brief MUON Trigger constants #include diff --git a/MUON/AliMUONTriggerDecision.h b/MUON/AliMUONTriggerDecision.h index c7db6313183..dc6b3c2bd92 100644 --- a/MUON/AliMUONTriggerDecision.h +++ b/MUON/AliMUONTriggerDecision.h @@ -7,9 +7,13 @@ #ifndef ALIMUONTRIGGERDECISION_H #define ALIMUONTRIGGERDECISION_H -//////////////////////////////////////////////// -// MUON Trigger Decision Class // -//////////////////////////////////////////////// +/// \ingroup sim +/// \class AliMUONTriggerDecision +/// \brief MUON trigger decision class +/// +///////////////////////////////////////////////// +/// MUON Trigger Decision Class // +///////////////////////////////////////////////// #include #include "AliMUONLocalTrigger.h" diff --git a/MUON/AliMUONTriggerGeometryBuilder.h b/MUON/AliMUONTriggerGeometryBuilder.h index 4aa6ec8a9b7..f0f924efb07 100644 --- a/MUON/AliMUONTriggerGeometryBuilder.h +++ b/MUON/AliMUONTriggerGeometryBuilder.h @@ -4,11 +4,11 @@ // $Id$ // Revision of includes 07/05/2004 // -// Class AliMUONTriggerGeometryBuilder -// ----------------------------------- -// MUON Trigger stations geometry construction class. -// -// Author: Philippe Crochette, LPC Clermont-Ferrand +/// \ingroup base +/// \class AliMUONTriggerGeometryBuilder +/// \brief MUON Trigger stations geometry construction class +/// +/// Author: Philippe Crochette, LPC Clermont-Ferrand #ifndef ALI_MUON_TRIGGER_GEOMETRY_BUILDER_H #define ALI_MUON_TRIGGER_GEOMETRY_BUILDER_H @@ -38,7 +38,7 @@ class AliMUONTriggerGeometryBuilder : public AliMUONVGeometryBuilder private: AliMUON* fMUON; // the MUON detector class - ClassDef(AliMUONTriggerGeometryBuilder,1) // MUON chamber geometry base class + ClassDef(AliMUONTriggerGeometryBuilder,1) // MUON Trigger stations geometry construction class }; #endif //ALI_MUON_TRIGGER_GEOMETRY_BUILDER_H diff --git a/MUON/AliMUONTriggerLut.h b/MUON/AliMUONTriggerLut.h index 8d81fe45328..bf9810a9e37 100644 --- a/MUON/AliMUONTriggerLut.h +++ b/MUON/AliMUONTriggerLut.h @@ -6,6 +6,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup base +/// \class AliMUONTriggerLut +/// \brief MUON trigger look up table class + #include class TH3S; diff --git a/MUON/AliMUONTriggerSegmentation.h b/MUON/AliMUONTriggerSegmentation.h index 6c09c0db01e..91c4e02fdf6 100644 --- a/MUON/AliMUONTriggerSegmentation.h +++ b/MUON/AliMUONTriggerSegmentation.h @@ -3,7 +3,11 @@ /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. * * See cxx source for full Copyright notice */ -/* $Id: */ +/* $Id$*/ + +/// \ingroup base +/// \class AliMUONTriggerSegmentation +/// \brief Segmentation for trigger modules #include "AliMUONVGeometryDESegmentation.h" class AliMUONSegmentManuIndex; diff --git a/MUON/AliMUONTriggerTrack.h b/MUON/AliMUONTriggerTrack.h index 29698fad6e4..4c1fbe23f77 100644 --- a/MUON/AliMUONTriggerTrack.h +++ b/MUON/AliMUONTriggerTrack.h @@ -6,9 +6,13 @@ /*$Id$*/ // Revision of includes 07/05/2004 -/////////////////////////////////////////////////// -// Reconstructed trigger track in ALICE dimuon spectrometer -/////////////////////////////////////////////////// +/// \ingroup rec +/// \class AliMUONTrigger +/// \brief Reconstructed trigger track in ALICE dimuon spectrometer +/// +//////////////////////////////////////////////////////////// +/// Reconstructed trigger track in ALICE dimuon spectrometer +//////////////////////////////////////////////////////////// #include diff --git a/MUON/AliMUONVGeometryBuilder.h b/MUON/AliMUONVGeometryBuilder.h index 9b26948665c..be2dfe0e49f 100644 --- a/MUON/AliMUONVGeometryBuilder.h +++ b/MUON/AliMUONVGeometryBuilder.h @@ -3,12 +3,12 @@ // $Id$ // Revision of includes 07/05/2004 -// -// Class AliMUONVGeometryBuilder -// ----------------------------- -// Abstract base class for geometry construction per chamber(s). -// -// Author: Ivana Hrivnacova, IPN Orsay + +/// \ingroup geometry +/// \class AliMUONVGeometryBuilder +/// \brief Abstract base class for geometry construction per module(s) +/// +/// Author: Ivana Hrivnacova, IPN Orsay #ifndef ALI_MUON_V_GEOMETRY_BUILDER_H #define ALI_MUON_V_GEOMETRY_BUILDER_H diff --git a/MUON/AliMUONVGeometryDEIndexing.h b/MUON/AliMUONVGeometryDEIndexing.h index 3490f27ba13..21a5350609e 100644 --- a/MUON/AliMUONVGeometryDEIndexing.h +++ b/MUON/AliMUONVGeometryDEIndexing.h @@ -2,14 +2,16 @@ * See cxx source for full Copyright notice */ // $Id$ -// -// Class AliMUONVGeometryDEIndexing -// -------------------------------- -// The abstract singleton base class for definition of -// the conversion between the detection element Ids and -// the indexing in a simple array. -// -// Author: Ivana Hrivnacova, IPN Orsay + +/// \ingroup geometry +/// \class AliMUONVGeometryDEIndexing +/// \brief Base class for definition of detection elements indexing +/// +/// The abstract singleton base class for definition of +/// the conversion between the detection element Ids and +/// the indexing in a simple array. +/// +/// Author: Ivana Hrivnacova, IPN Orsay #ifndef ALI_MUON_V_GEOMETRY_DE_INDEXING_H #define ALI_MUON_V_GEOMETRY_DE_INDEXING_H diff --git a/MUON/AliMUONVGeometryDESegmentation.h b/MUON/AliMUONVGeometryDESegmentation.h index f002cd882af..4f108022a6d 100644 --- a/MUON/AliMUONVGeometryDESegmentation.h +++ b/MUON/AliMUONVGeometryDESegmentation.h @@ -3,15 +3,16 @@ /* $Id$ */ -// -// Class AliVMUONGeometryDESegmentation -// ---------------------------------- -// Extension for AliSegmentation interface, -// added functions: -// Bool_t HasPad(Float_t x, Float_t y, Float_t z); -// Bool_t HasPad(Int_t ix, Int_t iy); -// -// Author:Ivana Hrivnacova, IPN Orsay +/// \ingroup geometry +/// \class AliMUONVGeometryDESegmentation +/// \brief Extension for AliSegmentation interface for detection elements +/// +/// Extension for AliSegmentation interface, +/// added functions: \n +/// Bool_t HasPad(Float_t x, Float_t y, Float_t z); \n +/// Bool_t HasPad(Int_t ix, Int_t iy); \n +/// +/// Author:Ivana Hrivnacova, IPN Orsay #ifndef ALI_MUON_V_GEOMETRY_DE_SEGMENTATION_H #define ALI_MUON_V_GEOMETRY_DE_SEGMENTATION_H diff --git a/MUON/AliMUONv1.h b/MUON/AliMUONv1.h index ba1ca6cb917..1d4210d24cd 100644 --- a/MUON/AliMUONv1.h +++ b/MUON/AliMUONv1.h @@ -6,6 +6,10 @@ /* $Id$ */ // Revision of includes 07/05/2004 +/// \ingroup base +/// \class AliMUONv1 +/// \brief Manager and hits classes for set:MUON version 1 + ///////////////////////////////////////////////////////// // Manager and hits classes for set:MUON version 1 // ///////////////////////////////////////////////////////// -- 2.39.3