- Modified comment lines to be compatible with Doxygen
authorivana <ivana@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 22 Sep 2005 11:12:40 +0000 (11:12 +0000)
committerivana <ivana@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 22 Sep 2005 11:12:40 +0000 (11:12 +0000)
  (brief class description, ingroup directive;
   member function comments in geometry classes)
- Added Copyright, CVS Id where missing

102 files changed:
MUON/AliMUON.h
MUON/AliMUONChamber.h
MUON/AliMUONChamberTrigger.h
MUON/AliMUONClusterFinderAZ.h
MUON/AliMUONClusterFinderVS.h
MUON/AliMUONClusterInput.h
MUON/AliMUONClusterReconstructor.h
MUON/AliMUONCommonGeometryBuilder.cxx
MUON/AliMUONCommonGeometryBuilder.h
MUON/AliMUONConstants.h
MUON/AliMUONDDLTracker.h
MUON/AliMUONDDLTrigger.h
MUON/AliMUONData.h
MUON/AliMUONDataInterface.h
MUON/AliMUONDigit.h
MUON/AliMUONDigitizer.h
MUON/AliMUONDigitizerv2.h
MUON/AliMUONDisplay.h
MUON/AliMUONFactoryV2.h
MUON/AliMUONFactoryV3.h
MUON/AliMUONGeometryBuilder.cxx
MUON/AliMUONGeometryBuilder.h
MUON/AliMUONGeometryConstituent.cxx
MUON/AliMUONGeometryConstituent.h
MUON/AliMUONGeometryDEIndexing.cxx
MUON/AliMUONGeometryDEIndexing.h
MUON/AliMUONGeometryDetElement.cxx
MUON/AliMUONGeometryDetElement.h
MUON/AliMUONGeometryDirection.h
MUON/AliMUONGeometryEnvelope.cxx
MUON/AliMUONGeometryEnvelope.h
MUON/AliMUONGeometryEnvelopeStore.cxx
MUON/AliMUONGeometryEnvelopeStore.h
MUON/AliMUONGeometryModule.cxx
MUON/AliMUONGeometryModule.h
MUON/AliMUONGeometrySVMap.cxx
MUON/AliMUONGeometrySVMap.h
MUON/AliMUONGeometrySegmentation.cxx
MUON/AliMUONGeometrySegmentation.h
MUON/AliMUONGeometryStore.cxx
MUON/AliMUONGeometryStore.h
MUON/AliMUONGlobalTrigger.h
MUON/AliMUONHit.h
MUON/AliMUONHitForRec.h
MUON/AliMUONHitMapA1.h
MUON/AliMUONLoader.h
MUON/AliMUONLocalTrigger.h
MUON/AliMUONMathieson.h
MUON/AliMUONPixel.h
MUON/AliMUONPoints.h
MUON/AliMUONRawCluster.h
MUON/AliMUONRawData.h
MUON/AliMUONRawStream.h
MUON/AliMUONRecoCheck.h
MUON/AliMUONRecoTrack.h
MUON/AliMUONReconstructor.h
MUON/AliMUONResponse.h
MUON/AliMUONResponseTrigger.h
MUON/AliMUONResponseTriggerV1.h
MUON/AliMUONResponseV0.h
MUON/AliMUONSDigitizerv1.h
MUON/AliMUONScalerEventTrigger.h
MUON/AliMUONSegment.h
MUON/AliMUONSegmentIndex.h
MUON/AliMUONSegmentManuIndex.h
MUON/AliMUONSegmentPosition.h
MUON/AliMUONSegmentationDetectionElement.h
MUON/AliMUONSegmentationManager.h
MUON/AliMUONSlatGeometryBuilder.h
MUON/AliMUONSt12QuadrantSegmentation.h
MUON/AliMUONSt1Decoder.h
MUON/AliMUONSt1ElectronicElement.h
MUON/AliMUONSt1GeometryBuilder.h
MUON/AliMUONSt1IniReader.h
MUON/AliMUONSt1Response.h
MUON/AliMUONSt1ResponseParameter.h
MUON/AliMUONSt1ResponseRule.h
MUON/AliMUONSt1SpecialMotif.h
MUON/AliMUONSt2GeometryBuilder.h
MUON/AliMUONSt2GeometryBuilderV2.h
MUON/AliMUONSt345SlatSegmentation.h
MUON/AliMUONSt345SlatSegmentationV2.h
MUON/AliMUONSubEventTracker.h
MUON/AliMUONSubEventTrigger.h
MUON/AliMUONTest.h
MUON/AliMUONTrack.h
MUON/AliMUONTrackHit.h
MUON/AliMUONTrackK.h
MUON/AliMUONTrackParam.h
MUON/AliMUONTrackReconstructor.h
MUON/AliMUONTransientDigit.h
MUON/AliMUONTriggerCircuit.h
MUON/AliMUONTriggerConstants.h
MUON/AliMUONTriggerDecision.h
MUON/AliMUONTriggerGeometryBuilder.h
MUON/AliMUONTriggerLut.h
MUON/AliMUONTriggerSegmentation.h
MUON/AliMUONTriggerTrack.h
MUON/AliMUONVGeometryBuilder.h
MUON/AliMUONVGeometryDEIndexing.h
MUON/AliMUONVGeometryDESegmentation.h
MUON/AliMUONv1.h

index de3695d..4e63afa 100644 (file)
@@ -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      //
 ////////////////////////////////////////////////
index 22c1f14..f8a013f 100644 (file)
@@ -5,6 +5,10 @@
 
 /* $Id$ */
 // Revision of includes 07/05/2004
+//
+/// \ingroup base
+/// \class AliMUONChamber
+/// \brief MUON tracking chamber class
 
 #include <TObject.h>
 #include <TObjArray.h>
index de4a526..ac410c7 100644 (file)
@@ -6,6 +6,10 @@
 
 /* $Id$ */
 // Revision of includes 07/05/2004
+//
+/// \ingroup base
+/// \class AliMUONChamberTrigger
+/// \brief Muon trigger chamber class
 
 #include "AliMUONChamber.h"
 
index 5544ebc..d046e1f 100644 (file)
@@ -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;
index d3ccb5c..8dfe502 100644 (file)
@@ -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 <TObject.h>
 
index 97d443c..970f48c 100644 (file)
@@ -6,6 +6,10 @@
 /* $Id $*/
 // Revision of includes 07/05/2004
 
+/// \ingroup rec
+/// \class AliMUONClusterInput
+/// \brief Global data service for hit reconstruction
+
 #include <TObject.h>
 #include <TClonesArray.h> // needed for inline function Digit
 #include "AliMUONGeometrySegmentation.h"
index 812859c..087c85f 100644 (file)
@@ -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 <TObject.h>
 #include "AliMUONClusterFinderVS.h" //AZ
index cc43617..76ceb15 100644 (file)
@@ -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%)
index 44e439e..55bf37f 100644 (file)
@@ -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
 };
index 65ef052..53e30d1 100644 (file)
@@ -5,6 +5,10 @@
 
 /* $Id$*/
 // Revision of includes 07/05/2004
+//
+/// \ingroup base
+/// \class AliMUONConstants
+/// \brief MUON global constants
 
 #include <TObject.h>
 
index d768d34..2d81149 100644 (file)
@@ -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 <TObject.h>
 #include "AliRawDataHeader.h"
index 52f370f..907b239 100644 (file)
@@ -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 <TObject.h>
 #include "AliRawDataHeader.h"
index 350c0c7..d7af645 100644 (file)
@@ -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 <TNamed.h>
 #include <TArrayI.h>
index 0768793..76c926d 100644 (file)
@@ -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
index bdf7539..e8af975 100644 (file)
@@ -6,6 +6,10 @@
 /* $Id$ */
 // Revision of includes 07/05/2004
 
+/// \ingroup base
+/// \class AliMUONDigit
+/// \brief MUON digit
+
 #include <TObject.h>
 
 static const Int_t kMAXTRACKS=10;
index 6f17812..7ba0243 100644 (file)
@@ -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"
 
index 1a5d1d5..ef1ad9b 100644 (file)
@@ -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"
 
index aa0db66..7d70669 100644 (file)
@@ -7,6 +7,10 @@
 /* $Id$ */
 // Revision of includes 07/05/2004
 
+/// \ingroup base
+/// \class AliMUONDisplay
+/// \brief Utility class to display MUON events
+
 //////////////////////////////////////////////////////////////////////////
 //                                                                      //
 // AliDisplay                                                           //
index 9da6437..a7e5dc8 100644 (file)
@@ -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 <TObject.h>
index 8adefbc..22bd8b3 100644 (file)
@@ -5,6 +5,10 @@
 
 /* $Id$ */
 
+/// \ingroup sim
+/// \class AliMUONFactoryV3
+/// \brief Factory for muon chambers, segmentations and response
+///
 ////////////////////////////////////////////////////////////
 //  Factory for muon chambers, segmentations and response 
 ////////////////////////////////////////////////////////////
index 2cfd668..35f773d 100644 (file)
@@ -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; j<builder->NofGeometries(); 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; i<fGeometryBuilders->GetEntriesFast(); 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; i<fGeometryBuilders->GetEntriesFast(); 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; i<fGeometryBuilders->GetEntriesFast(); 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; i<fGeometryBuilders->GetEntriesFast(); 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; 
 
index c27774f..4763561 100644 (file)
@@ -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
index 241a4ab..88ef8c5 100644 (file)
@@ -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;
 
index f7b9f9a..72c77ce 100644 (file)
@@ -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
index dd4caa7..4a8563b 100644 (file)
@@ -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.");
index 80b227b..d088faa 100644 (file)
@@ -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
index c72e2cf..1ad1313 100644 (file)
@@ -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);
 }  
index 0272f9d..6c0ab42 100644 (file)
@@ -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
index 91f495e..fdb3cdc 100644 (file)
@@ -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
index 1020152..f92f689 100644 (file)
@@ -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<Double_t*>(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<Double_t*>(rotation.GetRotationMatrix()));
index 7258c3b..fea08d3 100644 (file)
@@ -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
index 1f7daac..6366470 100644 (file)
@@ -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; i<fEnvelopes->GetEntriesFast(); 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;
   
index a605745..15ae23f 100644 (file)
@@ -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
index 1ce97ca..3f8fa95 100644 (file)
@@ -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; i<fNofSVs; i++) {
       if (fSVVolumeIds->At(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<Double_t*>(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<Double_t*>(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; i<fNofSVs; i++) {
       if (fSVVolumeIds->At(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);
-}   
-*/
index 5dda980..f0997ce 100644 (file)
@@ -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
index 2149e88..d7881ac 100644 (file)
@@ -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; i<fNofItems; i++) {
     if ( ((TObjString*)fFirstArray.At(i))->GetString() == 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; i<fNofItems; i++) {
     cout << setw(4)
@@ -181,7 +185,7 @@ AliMUONGeometrySVMap::AliMUONGeometrySVMap(Int_t initSize)
    fSVMap(),
    fSVPositions(initSize)
 { 
-// Standard constructor
+/// Standard constructor
   
   fSVPositions.SetOwner(true);
 }
@@ -192,19 +196,23 @@ AliMUONGeometrySVMap::AliMUONGeometrySVMap()
    fSVMap(),
    fSVPositions()
 {
-// Default constructor
+/// Default constructor
 }
 
 //______________________________________________________________________________
 AliMUONGeometrySVMap::AliMUONGeometrySVMap(const AliMUONGeometrySVMap& rhs)
   : TObject(rhs)
 {
+/// Protected copy constructor
+
   AliFatal("Copy constructor is not implemented.");
 }
 
 //______________________________________________________________________________
-AliMUONGeometrySVMap::~AliMUONGeometrySVMap() {
-//
+AliMUONGeometrySVMap::~AliMUONGeometrySVMap() 
+{
+/// Destructor
+
   fSVPositions.Delete();
 }
 
@@ -212,6 +220,8 @@ AliMUONGeometrySVMap::~AliMUONGeometrySVMap() {
 AliMUONGeometrySVMap& 
 AliMUONGeometrySVMap::operator = (const AliMUONGeometrySVMap& rhs) 
 {
+/// Protected assignement operator
+
   // check assignement to self
   if (this == &rhs) return *this;
 
@@ -228,8 +238,7 @@ AliMUONGeometrySVMap::operator = (const AliMUONGeometrySVMap& rhs)
 const TGeoCombiTrans* 
 AliMUONGeometrySVMap::FindByName(const TString& name) const
 {
-// Finds TGeoCombiTrans in the array of positions by name 
-// ---
+/// Find TGeoCombiTrans in the array of positions by name 
 
   for (Int_t i=0; i<fSVPositions.GetEntriesFast(); i++) { 
      TGeoCombiTrans* transform = (TGeoCombiTrans*) fSVPositions.At(i);
@@ -249,9 +258,8 @@ AliMUONGeometrySVMap::FindByName(const TString& name) const
 void AliMUONGeometrySVMap::Add(const TString& volumePath, 
                                Int_t detElemId)
 {
-// Add the specified sensitive volume path and the detElemId 
-// to the map
-// ---
+/// Add the specified sensitive volume path and the detElemId 
+/// to the map
  
   fSVMap.Add(volumePath, detElemId);
 }                        
@@ -260,9 +268,8 @@ void AliMUONGeometrySVMap::Add(const TString& volumePath,
 void AliMUONGeometrySVMap::AddPosition(const TString& volumePath, 
                               const TGeoTranslation& globalPosition)
 {
-// Add global position for the sensitive volume specified by volumePath  
-// in the array of transformations if this volumePath is not yet present. 
-// ---
+/// Add global position for the sensitive volume specified by volumePath  
+/// in the array of transformations if this volumePath is not yet present. 
  
   TGeoTranslation* newTransform = new TGeoTranslation(globalPosition);
   Int_t detElemId = fSVMap.Get(volumePath);
@@ -296,7 +303,7 @@ void AliMUONGeometrySVMap::Clear(Option_t* /*option*/)
 //______________________________________________________________________________
 void AliMUONGeometrySVMap::ClearPositions()
 {
-// Clears the array of transformations
+/// Clear the array of transformations
 
   fSVPositions.Delete();
 }  
@@ -304,8 +311,7 @@ void AliMUONGeometrySVMap::ClearPositions()
 //______________________________________________________________________________
 void AliMUONGeometrySVMap::SortPositions()
 {
-// Sort the array of positions by names.
-// ---
+/// Sort the array of positions by names.
 
   fSVPositions.Sort(fSVPositions.GetEntriesFast());
 }
@@ -313,8 +319,7 @@ void AliMUONGeometrySVMap::SortPositions()
 //______________________________________________________________________________
 void  AliMUONGeometrySVMap::Print(const char* option) const
 {    
-// Prints the map of sensitive volumes and detector elements 
-// ---
+/// Print the map of sensitive volumes and detector elements 
 
   fSVMap.Print(option);
 }  
@@ -322,8 +327,7 @@ void  AliMUONGeometrySVMap::Print(const char* option) const
 //______________________________________________________________________________
 void  AliMUONGeometrySVMap::PrintPositions() const
 {
-// Prints the sensitive volumes global positions
-// ---
+/// Print the sensitive volumes global positions
 
   for (Int_t i=0; i<fSVPositions.GetEntriesFast(); i++) {
     
@@ -350,9 +354,8 @@ void  AliMUONGeometrySVMap::PrintPositions() const
 //______________________________________________________________________________
 void  AliMUONGeometrySVMap::WriteMap(ofstream& out) const
 {    
-// Prints the map of sensitive volumes and detector elements 
-// into specified stream
-// ---
+/// Print the map of sensitive volumes and detector elements 
+/// into specified stream
 
   fSVMap.Print("SV", out);
 }  
@@ -360,8 +363,7 @@ void  AliMUONGeometrySVMap::WriteMap(ofstream& out) const
 //______________________________________________________________________________
 Int_t  AliMUONGeometrySVMap::GetDetElemId(const TString& volumePath) const
 {
-// Returns detection element Id for the sensitive volume specified by path
-// ---
+/// Return detection element Id for the sensitive volume specified by path
 
   return fSVMap.Get(volumePath);
 }  
index a512e57..435a01c 100644 (file)
@@ -2,21 +2,23 @@
  * See cxx source for full Copyright notice                               */
 
 // $Id$
-//
-// Class AliMUONGeometrySVMap
-// --------------------------
-// As the detection element frame is different from the
-// frame of the sensitive volume(s) defined in Geant,
-// the sensitive volumes have to be mapped to the detection 
-// elements. In the map, fSVMap, the sensitive voolumes are specified
-// by the full path in the volume hierarchy, defined as:
-//  /volname.copyNo/volName.copyNo1/...
-//
-// The array of global positions of sensitive volumes fSVPositions
-// is included to make easier the verification of the assignements 
-// in the fSVMap.
-//
-// Author: Ivana Hrivnacova, IPN Orsay
+
+/// \ingroup geometry
+/// \class AliMUONGeometrySVMap
+/// \brief Map between sensitive volumes and detection element Ids
+///
+/// As the detection element frame is different from the
+/// frame of the sensitive volume(s) defined in Geant,
+/// the sensitive volumes have to be mapped to the detection 
+/// elements. In the map, fSVMap, the sensitive voolumes are specified
+/// by the full path in the volume hierarchy, defined as:
+///  /volname.copyNo/volName.copyNo1/...
+///
+/// The array of global positions of sensitive volumes fSVPositions
+/// is included to make easier the verification of the assignements 
+/// in the fSVMap.
+///
+/// Author: Ivana Hrivnacova, IPN Orsay
 
 #ifndef ALI_MUON_GEOMETRY_SV_MAP_H
 #define ALI_MUON_GEOMETRY_SV_MAP_H
index 9c30f9f..51defc9 100644 (file)
@@ -49,7 +49,7 @@ AliMUONGeometrySegmentation::AliMUONGeometrySegmentation(
   fDESegmentations(0)
   
 {
-// Normal constructor
+/// Standard constructor
 
   fDESegmentations 
     = new AliMUONGeometryStore(geometry->GetDEIndexing(), 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; i<fDESegmentations->GetNofEntries(); 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; i<fDESegmentations->GetNofEntries(); 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; i<fDESegmentations->GetNofEntries(); 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;
 
index 819b34e..65c0b78 100644 (file)
@@ -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
index b449d35..d086035 100644 (file)
@@ -43,7 +43,7 @@ AliMUONGeometryStore::AliMUONGeometryStore(
    fObjects(fgkInitSize),
    fDEIndexing(indexing)
 { 
-// Standard constructor
+/// Standard constructor
   
   fObjects.SetOwner(isOwner);
   for (Int_t i=0; i<fgkInitSize; i++) fObjects[i] = 0;
@@ -55,20 +55,22 @@ AliMUONGeometryStore::AliMUONGeometryStore()
    fObjects(),
    fDEIndexing(0)
 {
-// Default constructor
+/// Default constructor
 }
 
 //______________________________________________________________________________
-AliMUONGeometryStore::AliMUONGeometryStore(
-                                   const AliMUONGeometryStore& rhs)
+AliMUONGeometryStore::AliMUONGeometryStore(const AliMUONGeometryStore& rhs)
   : TObject(rhs)
 {
+/// Protected copy constructor
+
   AliFatal("Copy constructor is not implemented.");
 }
 
 //______________________________________________________________________________
 AliMUONGeometryStore::~AliMUONGeometryStore() 
 {
+/// Destructor
 
 }
 
@@ -76,7 +78,9 @@ AliMUONGeometryStore::~AliMUONGeometryStore()
 AliMUONGeometryStore& 
 AliMUONGeometryStore::operator = (const AliMUONGeometryStore& rhs) 
 {
-  // check assignement to self
+/// Protected assignment operator 
+
+ // check assignement to self
   if (this == &rhs) return *this;
 
   AliFatal("Assignment operator is not implemented.");
@@ -91,9 +95,8 @@ AliMUONGeometryStore::operator = (const AliMUONGeometryStore& rhs)
 //______________________________________________________________________________
 void AliMUONGeometryStore::Add(Int_t objectId, TObject* object)
 {
-// Add detection element in the array
-// if detection element with the same Id is not yet present. 
-// ---
+/// Add detection element in the array
+/// if detection element with the same Id is not yet present. 
  
   //cout << ".. adding " << objectId 
   //     << " index: " << fDEIndexing->GetDetElementIndex(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);
 }  
index 32d8cad..736062d 100644 (file)
@@ -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
index e117a68..139dc81 100644 (file)
@@ -7,6 +7,10 @@
 /* $Id$ */
 // Revision of includes 07/05/2004
 
+/// \ingroup base
+/// \class AliMUONGlobalTrigger
+/// \brief Reconstructed global trigger object
+
 #include <TObject.h>
 
 class AliMUONGlobalTrigger : public TObject {
index d093fbf..06f8d82 100644 (file)
@@ -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"
index 83a15f9..d45e53c 100644 (file)
@@ -6,6 +6,10 @@
 /*$Id$*/
 // Revision of includes 07/05/2004
 
+/// \ingroup rec
+/// \class AliMUONHitForRec
+/// \brief Hit for reconstruction in ALICE dimuon spectrometer
+
 #include <TObject.h>
 
 class AliTrackReference;
index 08d358f..ea0da7b 100644 (file)
@@ -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;
index c3f00be..b6af2a3 100644 (file)
@@ -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"
 
index 8296831..3b068c5 100644 (file)
@@ -7,6 +7,10 @@
 /* $Id$ */
 // Revision of includes 07/05/2004
 
+/// \ingroup base
+/// \class AliMUONLocalTrigger
+/// \brief Reconstructed Local Trigger object
+
 #include <TObject.h>
 #include <TArrayI.h>
 
index ef8d4d5..dbed0a6 100644 (file)
@@ -5,6 +5,10 @@
 
 /* $Id$ */
 // Revision of includes 07/05/2004
+//
+/// \ingroup base
+/// \class AliMUONMathieson
+/// \brief Implementation of Mathieson response
 
 class AliMUONGeometrySegmentation;
 
index 09def66..4097343 100644 (file)
@@ -6,6 +6,10 @@
 /* $Id$ */
 // Revision of includes 07/05/2004
 
+/// \ingroup rec
+/// \class AliMUONPixel
+/// \brief Pixel for MLEM method of cluster finding
+
 #include <TObject.h>
 
 class AliMUONPixel : public TObject {
index a320b57..3628a92 100644 (file)
@@ -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"
 
index 36a1380..8bab9a0 100644 (file)
@@ -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 <TObject.h>
index 3f945b7..7d06af4 100644 (file)
@@ -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 <map>
-#include <vector>
+/*$Id$*/
+
+/// \ingroup rec
+/// \class AliMUONRawData
+/// \brief Raw data class for trigger and tracker chambers
+///
+/// Raw data class for trigger and tracker chambers
+
 #include <TObject.h>
 #include <TExMap.h>
 #include "AliMUONSubEventTracker.h"
index 2fcaccc..44acef0 100644 (file)
@@ -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.
 ///
 ///////////////////////////////////////////////////////////////////////////////
 
index e2a56df..28d3cc3 100644 (file)
@@ -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                                                     //
index adf11ba..211ae84 100644 (file)
@@ -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 <TObject.h>
 #include <TMath.h>
index 91c0b26..9cae935 100644 (file)
@@ -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 
index 30c7ae5..71b5319 100644 (file)
@@ -6,6 +6,10 @@
 /* $Id$ */
 // Revision of includes 07/05/2004
 
+/// \ingroup sim
+/// \class AliMUONResponse
+/// \brief Chamber response base class
+
 #include <TObject.h>
 
 class TF1;
index 3485136..868cb51 100644 (file)
@@ -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
index f1a1b1c..394ed98 100644 (file)
@@ -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 
index 94f3fe5..e4cb526 100644 (file)
@@ -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"
 
index a075ce0..7632425 100644 (file)
@@ -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
 
index 6dd5b63..70cd086 100644 (file)
@@ -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 <TObject.h>
 
index f91c386..e0050d8 100644 (file)
@@ -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 <TObject.h>
 
index c91fc06..c2359cc 100644 (file)
@@ -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                
index ed80474..ac5ce68 100644 (file)
@@ -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                
index e431eb2..5636713 100644 (file)
@@ -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
index d7feb8b..a42d5ac 100644 (file)
@@ -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                
index f9fb974..50b526f 100644 (file)
@@ -6,6 +6,10 @@
 
 /* $Id$ */
 
+/// \ingroup base
+/// \class AliMUONSegmentationManager
+/// \brief Segmentation manager
+
 #ifndef ROOT_TObject
 #include "TObject.h"
 #endif
index f208d05..c286519 100644 (file)
@@ -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
index cf5bccd..cff3da8 100644 (file)
@@ -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 
index 1b7164d..c4d04ae 100644 (file)
@@ -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 <decoder> 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 <decoder> 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 <Rtypes.h>
 #include <string>
index b5cfa47..08761d3 100644 (file)
@@ -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 <TObject.h>
 
index b8d8edb..988a69a 100644 (file)
@@ -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
index d182a30..647a750 100644 (file)
@@ -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 <string>
index 72784e3..5789938 100644 (file)
@@ -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 <map>
 #include <string>
index d86cda8..ce93659 100644 (file)
@@ -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 <TNamed.h>
 
index 0a12c62..4a6347c 100644 (file)
@@ -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 <TObject.h>
 #include <TList.h>
index 1cd2e04..48c3c07 100644 (file)
@@ -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 <TVector2.h>
 
index 985220a..128aa2b 100644 (file)
@@ -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
index 97b1626..60fbedc 100644 (file)
@@ -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
index 47f474d..4be7502 100644 (file)
@@ -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"
 
index b441b0a..b55661e 100644 (file)
@@ -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
index 08b1e1a..d2a60f4 100644 (file)
@@ -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 <TObject.h>
 
index 98cc2ef..13e6c34 100644 (file)
@@ -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 <TObject.h>
 
index f0ba662..f594d3c 100644 (file)
@@ -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
index d8ea82a..128d7f0 100644 (file)
@@ -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 <TClonesArray.h>
 
index c83c541..d2f4d56 100644 (file)
@@ -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 <TObject.h>
 #include "AliMUONTrackParam.h" // object belongs to the class
index 6d489cb..c500d12 100644 (file)
@@ -6,6 +6,10 @@
 /*$Id$*/
 // Revision of includes 07/05/2004
 
+/// \ingroup rec
+/// \class AliMUONTrack
+/// \brief Kalman track in MUON arm of ALICE
+
 #include <TObject.h>
 #include "AliMUONTrack.h" //AZ
 
index 8eda2da..3fadeaa 100644 (file)
@@ -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 <TObject.h>
 
index f9e1de1..473835f 100644 (file)
@@ -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 <TObject.h>
 #include "AliMUONConstants.h"
index 2320871..47e8019 100644 (file)
@@ -7,6 +7,10 @@
 /* $Id$ */
 // Revision of includes 07/05/2004
 
+/// \ingroup base
+/// \class AliMUONTransientDigit
+/// \brief MUON transient digit
+
 #include "AliMUONDigit.h"
 
 class TObjArray;
index cbf2f34..2b0d417 100644 (file)
@@ -5,12 +5,14 @@
 
 /* $Id$ */
 // Revision of includes 07/05/2004
+//
+/// \ingroup base
+/// \class AliMUONTriggerCircuit
+/// \brief MUON Trigger circuit
 
 #include <TObject.h>
 #include <TObjArray.h>
 
-class AliMUONGeometrtSegmentation;
-
 class TObjArray;
 
 class AliMUONTriggerCircuit : public TObject 
index d943954..3b35149 100644 (file)
@@ -6,6 +6,10 @@
 
 /* $Id$ */
 // Revision of includes 07/05/2004
+//
+/// \ingroup base
+/// \class AliMUONTriggerConstants
+/// \brief MUON Trigger constants
 
 #include <TNamed.h>
 
index c7db631..dc6b3c2 100644 (file)
@@ -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 <TObject.h>
 #include "AliMUONLocalTrigger.h"
index 4aa6ec8..f0f924e 100644 (file)
@@ -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
index 8d81fe4..bf9810a 100644 (file)
@@ -6,6 +6,10 @@
 /* $Id$ */
 // Revision of includes 07/05/2004
 
+/// \ingroup base
+/// \class AliMUONTriggerLut
+/// \brief MUON trigger look up table class 
+
 #include <TNamed.h>
 
 class TH3S;
index 6c09c0d..91c4e02 100644 (file)
@@ -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;
index 29698fa..4c1fbe2 100644 (file)
@@ -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 <TObject.h>
 
index 9b26948..be2dfe0 100644 (file)
@@ -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
index 3490f27..21a5350 100644 (file)
@@ -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
index f002cd8..4f10802 100644 (file)
@@ -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
index ba1ca6c..1d4210d 100644 (file)
@@ -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    //
 /////////////////////////////////////////////////////////