Updated comments for Doxygen - corrected warnings
[u/mrichter/AliRoot.git] / MUON / mapping / AliMpSectorAreaHPadIterator.h
index a772cd7..a3cc233 100755 (executable)
@@ -1,12 +1,15 @@
+/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ * See cxx source for full Copyright notice                               */
+
 // $Id$
-// Category: sector
-//
-// Class AliMpSectorAreaHPadIterator
-// ---------------------------------
-// Class, which defines an iterator over the pads 
-// inside a given area in a sector in horizontal direction.
-//
-// Authors: David Guez, Ivana Hrivnacova; IPN Orsay
+// $MpId: AliMpSectorAreaHPadIterator.h,v 1.7 2006/05/24 13:58:21 ivana Exp $
+
+/// \ingroup sector
+/// \class AliMpSectorAreaHPadIterator
+/// \brief An iterator over the pads inside a given area in a sector
+/// in horizontal direction.
+///
+/// \author David Guez, Ivana Hrivnacova; IPN Orsay
 
 #ifndef ALI_MP_SECTOR_AREA_H_PAD_ITERATOR_H
 #define ALI_MP_SECTOR_AREA_H_PAD_ITERATOR_H
@@ -43,13 +46,13 @@ class AliMpSectorAreaHPadIterator : public AliMpVPadIterator
     void MoveUp();
 
     // private data members
-    const AliMpSectorSegmentation*  fkSegmentation; // the sector segmentation 
-                                    // over which we iterate
-    //const AliMpArea  fkArea;         // the area
-                                       // (const caused problem with CINT)
-    AliMpArea  fkArea;                 // the area
-    AliMpPad   fCurrentPad;         // the current pad
-    Double_t   fCurrentRowPosition; // the current row position
+    const AliMpSectorSegmentation*  fkSegmentation; ///< \brief the sector segmentation 
+                                    /// over which we iterate
+    //const AliMpArea  fkArea;      ///< \brief the area
+                                    /// (const caused problem with CINT)
+    AliMpArea  fkArea;              ///< the area
+    AliMpPad   fCurrentPad;         ///< the current pad
+    Double_t   fCurrentRowPosition; ///< the current row position
 
  ClassDef(AliMpSectorAreaHPadIterator,1) // iterator over motif's pads
 };