Fixing doxygen warnings
authorlaphecet <laphecet@f7af4fe6-9843-0410-8265-dc069ae4e863>
Fri, 30 Oct 2009 16:13:34 +0000 (16:13 +0000)
committerlaphecet <laphecet@f7af4fe6-9843-0410-8265-dc069ae4e863>
Fri, 30 Oct 2009 16:13:34 +0000 (16:13 +0000)
MUON/AliMUONContourHandler.h
MUON/AliMUONNode.cxx
MUON/AliMUONPolygon.h
MUON/AliMUONTrackerDataMaker.cxx
MUON/AliMUONVPainter.cxx
MUON/AliMUONVQAChecker.h
MUON/AliMUONVQADataMakerRec.h

index 9f7771e..a05d5e3 100644 (file)
@@ -29,12 +29,15 @@ public:
   
   Bool_t Adopt(AliMUONContour* contour); 
   
+  /// Get all the contours as a map
   TMap* AllContourMap() const { return fAllContourMap; }
   
+  /// Get all the contours as an array
   TObjArray* AllContourArray() const { return fAllContourArray; }
   
   AliMUONContour* GetContour(const char* contourname) const;
   
+  /// Get detection element geometrical transformations
   AliMpExMap* GetTransformations() const { return fTransformations; }
   
   void Print(Option_t* opt="") const;
index ac98327..c96eeaa 100644 (file)
@@ -24,7 +24,7 @@
 /// Proceedings of the IEEE, Vol. 80, No. 9, September 1992, p. 1449
 ///
 /// 
-/// \Author Laurent Aphecetche, Subatech
+/// \author Laurent Aphecetche, Subatech
 
 #include "AliMUONNode.h"
 
index 95184da..17827ac 100644 (file)
@@ -25,6 +25,7 @@ public:
   AliMUONPolygon& operator=(const AliMUONPolygon& rhs);
   virtual ~AliMUONPolygon();
 
+  /// Create a full copy of this object
   virtual TObject* Clone(const char* /*newname*/="") const { return new AliMUONPolygon(*this); }
   
   Bool_t Contains(Double_t x, Double_t y) const;
@@ -38,10 +39,13 @@ public:
   
   void SetVertex(Int_t i, Double_t x, Double_t y);
 
+  /// Return the x-coordinate of the i-th vertex
   Double_t X(Int_t i) const { return fX[i]; }
 
+  /// Return the y-coordinate of the i-th vertex
   Double_t Y(Int_t i) const { return fY[i]; }
 
+  /// Get the number of vertices of this polygon
   Int_t NumberOfVertices() const { return fN; }
   
   void Print(Option_t* opt="") const;
index ef5bbd2..d89b6a7 100644 (file)
@@ -149,6 +149,7 @@ fIsRunning(kFALSE),
 fIsOwnerOfRawReader(kTRUE),
 fIsEventByEvent(kFALSE)
 {
+  /// Ctor from raw data reader
   if (fRawReader) 
   {
     fRawReader->NextEvent(); // to be sure to get run number available
index 13a4f7c..0edc281 100644 (file)
@@ -1394,5 +1394,6 @@ AliMUONVPainter::CreatePainter(const char* className,
 void
 AliMUONVPainter::PaintArea(Int_t fillColor)
 {
+  /// Draw a filled area
   AliMUONContourPainter::Paint(*(Contour()),-1,-1,fillColor);
 }
index ab8b8c1..a93b61c 100644 (file)
@@ -23,17 +23,22 @@ class AliMUONVQAChecker : public TObject
 {
 public:
   enum ECheckCode {
-    kFatal=-1,
-    kError=0,
-    kWarning=1,
-    kInfo=2
+    kFatal=-1,  ///< error is really serious
+    kError=0,   ///< normal error, i.e. something is wrong
+    kWarning=1, ///< warning, i.e. might become an error later on
+    kInfo=2     ///< just so you know...
   };
   
   AliMUONVQAChecker();
   virtual ~AliMUONVQAChecker();
   
+  /// Check the QA object(s) for the raw data
   virtual ECheckCode * CheckRaws(TObjArray** list, AliMUONRecoParam* recoParam) = 0;
+  
+  /// Check the QA object(s) for the RecPoints
   virtual ECheckCode * CheckRecPoints(TObjArray** list, AliMUONRecoParam* recoParam) = 0;
+  
+  /// Check the QA object(s) for the ESD
   virtual ECheckCode * CheckESD(TObjArray** list, AliMUONRecoParam* recoParam) = 0;
   
   ClassDef(AliMUONVQAChecker,1) // Interface for a MUON QA checker
index b3c0206..3b90c94 100644 (file)
@@ -34,19 +34,31 @@ public:
   AliMUONVQADataMakerRec(AliQADataMakerRec* master);
   virtual ~AliMUONVQADataMakerRec();
   
+  /// Initialization for handling Digits
   virtual void InitDigits() = 0; 
+  /// Initialization for handling ESD
   virtual void InitESDs() = 0; 
+  /// Initialization for handling Raws
   virtual void InitRaws() = 0; 
+  /// Initialization for handling RecPoints
   virtual void InitRecPoints() = 0; 
   
+  /// Produces QA data for Raws
   virtual void MakeRaws(AliRawReader* rawReader) = 0; 
+  /// Produces QA data for Digits
   virtual void MakeDigits(TTree* dig) = 0; 
+  /// Produces QA data for RecPoints
   virtual void MakeRecPoints(TTree* recpo) = 0;
+  /// Produces QA data for ESD
   virtual void MakeESDs(AliESDEvent* esd) = 0;
   
+  /// Wrap up things at each cycle for Raws
   virtual void EndOfDetectorCycleRaws(Int_t specie, TObjArray** list) = 0;
+  /// Wrap up things at each cycle for RecPoints
   virtual void EndOfDetectorCycleRecPoints(Int_t specie, TObjArray** list) = 0;
+  /// Wrap up things at each cycle for ESD
   virtual void EndOfDetectorCycleESDs(Int_t specie, TObjArray** list) = 0;
+  /// Wrap up things at each cycle for Digits
   virtual void EndOfDetectorCycleDigits(Int_t specie, TObjArray** list) = 0;
 
 protected: