Moving the FMD offline trigger to its own class, AliFMDOfflineTrigger

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

diff --git a/FMD/AliFMDv0.h b/FMD/AliFMDv0.h
index 882f150c7f7faaa1e2d5fe58564d7aa69f51fb6a..0e0c0a53bd5ce1cb87143b062d5d989b77e5b4eb 100644 (file)
--- a/FMD/AliFMDv0.h
+++ b/FMD/AliFMDv0.h
@@ -7,28 +7,51 @@
  *
  * See cxx source for full Copyright notice                               
  */
-
+/** @file    AliFMDv0.h
+    @author  Christian Holm Christensen <cholm@nbi.dk>
+    @date    Mon Mar 27 12:48:51 2006
+    @brief   Concrete implementation of FMD detector driver - coarse
+    version 
+*/
 //____________________________________________________________________
 //
 //  Manager class for the FMD - Coarse version. 
 //
 #ifndef ALIFMD_H 
-# include <AliFMD.h>
+# include "AliFMD.h"
 #endif
 
 //____________________________________________________________________
+/** @brief Forward Multiplicity Detector based on Silicon wafers. 
+
+    This class contains the base procedures for the Forward
+    Multiplicity detector Detector consists of 3 sub-detectors FMD1,
+    FMD2, and FMD3, each of which has 1 or 2 rings of silicon sensors.
+                                                           
+    This contains the coarse version of the FMD - that is, the
+    simulation produces no hits in the FMD volumes, and the sensors
+    are not divided into strips and sectors.   Useful for material
+    budget calculations
+    @ingroup FMD_sim
+ */
 class AliFMDv0 : public AliFMD 
 {
 public:
+  /** CTOR */
   AliFMDv0() {}
+  /** CTOR
+      @param name Name
+      @param title Title  */
   AliFMDv0(const char *name, const char *title="Coarse geometry") 
-    : AliFMD(name, title, false)
-  {}
-  virtual ~AliFMDv0() 
+    : AliFMD(name, title)
   {}
+  /** DTOR */
+  virtual ~AliFMDv0() {}
 
   // Required member functions 
+  /** @return Version number - always 0 */
   virtual Int_t  IsVersion() const {return 0;}
+  /** Function called at each hit.  Empty */
   virtual void   StepManager() {}
 
   ClassDef(AliFMDv0,1) // Coarse FMD geometry