ALIROOT-5420 Changes for CDH v3

[u/mrichter/AliRoot.git] / MUON / AliMUONGeometryModule.h

diff --git a/MUON/AliMUONGeometryModule.h b/MUON/AliMUONGeometryModule.h
index b017d021dad96d735f5a1dd5be24b17a509cfd94..dce48e7ce24945d9b07665703f9f22b96f4d9659 100644 (file)
--- a/MUON/AliMUONGeometryModule.h
+++ b/MUON/AliMUONGeometryModule.h
@@ -12,7 +12,7 @@
 /// (the transformations of detection elements, mapping between
 ///  sensitive volumes and detection elements).
 ///
-/// Author: Ivana Hrivnacova, IPN Orsay
+/// \author Ivana Hrivnacova, IPN Orsay
 
 #ifndef ALI_MUON_GEOMETRY_MODULE_H
 #define ALI_MUON_GEOMETRY_MODULE_H
@@ -25,7 +25,6 @@
 class AliMUONGeometryEnvelope;
 class AliMUONGeometryEnvelopeStore;
 class AliMUONGeometryDetElement;
-class AliMUONGeometryStore;
 class AliMUONStringIntMap;
 
 class TGeoTranslation;
@@ -67,7 +66,9 @@ class AliMUONGeometryModule : public TObject
     AliMUONGeometryModuleTransformer* GetTransformer() const;
 
   protected:
+    /// Not implemented
     AliMUONGeometryModule(const AliMUONGeometryModule& rhs);
+    /// Not implemented
     AliMUONGeometryModule& operator = (const AliMUONGeometryModule& rhs);
 
   private:
@@ -75,40 +76,47 @@ class AliMUONGeometryModule : public TObject
     Int_t  GetSVIndex(Int_t svVolId) const; 
   
     // data members
-    Bool_t           fIsVirtual;     // true if module is not represented
-                                     // by a real volume
-    Int_t            fNofSVs;        // number of sensitive volumes   
-    TArrayI*         fSVVolumeIds;   // sensitive volumes IDs  
-
-    AliMUONGeometryEnvelopeStore*     fEnvelopes;  // envelopes                                 
-    AliMUONStringIntMap*              fSVMap;      // sensitive volumes map
-    AliMUONGeometryModuleTransformer* fTransformer;// geometry transformations
+    Bool_t           fIsVirtual;     ///< \brief true if module is not represented
+                                     /// by a real volume
+    Int_t            fNofSVs;        ///< number of sensitive volumes   
+    TArrayI*         fSVVolumeIds;   ///< sensitive volumes IDs  
+
+    AliMUONGeometryEnvelopeStore*     fEnvelopes;  ///< envelopes                                 
+    AliMUONStringIntMap*              fSVMap;      ///< sensitive volumes map
+    AliMUONGeometryModuleTransformer* fTransformer;///< geometry transformations
  
   ClassDef(AliMUONGeometryModule,4) // MUON geometry module class
 };
 
 // inline functions
 
+/// Set virtuality (true if module is not represented by a real volume)
 inline void  AliMUONGeometryModule::SetIsVirtual(Bool_t isVirtual)
 { fIsVirtual = isVirtual; }
 
+/// Return true if module is not represented by a real volume
 inline Bool_t AliMUONGeometryModule::IsVirtual() const
 { return fIsVirtual; }  
 
+/// Return module ID
 inline Int_t  AliMUONGeometryModule::GetModuleId() const
 { return fTransformer->GetModuleId(); }
 
+/// Return the full path of aligned module volume or envelope in geometry
 inline TString AliMUONGeometryModule::GetVolumePath() const
 { return fTransformer->GetVolumePath(); }
 
+/// Return envelopes associated with this module
 inline  
 AliMUONGeometryEnvelopeStore* AliMUONGeometryModule::GetEnvelopeStore() const
 { return fEnvelopes; }
 
+/// Return sensitive volume map
 inline 
 AliMUONStringIntMap* AliMUONGeometryModule::GetSVMap() const
 { return fSVMap; }
 
+/// Return transformer
 inline 
 AliMUONGeometryModuleTransformer* AliMUONGeometryModule::GetTransformer() const
 { return fTransformer; }