Fixing Doxygen warnings
authorivana <ivana@f7af4fe6-9843-0410-8265-dc069ae4e863>
Fri, 15 May 2009 10:05:06 +0000 (10:05 +0000)
committerivana <ivana@f7af4fe6-9843-0410-8265-dc069ae4e863>
Fri, 15 May 2009 10:05:06 +0000 (10:05 +0000)
26 files changed:
MUON/AliMUONContourMaker.cxx
MUON/AliMUONContourMakerTest.h
MUON/AliMUONGlobalTrigger.h
MUON/AliMUONManuContourMaker.cxx
MUON/AliMUONManuContourMaker.h
MUON/AliMUONNode.h
MUON/AliMUONPointWithRef.cxx
MUON/AliMUONPointWithRef.h
MUON/AliMUONPolygon.h
MUON/AliMUONQAChecker.cxx
MUON/AliMUONQADataMakerRec.cxx
MUON/AliMUONRawStreamTrackerHP.h
MUON/AliMUONSegment.h
MUON/AliMUONSegmentTree.h
MUON/AliMUONTrackExtrap.cxx
MUON/AliMUONTrackerDataMaker.cxx
MUON/READMEmtrda.txt
MUON/READMEshuttle.txt
MUON/mapping/AliMpArea.cxx
MUON/mapping/AliMpArea.h
MUON/mapping/AliMpFastSegmentation.h
MUON/mapping/AliMpMotifPosition.h
MUON/mapping/AliMpMotifType.h
MUON/mapping/AliMpPad.h
MUON/mapping/AliMpTrigger.h
MUON/mapping/AliMpUID.h

index 73435cc..5dc496e 100644 (file)
@@ -65,11 +65,14 @@ namespace
 //_____________________________________________________________________________
 AliMUONContourMaker::AliMUONContourMaker() 
 {
+/// Default constructor
 }
 
+
 //_____________________________________________________________________________
 AliMUONContourMaker::~AliMUONContourMaker()
 {
+/// Destructor
 }
 
 //_____________________________________________________________________________
index 1483de3..f11e875 100644 (file)
@@ -56,8 +56,6 @@ private:
   
   void GenerateTransformations(AliMpExMap*& real, AliMpExMap*& exploded);
 
-  TString NameIt(const AliMpMotifPosition& motifPosition) const;
-
   ClassDef(AliMUONContourMakerTest,1) // Test of AliMUONContourMaker
 };
 
index 9fdc492..5b067bb 100644 (file)
@@ -37,6 +37,7 @@ class AliMUONGlobalTrigger : public TObject {
   void  SetFromGlobalResponse(UShort_t globalResponse);
   void  SetFromGlobalInput(const UInt_t *globalInput);
   UChar_t GetGlobalResponse() const;
+          /// Return global input to the global trigger board
   UInt_t *GetGlobalInput() { return fInput; }
 
   virtual void Print(Option_t* opt="") const;
index 538172a..6b530bd 100644 (file)
@@ -62,12 +62,15 @@ ClassImp(AliMUONManuContourMaker)
 AliMUONManuContourMaker::AliMUONManuContourMaker(AliMpExMap* deTransformations)
 : TObject(), fDETransformations(deTransformations), fLocalManuContours(222,1)
 {
+/// Standard constructor
+
   fLocalManuContours.SetOwnerKeyValue(kTRUE,kTRUE);  
 }
 
 //_____________________________________________________________________________
 AliMUONManuContourMaker::~AliMUONManuContourMaker()
 {
+/// Destructor
 }
 
 //_____________________________________________________________________________
index 0dbea02..3426fe0 100644 (file)
@@ -47,10 +47,10 @@ private:
   TString NameIt(const AliMpMotifPosition& motifPosition) const;
 
 private:
-  AliMpExMap* fDETransformations; //< map<int,TGeoHMatrix> of detElemId to matrix
-  mutable TMap fLocalManuContours; //< map of local manu contours
+  AliMpExMap* fDETransformations;  ///< map<int,TGeoHMatrix> of detElemId to matrix
+  mutable TMap fLocalManuContours; ///< map of local manu contours
   
-  ClassDef(AliMUONManuContourMaker,1) // 
+  ClassDef(AliMUONManuContourMaker,1) // Maker of AliMUONContour objects for all the tracker manus
 };
 
 #endif
index eac51b4..c9efd6c 100644 (file)
@@ -61,17 +61,17 @@ private:
   AliMUONNode(const AliMUONNode& node); 
   /// not implemented
   AliMUONNode& operator=(const AliMUONNode& node);  
-  AliMUONNode* fLeftNode; //< left node
-  AliMUONNode* fRightNode; //< right node
+  AliMUONNode* fLeftNode; ///< left node
+  AliMUONNode* fRightNode; ///< right node
   
-  Double_t fMin; //< Min
-  Double_t fMax; //< Max
-  Double_t fMidPoint; //< (Min+Max)/2
+  Double_t fMin; ///< Min
+  Double_t fMax; ///< Max
+  Double_t fMidPoint; ///< (Min+Max)/2
   
-  Int_t fC; //< cardinality
-  Int_t fP; //< potent state
+  Int_t fC; ///< cardinality
+  Int_t fP; ///< potent state
   
-  ClassDef(AliMUONNode,0); // A node of a segment tree
+  ClassDef(AliMUONNode,0) // A node of a segment tree
 };
 
 #endif
index 2c38730..d6b129c 100644 (file)
@@ -36,22 +36,22 @@ ClassImp(AliMUONPointWithRef)
 //_____________________________________________________________________________
 AliMUONPointWithRef::AliMUONPointWithRef() : fX(), fY(), fRef(-1)
 {
-  /// ctor
+  /// default ctor
 }
 
 //_____________________________________________________________________________
 AliMUONPointWithRef::AliMUONPointWithRef(Double_t x, Double_t y, Int_t ref)
 : fX(x), fY(y), fRef(ref)
 {
-  /// dtor
+  /// ctor
 }
 
 //_____________________________________________________________________________
 Int_t  
 AliMUONPointWithRef::Compare(const TObject* obj) const
 {
-  // Should serve to sort the vertical edges in ascending order, first on absissa, 
-  // then on ordinate
+  /// Should serve to sort the vertical edges in ascending order, first on absissa, 
+  /// then on ordinate
   
   if ( this == obj ) return 0;
   
index 33fe464..c698601 100644 (file)
@@ -21,6 +21,7 @@ class AliMUONPointWithRef : public TObject
 public:
   AliMUONPointWithRef(Double_t x, Double_t y, Int_t ref);
   AliMUONPointWithRef();
+  /// Destructor
   virtual ~AliMUONPointWithRef() {}
   
   /// We are sortable
@@ -28,18 +29,21 @@ public:
 
   virtual Int_t        Compare(const TObject* obj) const;
 
+  /// Return x value
   Double_t X() const { return fX; }
   
+  /// Return y value
   Double_t Y() const { return fY; }
   
+  /// Return the index of the original point in some array
   Int_t Ref() const { return fRef; }
   
   void Print(Option_t* opt="") const;
   
 private:
-  Double_t fX; //< x value
-  Double_t fY; //< y value
-  Int_t fRef; //< index of the original point in some array
+  Double_t fX; ///< x value
+  Double_t fY; ///< y value
+  Int_t fRef; ///< index of the original point in some array
   
   ClassDef(AliMUONPointWithRef,1) // A point with an external integer reference
 };
index c49badd..95184da 100644 (file)
@@ -51,7 +51,7 @@ public:
   void Close();
   
 private:
-  Int_t fN; /// Number of vertices 
+  Int_t fN; ///< Number of vertices 
   Double_t* fX; //[fN]
   Double_t* fY; //[fN]
   
index d694a65..a817eca 100644 (file)
@@ -241,7 +241,7 @@ AliMUONQAChecker::CheckRaws(TObjArray ** list)
 //______________________________________________________________________________
 void AliMUONQAChecker::Init(const AliQAv1::DETECTORINDEX_t det) 
 {
-  // intialises QA and QA checker settings
+  /// intialises QA and QA checker settings
   AliQAv1::Instance(det) ; 
   Float_t hiValue[AliQAv1::kNBIT] ; 
   Float_t lowValue[AliQAv1::kNBIT] ;
index 2ea6893..a247343 100644 (file)
@@ -1394,6 +1394,7 @@ AliMUONQADataMakerRec::FillTriggerDCSHistos()
 //____________________________________________________________________________ 
 AliMUONVTrackerData* AliMUONQADataMakerRec::GetTrackerData() const
 { 
+/// Return tracker data
   
   return fTrackerDataMaker->Data(); 
   
index 6a0edec..5364415 100644 (file)
@@ -544,7 +544,8 @@ private:
         /// Not implemented
        AliMUONRawStreamTrackerHP& operator = (const AliMUONRawStreamTrackerHP& stream);
        
-  Int_t GetMaxDDL() const { return fgkMaxDDL; }
+       /// Return max number of tracker DDLs
+       Int_t GetMaxDDL() const { return fgkMaxDDL; }
   
        /// This is the custom event handler (callback interface) class which
        /// unpacks raw data words and fills an internal buffer with decoded digits
index 4e987f9..b171226 100644 (file)
@@ -21,6 +21,7 @@ class AliMUONSegment : public TObject
 public:
   AliMUONSegment();
   AliMUONSegment(Double_t xstart, Double_t ystart, Double_t xend, Double_t yend);
+  /// dtor
   virtual ~AliMUONSegment() {}
   
   virtual Int_t        Compare(const TObject* obj) const;
@@ -71,18 +72,18 @@ public:
   void Set(Double_t xstart, Double_t ystart, Double_t xend, Double_t yend);
   
 private:
-  Double_t fStartX; /// x of start point
-  Double_t fStartY; /// y of start point
-  Double_t fEndX; /// x of end point
-  Double_t fEndY; /// y of end point
-  Double_t fSmallerY; /// Either StartY or EndY
-  Bool_t fIsHorizontal; /// Whether the segment is horizontal
-  Bool_t fIsVertical; /// Whether the segment is vertical
-  Bool_t fIsLeftEdge; /// Whether the segment is a left edge 
-  Bool_t fIsRightEdge; /// Whether the segment is a right edge
-  Bool_t fIsAPoint; /// Whether start==end
+  Double_t fStartX; ///< x of start point
+  Double_t fStartY; ///< y of start point
+  Double_t fEndX; ///< x of end point
+  Double_t fEndY; ///< y of end point
+  Double_t fSmallerY; ///< Either StartY or EndY
+  Bool_t fIsHorizontal; ///< Whether the segment is horizontal
+  Bool_t fIsVertical; ///< Whether the segment is vertical
+  Bool_t fIsLeftEdge; ///< Whether the segment is a left edge 
+  Bool_t fIsRightEdge; ///< Whether the segment is a right edge
+  Bool_t fIsAPoint; ///< Whether start==end
   
-  static const Double_t fgkPrecision; /// Floating point precision used in comparisons
+  static const Double_t fgkPrecision; ///< Floating point precision used in comparisons
   
   ClassDef(AliMUONSegment,1) // A basic line segment
 };
index b1d75c8..991696e 100644 (file)
@@ -51,8 +51,8 @@ private:
   /// not implemented
   AliMUONSegmentTree& operator=(const AliMUONSegmentTree& rhs);
   
-  AliMUONNode* fRoot; /// root of the tree
-  TObjArray fStack; /// array of AliMUONSegment objects
+  AliMUONNode* fRoot; ///< root of the tree
+  TObjArray fStack; ///< array of AliMUONSegment objects
   
   ClassDef(AliMUONSegmentTree,1) // Implementation of a segment tree
 };
index 97b3f82..9f97a2a 100644 (file)
@@ -51,8 +51,8 @@ const Double_t AliMUONTrackExtrap::fgkRungeKuttaMaxResidue = 0.002;
 //__________________________________________________________________________
 void AliMUONTrackExtrap::SetField()
 {
-  // set field on/off flag  
-  // set field at the centre of the dipole
+  /// set field on/off flag;  
+  /// set field at the centre of the dipole
   const Double_t x[3] = {50.,50.,fgkSimpleBPosition};
   Double_t b[3] = {0.,0.,0.};
   TGeoGlobalMagField::Instance()->Field(x,b);
index 827e32f..eacfe10 100644 (file)
@@ -63,6 +63,7 @@ fIsRunning(kFALSE),
 fIsOwnerOfRawReader(kFALSE),
 fIsEventByEvent(kFALSE)
 {
+/// Root IO ctor
 }
 
 //_____________________________________________________________________________
@@ -236,6 +237,8 @@ AliMUONTrackerDataMaker::Ctor(const AliMUONRecoParam* recoParam,
 //_____________________________________________________________________________
 AliMUONTrackerDataMaker::~AliMUONTrackerDataMaker()
 {
+/// dtor
+
   delete fOneEventData;
   delete fAccumulatedData;
   if ( fIsOwnerOfRawReader ) delete fRawReader;
index 8301796..4810b7d 100644 (file)
@@ -19,10 +19,10 @@ In the current version, the DA will modify only the global crate configuration.
 
 The configuration files stored in the online DB are the following:
 
-- MtgGlobalCrate-<version>.dat:   contains the global crate information
-- MtgRegionalCrate-<version>.dat: contains the regional crate information
-- MtgLocalMask-<version>.dat:     contains the local mask
-- MtgLocalLut-<version>.dat:      contains the local LUT 
+- MtgGlobalCrate-[version].dat:   contains the global crate information
+- MtgRegionalCrate-[version].dat: contains the regional crate information
+- MtgLocalMask-[version].dat:     contains the local mask
+- MtgLocalLut-[version].dat:      contains the local LUT 
 - MtgCurrent.dat:                 contains the name list of the above files with 
                                   their version and the flag for master/slave
                                   status of the DA
index 6022013..1a327da 100644 (file)
@@ -134,7 +134,7 @@ per LDC, as will be used in real life), the latter ones being roughly 100 MB eac
 //
 
 The raw.date.LDC* files are then processed using the DA online program (which is not built by default, but must be made
- explicitely using make daqDA-MCH from $ALICE_ROOT, and requires some DATE setup..., see \ref READMEmchda.txt )
+ explicitely using make daqDA-MCH from $ALICE_ROOT, and requires some DATE setup..., see \ref README_mchda )
  
 <pre>
  MUONTRKda.exe -f raw.date.LCDi -a LDCi.ped (i=0,1,2,3)
index 9e5cb2a..b9887ab 100755 (executable)
@@ -271,7 +271,9 @@ AliMpArea::Print(Option_t* opt) const
 void      
 AliMpArea::GetParameters(Double_t& x, Double_t& y,
                          Double_t& dx, Double_t& dy) const
-{                         
+{
+/// Fill the parameters: x, y position and dimensions
+                         
   x = fPositionX;
   y = fPositionY;
   dx = fDimensionX;
index 3f5d2a2..1c3d4b2 100755 (executable)
@@ -69,13 +69,13 @@ ostream& operator << (ostream &stream,const AliMpArea& area);
 
 // inline functions
 
-                 /// Return position
+                 /// Return x position
 inline Double_t  AliMpArea::GetPositionX() const   { return fPositionX; }
-                 /// Return position
+                 /// Return y position
 inline Double_t  AliMpArea::GetPositionY() const   { return fPositionY; }
-                 /// Return dimensions
+                 /// Return x dimensions
 inline Double_t  AliMpArea::GetDimensionX() const { return fDimensionX; }    
-                 /// Return dimensions
+                 /// Return y dimensions
 inline Double_t  AliMpArea::GetDimensionY() const { return fDimensionY; }    
                  /// Return validity
 inline Bool_t    AliMpArea::IsValid() const    { return fValidity; }
index 53b3602..bc02583 100644 (file)
@@ -79,7 +79,9 @@ public:
   AliMp::StationType StationType() const { return fHelper->StationType(); }
   
 private:
+  /// Not implemented
   AliMpFastSegmentation(const AliMpFastSegmentation& rhs);
+  /// Not implemented
   AliMpFastSegmentation& operator=(const AliMpFastSegmentation& rhs);
 
   virtual AliMpMotifPosition* InternalMotifPosition(Int_t index) const;
index 223cab8..4e14197 100755 (executable)
@@ -73,17 +73,19 @@ inline Int_t  AliMpMotifPosition::GetID() const
 inline AliMpVMotif*  AliMpMotifPosition::GetMotif() const
 { return fMotif; }
  
-/// Return position
+/// Return x position
 inline Double_t AliMpMotifPosition::GetPositionX() const
 { return fPositionX; }
 
+/// Return y position
 inline Double_t AliMpMotifPosition::GetPositionY() const
 { return fPositionY; }
 
-/// Return position
+/// Return x dimension
 inline Double_t AliMpMotifPosition::GetDimensionX() const
 { return fMotif->DimensionX(); }
 
+/// Return y dimension
 inline Double_t AliMpMotifPosition::GetDimensionY() const
 { return fMotif->DimensionY(); }
 
index 8be6b25..10bbfbb 100755 (executable)
@@ -66,7 +66,7 @@ class AliMpMotifType : public TObject
     Int_t    GetNofPadsX() const  {return fNofPadsX;}
     /// Return number of pads in y direction
     Int_t    GetNofPadsY() const  {return fNofPadsY;}
-    
+    /// Return the total number of pads
     Int_t    GetNofPads() const   {return fNofPads;}
     
     // Other methods
@@ -83,6 +83,7 @@ class AliMpMotifType : public TObject
 
     Bool_t HasPadByManuChannel(Int_t manuChannel) const;
 
+    /// Return whether the pad with given manu channel exists
     Bool_t HasPadByGassiNum(Int_t gassiNum) const { return HasPadByManuChannel(gassiNum); }
     
     Bool_t IsFull() const;
index 8837f3f..d5f5d08 100755 (executable)
@@ -102,7 +102,8 @@ class AliMpPad : public TObject
                                           /// in the collection
   // data members
   UInt_t          fNofLocations;   ///<  number of locations in fLocations
-  MpPair_t*       fLLocations;     //[fNofLocations]  collection of pad locations - encoded pair (localBoardId, localBoardChannel) 
+  /// Collection of pad locations - encoded pair (localBoardId, localBoardChannel) 
+  MpPair_t*       fLLocations;     //[fNofLocations]
   MpPair_t        fLLocation;      ///<  pad location as encoded pair (manuId, manuChannel) 
   MpPair_t        fLIndices;       ///<  pad indices as encoded pair (ix, iy)  
   Double_t        fPositionX;      ///<  the pad x position (in cm)
index 99344b3..c84fc33 100644 (file)
@@ -71,9 +71,9 @@ public:
 
   AliMp::PlaneType PlaneType() const;
   
-  // Return the x dimension (half-sizes) of that slat (cm)
+  /// Return the x dimension (half-sizes) of that slat (cm)
   Double_t  GetDimensionX() const { return DX(); }
-  // Return the y dimension (half-sizes) of that slat (cm)
+  /// Return the y dimension (half-sizes) of that slat (cm)
   Double_t  GetDimensionY() const { return DY(); }
   
 private:
index 999f714..748ce17 100644 (file)
@@ -32,6 +32,7 @@ public:
   AliMpUID(AliMp::CathodType cathodeType, const char* pathname);
   AliMpUID(const char* pathname);
   
+  /// dtor
   virtual ~AliMpUID() {}
   
   TString Name() const;
@@ -48,11 +49,17 @@ public:
   Bool_t IsValid() const;
   
   AliMp::CathodType CathodeId() const;
+  /// Return station Id
   Int_t StationId() const { return fStationId; }
+  /// Return chamber Id
   Int_t ChamberId() const { return fChamberId; }
+  /// Return detection element Id
   Int_t DetElemId() const { return fDetElemId; }
+  /// Return bus patch Id
   Int_t BusPatchId() const { return fBusPatchId; }
+  /// Return manu Id
   Int_t ManuId() const { return fManuId; }
+  /// Return PCB Id
   Int_t PCBId() const { return fPCBId; }
   
   virtual void Print(Option_t* opt="") const;
@@ -66,13 +73,13 @@ private:
   TString StripCathode(const char* name) const;
   
 private:
-  Int_t fCathodeId; // Cathode number
-  Int_t fStationId; // Station id
-  Int_t fChamberId; // Chamber id
-  Int_t fDetElemId; // Detection element id
-  Int_t fBusPatchId; // Bus patch id
-  Int_t fManuId; // Manu id
-  Int_t fPCBId; // PCB id
+  Int_t fCathodeId; ///< Cathode number
+  Int_t fStationId; ///< Station id
+  Int_t fChamberId; ///< Chamber id
+  Int_t fDetElemId; ///< Detection element id
+  Int_t fBusPatchId;///< Bus patch id
+  Int_t fManuId;    ///< Manu id
+  Int_t fPCBId;     ///< PCB id
   
   ClassDef(AliMpUID,1) // UID of a tracker channel 
 };