Record changes.

[u/mrichter/AliRoot.git] / FMD / AliFMDRing.h

diff --git a/FMD/AliFMDRing.h b/FMD/AliFMDRing.h
index c61f010de98fd49b090cb99099e1055d1572ff19..10790311565ab7860a0e923e7d7a06327165953b 100644 (file)
--- a/FMD/AliFMDRing.h
+++ b/FMD/AliFMDRing.h
@@ -7,10 +7,14 @@
  *
  * See cxx source for full Copyright notice                               
  */
+/** @file    AliFMDRing.h
+    @author  Christian Holm Christensen <cholm@nbi.dk>
+    @date    Mon Mar 27 12:47:43 2006
+    @brief   FMD ring geometry parameters 
+*/
 //__________________________________________________________________
 //
 // Parameters of the FMD rings. 
-// 
 // This class is responsible to make the (common) rings of the three
 // sub-detectors. 
 //
@@ -24,18 +28,22 @@
 class TBrowser;
 class TVector2;
 
-/** Geometry description and parameters of a ring in the FMD
+/** @brief Geometry description and parameters of a ring in the FMD 
     detector. 
     
     As there are only 2 kinds of rings @e Inner (@c 'I') and @e
     Outer (@c 'O') the two objects of this class is owned by the
     Geometry::FMD singleton object.  The 3 Geometry::FMDDetector
     objects shares these two instances as needed. 
+    @ingroup FMD_base
 */
 class AliFMDRing : public TNamed
 {
 public:
+  /** CTOR
+      @param fId Ring ID  */
   AliFMDRing(Char_t fId);
+  /** DTOR  */
   virtual ~AliFMDRing() {}
   /** Initialize the ring geometry */
   virtual void Init();
@@ -130,8 +138,10 @@ public:
       @return the ith vertex */
   TVector2* GetVertex(Int_t i) const;
      
+  /** Not used */
   void Detector2XYZ(UShort_t sector, UShort_t strip, 
                    Double_t& x, Double_t& y, Double_t& z) const;
+  /** Not used */
   Bool_t XYZ2Detector(Double_t x, Double_t y, Double_t z, 
                      UShort_t& sector, UShort_t& strip) const;
 private: