Added a lot of Doxygen documentation

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

diff --git a/FMD/AliFMDUShortMap.h b/FMD/AliFMDUShortMap.h
index 22787c1b30d9859d8eabe30d131847d569bd9ed3..1ee4a28c42568a18f058c9c971899252f72f31d0 100644 (file)
--- a/FMD/AliFMDUShortMap.h
+++ b/FMD/AliFMDUShortMap.h
@@ -9,26 +9,50 @@
 # include "AliFMDMap.h"
 #endif 
 //____________________________________________________________________
-//
-// Cache of Energy deposited, hit information perr strip
-//
-
-//____________________________________________________________________
+/** @class AliFMDUShortMap 
+    @brief Map of an integer per strip
+    @ingroup FMD_base
+ */
 class AliFMDUShortMap : public AliFMDMap
 {
 public:
+  /** Copy constructor 
+      @param other Object to copy from.  */
   AliFMDUShortMap(const AliFMDUShortMap& other);
+  /** Constructor 
+      @param maxDet  Number of detectors (3)
+      @param maxRing Number of rings (2)
+      @param maxSec  Number of sectors (40)
+      @param maxStr  Number of strips (20) */
   AliFMDUShortMap(size_t maxDet = kMaxDetectors, 
                  size_t maxRing= kMaxRings, 
                  size_t maxSec = kMaxSectors, 
                  size_t maxStr = kMaxStrips);
+  /** Destructor */
   virtual ~AliFMDUShortMap() { delete [] fData; }
+  /** Assignment operator 
+      @param other Object to assign from 
+      @return reference to this object.  */
   AliFMDUShortMap& operator=(const AliFMDUShortMap& other);
+  /** Reset to value 
+      @param v Value to reset from */
   virtual void Reset(const UShort_t& val=UShort_t());
+  /** Access operator 
+      @param det   Detector 
+      @param ring  Ring 
+      @param sec   Sector  
+      @param str   Strip
+      @return  reference value stored for the strip */
   virtual UShort_t& operator()(UShort_t detector, 
                               Char_t   ring, 
                               UShort_t sector, 
                               UShort_t strip);
+  /** Access operator 
+      @param det   Detector 
+      @param ring  Ring 
+      @param sec   Sector  
+      @param str   Strip
+      @return  value stored for the strip */
   virtual const UShort_t& operator()(UShort_t detector, 
                                     Char_t   ring, 
                                     UShort_t sector,