Updated/added comments for Doxygen

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

diff --git a/MUON/mapping/AliMpVPadRowSegment.h b/MUON/mapping/AliMpVPadRowSegment.h
index ca932169a3b70d33daf53cfcb97fdd86a391a84a..c248a84d7b2e56e11d3bf15c6e6d99219d685d0e 100755 (executable)
--- a/MUON/mapping/AliMpVPadRowSegment.h
+++ b/MUON/mapping/AliMpVPadRowSegment.h
@@ -1,13 +1,15 @@
+/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ * See cxx source for full Copyright notice                               */
+
 // $Id$
-// ---------------------------------------------------------------
-// Category: sector
-//
-// Class AliMpVPadRowSegment
-// -------------------------
-// The abstract base class for a pad row segment composed of the 
-// the identic pads.
-//
-// Authors: David Guez, Ivana Hrivnacova; IPN Orsay
+// $MpId: AliMpVPadRowSegment.h,v 1.7 2006/05/24 13:58:21 ivana Exp $
+
+/// \ingroup sector
+/// \class AliMpVPadRowSegment
+/// \brief The abstract base class for a pad row segment composed of the 
+/// the identic pads.
+///
+/// \author David Guez, Ivana Hrivnacova; IPN Orsay
 
 #ifndef ALI_MP_V_PAD_ROW_SEGMENT_H
 #define ALI_MP_V_PAD_ROW_SEGMENT_H
@@ -26,7 +28,11 @@ class AliMpVPadRowSegment : public TObject
     virtual ~AliMpVPadRowSegment();
 
     // methods
+                      /// Return the x coordinate of the left border
+                      /// in the global coordinate system.
     virtual Double_t  LeftBorderX() const = 0;
+                      /// Return the x coordinate of the right border
+                      /// in the global coordinate system.
     virtual Double_t  RightBorderX() const = 0;
     virtual Double_t  HalfSizeY() const;
 
@@ -34,26 +40,30 @@ class AliMpVPadRowSegment : public TObject
     virtual AliMpPadRow*  GetPadRow() const;
     virtual AliMpMotif*   GetMotif() const;    
     virtual Int_t     GetMotifPositionId() const;
+                      /// Return number of pads
             Int_t     GetNofPads() const {return fNofPads;}     
 
     // set methods
     void  SetOffsetX(Double_t offsetX);  
 
   protected:
-    AliMpVPadRowSegment(const AliMpVPadRowSegment& right);
-    AliMpVPadRowSegment&  operator = (const AliMpVPadRowSegment& right);
-
+                      /// Return the x position of the right/left border
     Double_t  GetOffsetX() const { return fOffsetX; }
 
   private:
+    /// Not implemented
+    AliMpVPadRowSegment(const AliMpVPadRowSegment& right);
+    /// Not implemented
+    AliMpVPadRowSegment&  operator = (const AliMpVPadRowSegment& right);
+
     // data members
-    Int_t         fNofPads;  //number of pads
-    Double_t      fOffsetX;  //the x position of the right/left border
-    AliMpPadRow*  fPadRow;   //the pad row containing this segment 
-    AliMpMotif*   fMotif;    //the motif 
-    Int_t         fMotifPositionId;  // the motif position id
+    Int_t         fNofPads;  ///< number of pads
+    Double_t      fOffsetX;  ///< the x position of the right/left border
+    AliMpPadRow*  fPadRow;   ///< the pad row containing this segment 
+    AliMpMotif*   fMotif;    ///< the motif 
+    Int_t         fMotifPositionId;  ///< the motif position id
     
-  ClassDef(AliMpVPadRowSegment,1)  //Row segment
+  ClassDef(AliMpVPadRowSegment,1)  // Row segment
 };
 
 #endif //ALI_MP_V_PAD_ROW_SEGMENT_H