]> git.uio.no Git - u/mrichter/AliRoot.git/commitdiff
Adding comments (Artur)
authorivana <ivana@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 13 Sep 2007 22:45:22 +0000 (22:45 +0000)
committerivana <ivana@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 13 Sep 2007 22:45:22 +0000 (22:45 +0000)
MUON/AliMUONDataInterface.h
MUON/AliMUONMCDataInterface.h

index d7732b2059ef24d1e3633a11a68ae042c9d007a8..15e70d3adfce317604e6122b8acd3c0f61d512a3 100644 (file)
@@ -91,16 +91,17 @@ public:
   
 private:
 
+  /// The various identifiers for the type of iterator constructed.
   enum IteratorType
   {
-    kNoIterator,
-    kDigitIteratorByDetectorElement,
-    kDigitIteratorByChamberAndCathode,
-    kRawClusterIterator,
-    kTrackIterator,
-    kLocalTriggerIterator,
-    kRegionalTriggerIterator,
-    kTriggerTrackIterator
+    kNoIterator,  ///< No iterator was constructed.
+    kDigitIteratorByDetectorElement,  ///< A digit iterator for iterating over detector elements.
+    kDigitIteratorByChamberAndCathode,  ///< A digit iterator for iterating over chambers and cathodes.
+    kRawClusterIterator,  ///< A raw cluster iterator.
+    kTrackIterator,  ///< An iterator for iterating over reconstructed tracks.
+    kLocalTriggerIterator,  ///< An iterator for iterating over reconstructed local triggers.
+    kRegionalTriggerIterator,  ///< An iterator for iterating over reconstructed regional triggers.
+    kTriggerTrackIterator  ///< An iterator for iterating over reconstructed trigger tracks.
   };
     
   void DumpSorted(const AliMUONVStore& store) const;
index 696bfebba93f33ffb98ad8f6590b915f25a8033a..ab39283c5eef472bec9d5e1d76c22ab9e28c0d05 100644 (file)
@@ -98,16 +98,17 @@ public:
   
 private:
 
+  /// The various identifiers for the type of iterator constructed.
   enum IteratorType
   {
-    kNoIterator,
-    kHitIterator,
-    kSDigitIteratorByDetectorElement,
-    kSDigitIteratorByChamberAndCathode,
-    kDigitIteratorByDetectorElement,
-    kDigitIteratorByChamberAndCathode,
-    kLocalTriggerIterator,
-    kRegionalTriggerIterator
+    kNoIterator,  ///< No iterator was constructed.
+    kHitIterator,  ///< An iterator to iterate over the hits.
+    kSDigitIteratorByDetectorElement,  ///< A summable digit iterator to iterate over the detector elements.
+    kSDigitIteratorByChamberAndCathode,  ///< A summable digit iterator to iterate over chambers and cathodes.
+    kDigitIteratorByDetectorElement,  ///< An iterator for simulated digits to iterate over the detector elements.
+    kDigitIteratorByChamberAndCathode,  ///< An iterator for simulated digits to iterate over chambers and cathodes.
+    kLocalTriggerIterator,  ///< An iterator for iterating over the simulated local triggers.
+    kRegionalTriggerIterator  ///< An iterator for iterating over the simulated regional triggers.
   };
   
   /// Not implemented