Updated comments for Doxygen
[u/mrichter/AliRoot.git] / MUON / mapping / AliMpIntPair.h
index dcb78ac..a8688f0 100755 (executable)
@@ -1,13 +1,17 @@
+/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ * See cxx source for full Copyright notice                               */
+
 // $Id$
-// Category: basic
-//
-// Class AliMpIntPair
-// ------------------
-// Class that defines the pair of integers.
-// The pair created by the default constructor is in invalide state,
-// setting one of values changes the state to valid.
-//
-// Authors: David Guez, Ivana Hrivnacova; IPN Orsay
+// $MpId: AliMpIntPair.h,v 1.5 2006/05/23 13:07:29 ivana Exp $
+
+/// \ingroup basic
+/// \class AliMpIntPair
+/// \brief A pair of integers.
+///
+/// The pair created by the default constructor is in invalide state,
+/// setting one of values changes the state to valid.
+///
+/// Authors: David Guez, Ivana Hrivnacova; IPN Orsay
 
 #ifndef ALI_MP_INT_PAIR_H
 #define ALI_MP_INT_PAIR_H
@@ -45,11 +49,11 @@ class AliMpIntPair : public TObject
   
  private:
   // data members
-  Int_t   fFirst;    // position along x
-  Int_t   fSecond;   // position along y
-  Bool_t  fValidity; // validity
+  Int_t   fFirst;    ///< the first value
+  Int_t   fSecond;   ///< the second value
+  Bool_t  fValidity; ///< validity
 
-  ClassDef(AliMpIntPair,1) //utility class for the motif type
+  ClassDef(AliMpIntPair,1) // utility class for the motif type
 };
 
 AliMpIntPair operator + (const AliMpIntPair& op1,const AliMpIntPair& op2);