Reverting previous commit and going back to rev.64119Subversion Repositories:

[u/mrichter/AliRoot.git] / MUON / AliMUONMCDataInterface.h

diff --git a/MUON/AliMUONMCDataInterface.h b/MUON/AliMUONMCDataInterface.h
index 696bfebba93f33ffb98ad8f6590b915f25a8033a..540c83752f62c4146920516531fc09bfd01f038d 100644 (file)
--- a/MUON/AliMUONMCDataInterface.h
+++ b/MUON/AliMUONMCDataInterface.h
@@ -48,7 +48,11 @@ public:
   Bool_t IsValid() const { return fIsValid; };
 
   Int_t NumberOfEvents() const;
-  /// Returns the index number of the current event as used int GetEvent(Int_t).
+
+  /// Returns the index number of the current event loaded.
+  /// This is the event number as was used in the last calls to any of the methods
+  /// in this interface that have 'Int_t event' in the parameter list.
+  /// GetEvent(Int_t event) for example.
   Int_t   CurrentEvent() const { return fCurrentEvent; }
 
   Int_t NumberOfTracks(Int_t event);
@@ -98,16 +102,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