Doxygen warnings fixed
authorlaphecet <laphecet@f7af4fe6-9843-0410-8265-dc069ae4e863>
Fri, 4 Apr 2008 15:01:52 +0000 (15:01 +0000)
committerlaphecet <laphecet@f7af4fe6-9843-0410-8265-dc069ae4e863>
Fri, 4 Apr 2008 15:01:52 +0000 (15:01 +0000)
MUON/AliMUONManuPadPainter.h
MUON/AliMUONPainterRegistry.h
MUON/AliMUONPreClusterFinder.h
MUON/AliMUONTrackerDataCompareDialog.h
MUON/AliMUONTrackerDataHistogrammer.h
MUON/AliMUONTrackerDataWrapper.h
MUON/AliMUONVPainter.h

index 40f098eb9e44a917dac1cc1cbc9ff86d92da0da2..9454a4c131399571923fcedcea8582bac88d7943 100644 (file)
@@ -52,6 +52,7 @@ public:
   
   void PaintOutline(Int_t color=-1, Int_t width=-1, Double_t x=FLT_MAX, Double_t y=FLT_MAX);
 
+  /// Whether this painter can be detached from the current view.
   Bool_t CanBeDetached() const { return kFALSE; }
 
   virtual void DrawHistogramClone(Double_t* values=0x0) const;
index 5e0fb2ab1e631e0069f3ffc467727b2947623cd9..3417059da0bd12445a4320f0394b81bb73b7a6dd 100644 (file)
@@ -53,6 +53,7 @@ public:
   
   Int_t NumberOfDataMakers() const;
 
+  /// Number of data sources = data makers
   Int_t NumberOfDataSources() const { return NumberOfDataMakers(); }
 
   Int_t NumberOfPainterMatrices() const;
index df17032704d98046292210c55dfda60a98106fbc..6ff9f7f4914f656901a9c6e0ac73e2d55b2f78a4 100644 (file)
@@ -48,6 +48,7 @@ private:
   
   AliMUONPad* GetNextPad(Int_t cathode) const;
 
+  /// Whether we should stop working...
   virtual Bool_t ShouldAbort() const { return fShouldAbort; }
   
 private:
index e07d43b85551acf948ee48c5dc181f619a34a403..cca58bcc440816d56beabbe2fba139d53f3d1cf6 100644 (file)
@@ -33,7 +33,9 @@ public:
   
 private:
   
+    /// not defined
     AliMUONTrackerDataCompareDialog(const AliMUONTrackerDataCompareDialog& rhs);
+  /// not defined
   AliMUONTrackerDataCompareDialog& operator=(const AliMUONTrackerDataCompareDialog& rhs);
 
   void CompareData(const char* d1name, const char* d2name, Int_t difftype) const;
@@ -57,11 +59,11 @@ private:
   TGTextButton* fOK; ///< ok button
   TGTextButton* fCancel; ///< cancel button
   
-  static const Int_t fgkDifference; /// D1-D2
-  static const Int_t fgkAbsoluteDifference; /// |D1-D2|
-  static const Int_t fgkRelativeDifference; /// (D1-D2)/D1
-  static const Int_t fgkAbsoluteRelativeDifference; /// | (D1-D2) | / | D1 |
-  static const Int_t fgkAll; /// All four differences at once
+  static const Int_t fgkDifference; ///< D1-D2
+  static const Int_t fgkAbsoluteDifference; ///< |D1-D2|
+  static const Int_t fgkRelativeDifference; ///< (D1-D2)/D1
+  static const Int_t fgkAbsoluteRelativeDifference; ///< | (D1-D2) | / | D1 |
+  static const Int_t fgkAll; ///< All four differences at once
   
   ClassDef(AliMUONTrackerDataCompareDialog,1) // Dialog to select two data sources to compare
 };
index d7e6a017ec27f8b0e4cc79ef013068c348afcb88..bb7e1c55cb2a4e5712a13005d33915063fb75bd0 100644 (file)
@@ -36,6 +36,7 @@ public:
   TH1* CreateChannelHisto(Int_t detElemId, Int_t manuId, 
                           Int_t manuChannel) const;
     
+  /// Whether we are working with internal dimensions or external ones.
   Bool_t IsInternalMode() const { return fInternalDim >=0; }
   
 private:
index 0ba9647027dd1af539c6780155c5016c6f04790c..a1bef1e9d1467d45460709132cac5bba483596fb 100644 (file)
@@ -59,7 +59,9 @@ public:
   virtual Long64_t Merge(TCollection* li);
   
 private:
+    /// not implemented.
     AliMUONTrackerDataWrapper(const AliMUONTrackerDataWrapper& rhs);
+  /// not implemented.
   AliMUONTrackerDataWrapper& operator=(const AliMUONTrackerDataWrapper& rhs);
   
 private:
index f0804a390329f432a35dacc86436ee30b33efe03..33cd6991df34119d182d46cf68e24a37a8dbad14 100644 (file)
@@ -71,6 +71,7 @@ public:
   
   AliMUONVPainter* Detach() const;
   
+  /// Whether this painter can be detached from the current view.
   virtual Bool_t CanBeDetached() const { return kTRUE; }
   
   /// Whether we are valid or not
@@ -217,6 +218,7 @@ public:
 
   /// To avoid getting a popup asking for the parameter in the GUI...
   void DrawHistogram0() const { DrawHistogram(0x0); }
+  /// To avoid getting a popup asking for the parameter in the GUI...
   void DrawHistogramClone0() const { DrawHistogramClone(0x0); }
 
   virtual void DrawHistogramClone(Double_t* values=0x0) const;
@@ -228,19 +230,28 @@ public:
   /// Append (i.e. don't have the right to clear the array !) our list of manus to manuList
   virtual void FillManuList(TObjArray& manuList) const;
   
-  /// following kind of stupid lines, because I don't know how to
+  /// following kind of stupid lines (SL), because I don't know how to
   /// pass parameters to TClassMenuItem for context menu (don't even
   /// know if that's possible at all)
-  
+  /// SL
   void DrawInternalHistogramClone0() { DrawInternalHistogramClone(0); }
+  /// SL
   void DrawInternalHistogramClone1() { DrawInternalHistogramClone(1); }
+  /// SL
   void DrawInternalHistogramClone2() { DrawInternalHistogramClone(2); }
+  /// SL
   void DrawInternalHistogramClone3() { DrawInternalHistogramClone(3); }
+  /// SL
   void DrawInternalHistogramClone4() { DrawInternalHistogramClone(4); }
+  /// SL
   void DrawInternalHistogramClone5() { DrawInternalHistogramClone(5); }
+  /// SL
   void DrawInternalHistogramClone6() { DrawInternalHistogramClone(6); }
+  /// SL
   void DrawInternalHistogramClone7() { DrawInternalHistogramClone(7); }
+  /// SL
   void DrawInternalHistogramClone8() { DrawInternalHistogramClone(8); }
+  /// SL
   void DrawInternalHistogramClone9() { DrawInternalHistogramClone(9); }
   
 protected: