- Modified comment lines to be compatible with Doxygen

[u/mrichter/AliRoot.git] / MUON / AliMUONGeometryEnvelope.cxx

diff --git a/MUON/AliMUONGeometryEnvelope.cxx b/MUON/AliMUONGeometryEnvelope.cxx
index 102015268468e85464d48edea8ba12d2f39401ab..f92f689815ced651079c29cf6cbf30192379814f 100644 (file)
--- a/MUON/AliMUONGeometryEnvelope.cxx
+++ b/MUON/AliMUONGeometryEnvelope.cxx
@@ -43,7 +43,7 @@ AliMUONGeometryEnvelope::AliMUONGeometryEnvelope(const TString& name,
    fTransformation(0),
    fConstituents(0)
 {
-// Standard constructor
+/// Standard constructor
 
   if (TString(only) == TString("MANY")) fIsMANY = true;
 
@@ -68,7 +68,8 @@ AliMUONGeometryEnvelope::AliMUONGeometryEnvelope(const TString& name,
    fTransformation(0),
    fConstituents(0)
 {
-// Standard constructor
+/// Standard constructor for a non virtual enevelope with a specified copy 
+/// number
 
   if (TString(only) == TString("MANY")) fIsMANY = true;
 
@@ -90,7 +91,7 @@ AliMUONGeometryEnvelope::AliMUONGeometryEnvelope()
    fTransformation(0),
    fConstituents(0)
 {
-// Default constructor
+/// Default constructor
 }
 
 
@@ -99,13 +100,16 @@ AliMUONGeometryEnvelope::AliMUONGeometryEnvelope(
                                         const AliMUONGeometryEnvelope& rhs)
   : TNamed(rhs)
 {
+/// Protected copy constructor
+
   AliFatal("Copy constructor is not implemented.");
 }
 
 //______________________________________________________________________________
 AliMUONGeometryEnvelope::~AliMUONGeometryEnvelope() 
 {
-//
+/// Destructor
+
   // Add deleting rotation matrices 
   
   delete fTransformation;
@@ -120,6 +124,8 @@ AliMUONGeometryEnvelope::~AliMUONGeometryEnvelope()
 AliMUONGeometryEnvelope& 
 AliMUONGeometryEnvelope::operator = (const AliMUONGeometryEnvelope& rhs) 
 {
+/// Protected assignement operator
+
   // check assignement to self
   if (this == &rhs) return *this;
 
@@ -135,9 +141,8 @@ AliMUONGeometryEnvelope::operator = (const AliMUONGeometryEnvelope& rhs)
 //______________________________________________________________________________
 void  AliMUONGeometryEnvelope::AddConstituent(const TString& name, Int_t copyNo) 
 {
-// Adds the volume with the specified name and transformation
-// to the list of envelopes.
-// ---                                            
+/// Add the volume with the specified name and transformation
+/// to the list of envelopes.
 
   fConstituents->Add(new AliMUONGeometryConstituent(name, copyNo, 0, 0));
 }
@@ -146,9 +151,8 @@ void  AliMUONGeometryEnvelope::AddConstituent(const TString& name, Int_t copyNo)
 void  AliMUONGeometryEnvelope::AddConstituent(const TString& name, Int_t copyNo, 
                                           const TGeoTranslation& translation)
 {
-// Adds the volume with the specified name and transformation
-// to the list of envelopes.
-// ---                                            
+/// Add the volume with the specified name and transformation
+/// to the list of envelopes.
 
   fConstituents
     ->Add(new AliMUONGeometryConstituent(name, copyNo, translation, 0, 0));
@@ -159,9 +163,8 @@ void  AliMUONGeometryEnvelope::AddConstituent(const TString& name, Int_t copyNo,
                                           const TGeoTranslation& translation,
                                          const TGeoRotation& rotation)
 {
-// Adds the volume with the specified name and transformation
-// to the list of envelopes.
-// ---                                            
+/// Add the volume with the specified name and transformation
+/// to the list of envelopes.
 
   fConstituents
     ->Add(new AliMUONGeometryConstituent(
@@ -172,9 +175,8 @@ void  AliMUONGeometryEnvelope::AddConstituent(const TString& name, Int_t copyNo,
 void  AliMUONGeometryEnvelope::AddConstituent(const TString& name, Int_t copyNo,
                                           const TGeoCombiTrans& transform )
 {
-// Adds the volume with the specified name and transformation
-// to the list of envelopes.
-// ---                                            
+/// Add the volume with the specified name and transformation
+/// to the list of envelopes.
 
   fConstituents
     ->Add(new AliMUONGeometryConstituent(
@@ -185,9 +187,8 @@ void  AliMUONGeometryEnvelope::AddConstituent(const TString& name, Int_t copyNo,
 void  AliMUONGeometryEnvelope::AddConstituentParam(const TString& name, 
                                   Int_t copyNo, Int_t npar, Double_t* param) 
 {
-// Adds the volume with the specified name and transformation
-// to the list of envelopes.
-// ---                                            
+/// Add the volume with the specified name and transformation
+/// to the list of envelopes.
 
   fConstituents
     ->Add(new AliMUONGeometryConstituent(name, copyNo, npar, param));
@@ -198,9 +199,8 @@ void  AliMUONGeometryEnvelope::AddConstituentParam(const TString& name,
                                   Int_t copyNo, const TGeoTranslation& translation,
                                  Int_t npar, Double_t* param)
 {
-// Adds the volume with the specified name and transformation
-// to the list of envelopes.
-// ---                                            
+/// Add the volume with the specified name and transformation
+/// to the list of envelopes.
 
   fConstituents
     ->Add(new AliMUONGeometryConstituent(
@@ -213,9 +213,8 @@ void  AliMUONGeometryEnvelope::AddConstituentParam(const TString& name,
                                  const TGeoRotation& rotation, 
                                  Int_t npar, Double_t* param)
 {
-// Adds the volume with the specified name and transformation
-// to the list of envelopes.
-// ---                                            
+/// Add the volume with the specified name and transformation
+/// to the list of envelopes.
 
   fConstituents
     ->Add(new AliMUONGeometryConstituent(
@@ -228,9 +227,8 @@ void  AliMUONGeometryEnvelope::AddConstituentParam(const TString& name,
                                  const TGeoCombiTrans& transform, 
                                  Int_t npar, Double_t* param)
 {
-// Adds the volume with the specified name and transformation
-// to the list of envelopes.
-// ---                                            
+/// Add the volume with the specified name and transformation
+/// to the list of envelopes.
 
   fConstituents
     ->Add(new AliMUONGeometryConstituent(
@@ -240,8 +238,7 @@ void  AliMUONGeometryEnvelope::AddConstituentParam(const TString& name,
 //______________________________________________________________________________
 void  AliMUONGeometryEnvelope::SetTranslation(const TGeoTranslation& translation)
 {
-// Sets the envelope position
-// ---
+/// Set the envelope position
 
   fTransformation
     ->SetTranslation(const_cast<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()));