Comments for Doxygen (mostly added comments for inline functions)

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

diff --git a/MUON/AliMUONDetElement.h b/MUON/AliMUONDetElement.h
index d2e00e6ce5a42cbd0f6fd0d958703436ecd6a926..a17ddfd6f4c72f9f13106fbf9c4e5dbefdeaf2f7 100644 (file)
--- a/MUON/AliMUONDetElement.h
+++ b/MUON/AliMUONDetElement.h
@@ -32,30 +32,30 @@ class AliMUONDetElement : public TObject
                     AliMUONClusterFinderAZ *recModel, AliMUONSegmentation* segmentation); // constructor
   virtual ~AliMUONDetElement(); // Destructor
 
-  Int_t IdDE(void) const { return fidDE; } // det. elem. ID
-  Int_t Chamber(void) const { return fChamber; } // chamber No
-  Double_t Z(void) const { return fZ; } // Z-coordinate
-  Int_t Left(Int_t cath) const { return fLeft[cath]; } // number of unused digits
-  //Int_t GetMapElem(AliMUONDigit *digit) const; // get map element
-  TObjArray *Digits(Int_t cath) const { return fDigits[cath]; } // array of digits
-  TObjArray *RawClusters() const { return fRawClus; } // array of raw clusters
-  TObjArray *HitsForRec() const { return fHitsForRec; } // hits for rec.
-  Int_t NHitsForRec() const { return fNHitsForRec; } // No. of hits for rec.
+  Int_t IdDE(void) const { return fidDE; } ///< det. elem. ID
+  Int_t Chamber(void) const { return fChamber; } ///< chamber No
+  Double_t Z(void) const { return fZ; } ///< Z-coordinate
+  Int_t Left(Int_t cath) const { return fLeft[cath]; } ///< number of unused digits
+  //Int_t GetMapElem(AliMUONDigit *digit) const; ///< get map element
+  TObjArray *Digits(Int_t cath) const { return fDigits[cath]; } ///< array of digits
+  TObjArray *RawClusters() const { return fRawClus; } ///< array of raw clusters
+  TObjArray *HitsForRec() const { return fHitsForRec; } ///< hits for rec.
+  Int_t NHitsForRec() const { return fNHitsForRec; } ///< No. of hits for rec.
   //Bool_t Inside(Double_t x, Double_t y, Double_t z) const; // check if point inside DE
   Bool_t Inside(Double_t x, Double_t y, Double_t z, Double_t dx, Double_t dy) const; // check if point inside DE
   
-  void SetID(Int_t idDE) { fidDE = idDE; } // set det. elem. ID
-  void SetIndex(Int_t index) { fIndex = index; } // set position index
-  void SetZ(Double_t z) { fZ = z; } // set Z-coord.
-  void SetLeft(Int_t cath, Int_t left) { fLeft[cath] = left; } // set No. of digits
-  //void SetMapElem(const AliMUONDigit *digit, Int_t flag); // set map element 
-  void AddDigit(AliMUONDigit *dig); // add digit
-  void Fill(AliMUONData *data); // fill hit maps 
-  void ClusterReco(Double_t x, Double_t y, Double_t dx, Double_t dy); // run cluster reco around (x,y)
-  void AddHitForRec(AliMUONRawCluster *clus); // make HitForRec
-  // What is necessary for sorting TObjArray's
+  void SetID(Int_t idDE) { fidDE = idDE; } ///< set det. elem. ID
+  void SetIndex(Int_t index) { fIndex = index; } ///< set position index
+  void SetZ(Double_t z) { fZ = z; } ///< set Z-coord.
+  void SetLeft(Int_t cath, Int_t left) { fLeft[cath] = left; } ///< set No. of digits
+  //void SetMapElem(const AliMUONDigit *digit, Int_t flag); ///< set map element 
+  void AddDigit(AliMUONDigit *dig); ///< add digit
+  void Fill(AliMUONData *data); ///< fill hit maps 
+  void ClusterReco(Double_t x, Double_t y, Double_t dx, Double_t dy); ///< run cluster reco around (x,y)
+  void AddHitForRec(AliMUONRawCluster *clus); ///< make HitForRec
+  /// What is necessary for sorting TObjArray's
   Bool_t IsSortable() const { return kTRUE; }
-  Int_t Compare(const TObject* detElem) const; // "Compare" function for sorting
+  Int_t Compare(const TObject* detElem) const; ///< "Compare" function for sorting
 
  private:
   Int_t fidDE; ///< det. elem. ID
@@ -72,7 +72,9 @@ class AliMUONDetElement : public TObject
   AliMUONClusterFinderAZ *fRecModel; ///< cluster finder
 
   // Functions
+  /// Not implemented
   AliMUONDetElement(const AliMUONDetElement & rhs); // copy constructor
+  /// Not implemented
   AliMUONDetElement& operator = (const AliMUONDetElement& rhs); // assignment operator
 
   ClassDef(AliMUONDetElement,0) // detection element object