Comments for Doxygen (mostly added comments for inline functions)

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

diff --git a/MUON/AliMUONRawStreamTracker.h b/MUON/AliMUONRawStreamTracker.h
index 6358cf9d2f664986b44a3d50f883d7f92bf81c09..20f16a3caa3951f8cb0f7466ae59d558ac0f72d5 100644 (file)
--- a/MUON/AliMUONRawStreamTracker.h
+++ b/MUON/AliMUONRawStreamTracker.h
@@ -27,26 +27,39 @@ class AliMUONRawStreamTracker: public TObject {
     virtual Bool_t   Next();
     virtual Bool_t   NextDDL();
 
+    /// Return maximum number of DDL in DATE file
     Int_t GetMaxDDL()   const {return fMaxDDL;}
+    /// Return maximum number of block per DDL in DATE file
     Int_t GetMaxBlock() const {return  fPayload->GetMaxBlock();}
+    /// Return maximum number of Dsp per block in DATE file
     Int_t GetMaxDsp()   const {return  fPayload->GetMaxDsp();}
+    /// Return maximum number of Buspatch per Dsp in DATE file
     Int_t GetMaxBus()   const {return  fPayload->GetMaxBus();}
 
     // check input before assigment
     void SetMaxDDL(Int_t ddl);
     void SetMaxBlock(Int_t blk);
 
-    // does not check, done via BusPatchManager
+    /// Set maximum number of Dsp per block in DATE file
+    /// does not check, done via BusPatchManager
     void SetMaxDsp(Int_t dsp) {fPayload->SetMaxDsp(dsp);}
+    /// Set maximum number of Buspatch per Dsp in DATE file
+    /// does not check, done via BusPatchManager
     void SetMaxBus(Int_t bus) {fPayload->SetMaxBus(bus);}
 
-
+    /// Set object for reading the raw data
     void SetReader(AliRawReader* rawReader) {fRawReader = rawReader;}
 
+    /// Return pointer for buspatch structure
     AliMUONDDLTracker*      GetDDLTracker()   const {return fPayload->GetDDLTracker();}
+    /// Return number of DDL
     Int_t                   GetDDL()          const {return fDDL - 1;}
 
   private :
+    /// Not implemented
+    AliMUONRawStreamTracker(const AliMUONRawStreamTracker& stream);
+    /// Not implemented
+    AliMUONRawStreamTracker& operator = (const AliMUONRawStreamTracker& stream);
 
     AliRawReader*    fRawReader;    ///< object for reading the raw data
  
@@ -61,9 +74,6 @@ class AliMUONRawStreamTracker: public TObject {
 
     AliMUONPayloadTracker* fPayload; ///< pointer to payload decoder
 
-    AliMUONRawStreamTracker(const AliMUONRawStreamTracker& stream);
-    AliMUONRawStreamTracker& operator = (const AliMUONRawStreamTracker& stream);
-
     ClassDef(AliMUONRawStreamTracker, 2)    // base class for reading MUON raw digits
 };