Updated/added comments for Doxygen

[u/mrichter/AliRoot.git] / MUON / mapping / AliMpRowSegment.h

diff --git a/MUON/mapping/AliMpRowSegment.h b/MUON/mapping/AliMpRowSegment.h
index c6df1c80bded65979ccdbfbfb15113b92b5a2465..eef81f52c0b9a5e0413ff780a178fa781975fff9 100755 (executable)
--- a/MUON/mapping/AliMpRowSegment.h
+++ b/MUON/mapping/AliMpRowSegment.h
@@ -1,22 +1,25 @@
+/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ * See cxx source for full Copyright notice                               */
+
 // $Id$
-// Category: sector
-//
-// Class AliMpRowSegment
-// ---------------------
-// Class describing a row segment composed of the 
-// the identic motifs.
-//
-// Authors: David Guez, Ivana Hrivnacova; IPN Orsay
+// $MpId: AliMpRowSegment.h,v 1.10 2006/05/24 13:58:21 ivana Exp $
+
+/// \ingroup sector
+/// \class AliMpRowSegment
+/// \brief A row segment composed of the the identic motifs.
+///
+/// \author David Guez, Ivana Hrivnacova; IPN Orsay
 
 #ifndef ALI_MP_ROW_SEGMENT_H
 #define ALI_MP_ROW_SEGMENT_H
 
-#include <TVector2.h>
-
 #include "AliMpVRowSegment.h"
 
+#include <TVector2.h>
+
 class AliMpRow;
 class AliMpVMotif;
+class AliMpIntPair;
 
 class AliMpRowSegment : public AliMpVRowSegment
 {
@@ -43,16 +46,22 @@ class AliMpRowSegment : public AliMpVRowSegment
 
     // set methods
     virtual void      SetOffset(const TVector2& offset);
-    virtual void      SetGlobalIndices();
-    virtual Int_t     SetIndicesToMotifPosition(Int_t i, AliMpIntPair indices);
+    virtual void      SetGlobalIndices(AliMpRow* rowBefore);
+    virtual Int_t     SetIndicesToMotifPosition(Int_t i, 
+                                const AliMpIntPair& indices);
 
     // get methods
     virtual AliMpRow*     GetRow() const;
     virtual Int_t         GetNofMotifs() const;
-    virtual AliMpVMotif*  GetMotif(Int_t i) const;
+    virtual AliMpVMotif*  GetMotif(Int_t /*i*/) const;
     virtual Int_t         GetMotifPositionId(Int_t i) const;
 
   private:
+    /// Not implemented
+    AliMpRowSegment(const AliMpRowSegment& right);
+    /// Not implemented
+    AliMpRowSegment&  operator = (const AliMpRowSegment& right);
+
     // methods
     Double_t  FirstMotifCenterX() const;
     Double_t  LastMotifCenterX() const;
@@ -61,16 +70,16 @@ class AliMpRowSegment : public AliMpVRowSegment
     Bool_t    IsInside(const TVector2& position, Bool_t warn = true) const;
 
     // data members
-    Int_t         fNofMotifs;  //number of motifs
-    AliMpIntPair  fPadOffset;  //the offset in nof pads 
-    TVector2      fOffset;     //the position of the centre of the first motif
-                               //(x wtr to left border, y wtr to row center)
-    AliMpRow*     fRow;        //the row containing this segment 
-    AliMpVMotif*  fMotif;      //the motif 
-    Int_t   fMotifPositionId;  // the first motif position id
-    Int_t   fMotifPositionDId; // +1 if ids are increasing, -1 if decreasing
+    Int_t         fNofMotifs;  ///< number of motifs
+    AliMpIntPair  fPadOffset;  ///< the offset in nof pads 
+    TVector2      fOffset;     ///< \brief the position of the centre of the first motif
+                               /// (x wtr to left border, y wtr to row center)
+    AliMpRow*     fRow;        ///< the row containing this segment 
+    AliMpVMotif*  fMotif;      ///< the motif 
+    Int_t   fMotifPositionId;  ///< the first motif position id
+    Int_t   fMotifPositionDId; ///< +1 if ids are increasing, -1 if decreasing
     
-  ClassDef(AliMpRowSegment,1)  //Row segment
+  ClassDef(AliMpRowSegment,1)  // Row segment
 };
 
 #endif //ALI_MP_ROW_SEGMENT_H