]> git.uio.no Git - u/mrichter/AliRoot.git/commitdiff
Added some documentation
authorcholm <cholm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Tue, 4 Aug 2009 10:14:03 +0000 (10:14 +0000)
committercholm <cholm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Tue, 4 Aug 2009 10:14:03 +0000 (10:14 +0000)
FMD/flow/AliFMDFlowBessel.h
FMD/flow/AliFMDFlowBin.h
FMD/flow/AliFMDFlowBinned1D.h
FMD/flow/AliFMDFlowEfficiency.h
FMD/flow/AliFMDFlowHarmonic.h
FMD/flow/AliFMDFlowTrue.h
FMD/flow/AliFMDFlowUtil.h

index 5cf6c97e99f27b6c1f5439cdca71b0243416ec57..e9b0e5f1605068650da3daee3fa7429afb7f3612 100644 (file)
     The convinience functions I and DiffI returns a single value
     of @f$ I_{\nu}(x)@f$ or @f$ dI_{\nu}(x)/dx@f$ for a specified
     value of @f$ \nu@f$. 
-    
-    @example test_bessel.cxx */
+
+    @ingroup FMD_flow
+
+    @example TestBessel.cxx */
 
 /** Namespace for Bessel functions 
     @ingroup z_bessel */
index 749b63327b259386a9cb94013d782799eab34285..74da627441395324e8d8f23df3aa14f5ae8d42f4 100644 (file)
 //Forward declaration 
 class TBrowser;
 
+/** @defgroup FMD_flow Flow code
+    @brief Code to do flow analysis. 
+*/
 /** @defgroup c_binned Binned flow 
     @brief This group contains code for binned flow analysis.  Two
     kinds of "histograms" are defined - a 1 dimensional and a 2
     dimensional set of binned objects of class AliFMDFlowBin.   
 
-    Objects of class AliFMDFlowBin contains all the code needed to compute
+    Objects of class hAliFMDFlowBin contains all the code needed to compute
     flow in a given bin.   
 
     The class AliFMDFlowAxis encodes look-up of a object of class
     AliFMDFlowBin in a flow "Histogram"
+
+    @ingroup FMD_flow 
 */
 //______________________________________________________
 /** @class AliFMDFlowBin flow/AliFMDFlowBin.h <flow/AliFMDFlowBin.h>
@@ -62,7 +67,6 @@ class TBrowser;
     AliFMDFlowResolution to calculate the event plane angle
     resolution.
 
-    @ingroup c_binned 
 */
 class AliFMDFlowBin : public TObject
 {
index 2c28c6b015c4a2fd26b47c4302fae6d0a769b606..6f2551616e638e2fd899d12a373ef7718059c97e 100644 (file)
@@ -44,8 +44,7 @@ class TH1;
 /** @class AliFMDFlowBinned1D flow/AliFMDFlowBinned1D.h <flow/AliFMDFlowBinned1D.h>
     @brief A 1 dimensional "histogram" of objects of class AliFMDFlowBin. 
     @ingroup c_binned 
-    @example test_flow.cxx 
-    @example ana_flow.cxx 
+    @example TestFlow.C 
 */
 class AliFMDFlowBinned1D : public TNamed, 
                           public TAttLine, 
index 5b5a8c41a8501c9bc08112c09445768dfeacae04..ebb5511b77b5058756a354547a972726441bf041 100644 (file)
@@ -23,6 +23,8 @@
 /** @defgroup z_eff Efficiency calculations 
     @brief Functions to do efficiency calculations based on a
     Baysian analysis. 
+
+    @ingroup FMD_flow
 */
 /** Namespace for efficency calculations 
     @ingroup z_eff */
index f459976e76db16e0ad0b585bdcafdbde447ee89e..4c0907e41531467dc0116a15f8959f35e69630e9 100644 (file)
@@ -33,7 +33,9 @@ class TBrowser;
 
 /** @defgroup a_basic Basic classes for doing Flow analysis. 
     @brief This group of class handles the low-level stuff to do
-    flow analysis. */
+    flow analysis. 
+    @ingroup FMD_flow
+*/
 //______________________________________________________
 /** @class AliFMDFlowHarmonic flow/AliFMDFlowHarmonic.h <flow/AliFMDFlowHarmonic.h>
     @brief Calculate the @f$ n^{th}@f$ order harmonic
index 0924865e37121e22f16f7359098f3f7db11a0674..7bebac21fb71d55bcb0135bd283a0f9edd8933bd 100644 (file)
@@ -36,7 +36,9 @@
 
 
 /** @defgroup x_true Classes for handling Flow when the event plane is
-    known. */
+    known. 
+
+    @ingroup FMD_flow */
 /** @class TrueBin flow/True.h <flow/True.h>
     @brief A specialised Bin of flow in case the event plane is 
     well-known. 
index 81a6da30fcff9e7fbe9904750094db1e130147f2..5e7d93021c36a504267a0e30e2d09df55efb7dba 100644 (file)
@@ -24,7 +24,9 @@
 #endif
 
 /** @defgroup u_utils Utilities 
-    @brief Group of utility classes and functions */
+    @brief Group of utility classes and functions 
+    @ingroup FMD_flow 
+ */
 //__________________________________________________________________
 /** Normalize the angle @a ang to the interval @f$ [0,2\pi)@f$ 
     @ingroup u_utils