Documentation fixes for Doxygen
authorcholm <cholm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 7 Jul 2011 08:37:49 +0000 (08:37 +0000)
committercholm <cholm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 7 Jul 2011 08:37:49 +0000 (08:37 +0000)
19 files changed:
PWG2/FORWARD/analysis2/AddTaskCentraldNdeta.C
PWG2/FORWARD/analysis2/AddTaskForwardFlow.C
PWG2/FORWARD/analysis2/AddTaskForwarddNdeta.C
PWG2/FORWARD/analysis2/AliBasedNdetaTask.h
PWG2/FORWARD/analysis2/AliCentralMCCorrectionsTask.h
PWG2/FORWARD/analysis2/AliFMDCorrELossFit.h
PWG2/FORWARD/analysis2/AliFMDMCDensityCalculator.h
PWG2/FORWARD/analysis2/AliFMDMCTrackDensity.h
PWG2/FORWARD/analysis2/AliFMDSharingFilter.h
PWG2/FORWARD/analysis2/AliForwardMCCorrectionsTask.h
PWG2/FORWARD/analysis2/AliForwardMultiplicityBase.h
PWG2/FORWARD/analysis2/AliForwarddNdetaTask.h
PWG2/FORWARD/analysis2/AliMCTruthdNdetaTask.h
PWG2/FORWARD/analysis2/AliSPDMCTrackDensity.h
PWG2/FORWARD/analysis2/DrawdNdeta.C
PWG2/FORWARD/analysis2/MakeMCCorr.C
PWG2/FORWARD/analysis2/MakedNdeta.C
PWG2/FORWARD/analysis2/OtherData.C
PWG2/FORWARD/analysis2/SPDComparison.C

index 270c1b8..99fc42c 100644 (file)
@@ -18,6 +18,7 @@
  * @param useCent   Whether to use the centrality or not
  * @param scheme    Normalisation scheme
  * @param cutEdges  Whether to cut edges when rebinning 
+ * @param mcanalysisfilename Take final MC corrections from this - if present
  * 
  * @return Newly created and configured task
  *
index bd2b320..b525187 100644 (file)
@@ -17,7 +17,6 @@
  * 
  * @param type 
  * @param etabins 
- * @param zVertex 
  * @param addFlow 
  * @param addFType 
  * @param addFOrder 
index d9dc1a7..fe90312 100644 (file)
@@ -18,6 +18,7 @@
  * @param useCent   Whether to use the centrality or not
  * @param scheme    Normalisation scheme
  * @param cutEdges  Whether to cut edges when rebinning 
+ * @param mcanalysisfilename Take final MC corrections from this - if present
  * 
  * @return Newly created and configured task
  *
index ed0a338..e40fb8b 100644 (file)
@@ -611,6 +611,9 @@ protected:
      * @param rebin      Whether to rebin
      * @param cutEdges   Whether to cut edges when rebinning 
      * @param marker     Marker style 
+     * @param color       Color of markers 
+     * @param mclist      List of MC data 
+     * @param truthlist   List of MC truth data 
      */
     virtual void MakeResult(const TH2D* sum,  
                            const char* postfix, 
@@ -640,6 +643,9 @@ protected:
      * @param cutEdges    Whether to cut edges when rebinning
      * @param triggerMask Trigger mask 
      * @param marker      Marker style 
+     * @param color       Color of markers 
+     * @param mclist      List of MC data 
+     * @param truthlist   List of MC truth data 
      */
     virtual void End(TList*      sums, 
                     TList*      results,
index 95dc890..09fd219 100644 (file)
@@ -180,6 +180,7 @@ protected:
      * @param low       Lower @f$v_z@f$ bound
      * @param high      Upper @f$v_z@f$ bound
      * @param etaAxis   @f$\eta@f$ axis to use 
+     * @param nPhi      Number of phi bins 
      */
     VtxBin(Double_t low, Double_t high, const TAxis& etaAxis, UShort_t nPhi);
     /** 
@@ -214,7 +215,10 @@ protected:
     /** 
      * End of job process 
      * 
-     * @param o List to add output to 
+     * @param o   List to add output to 
+     * @param i   Input list
+     * @param iVz Vertex bin 
+     * @param map Correctons map 
      */
     void Finish(const TList* i, 
                TList* o,
index acf7115..41f841f 100644 (file)
@@ -644,14 +644,15 @@ public:
    *
    */
   void Print(Option_t* option="R") const; //*MENU*
-    /** 
-     * Get a list of THStack - one for each parameter 
-     * 
-     * @param err Show errors
-     * @param rel Show relative errors 
-     * 
-     * @return List of THStack
-     */
+  /** 
+   * Get a list of THStack - one for each parameter 
+   * 
+   * @param err  Show errors
+   * @param rel  Show relative errors 
+   * @param maxN Maximum weight to use 
+   * 
+   * @return List of THStack
+   */
   TList* GetStacks(Bool_t err, Bool_t rel, UShort_t maxN=5) const;
   /* @} */
 protected:
index 7e58a9b..3b25cdb 100644 (file)
@@ -180,10 +180,11 @@ protected:
    */
   TH2D* Make(UShort_t d, Char_t r) const;
   /** 
-   * MAke comparison profiles
+   * Make comparison profiles
    * 
    * @param d     Detector 
    * @param r     Ring 
+   * @param max   Maximum 
    * 
    * @return Newly allocated profile object
    */
index dfd894a..bd32f44 100644 (file)
@@ -153,7 +153,7 @@ protected:
    * Get ultimate mother of a track 
    * 
    * @param iTr   Track number 
-   * @param stack Stack 
+   * @param event Event
    * 
    * @return Pointer to mother or null 
    */
index 3445343..5c84484 100644 (file)
@@ -165,9 +165,9 @@ public:
    * 
    * Set the fraction of MPV
    * 
-   * @param u if true cut at fraction of MPV 
+   * @param cut Fraction of MPV
    */
-  void SetFractionOfMPV(Double_t cut) { fHCuts.SetMPVFraction(cut); /* fFractionOfMPV = cut;*/ }
+  void SetFractionOfMPV(Double_t cut) { fHCuts.SetMPVFraction(cut); }
   /** 
    * Scale the histograms to the total number of events 
    * 
index 7ea9511..2855d6a 100644 (file)
@@ -218,7 +218,10 @@ protected:
     /** 
      * End of job process 
      * 
-     * @param o List to add output to 
+     * @param o   List to add output to 
+     * @param i   Input 
+     * @param iVz Vertex bin
+     * @param map Corrections map 
      */
     void Finish(const TList*            i, 
                TList*                  o,
index 558c6ca..76fab61 100644 (file)
@@ -308,15 +308,17 @@ protected:
    * 
    * @param input      List with summed signals 
    * @param output     Output list 
-   * @param stackName  Stack name 
+   * @param inName     Input name 
+   * @param outName    Output name
+   * @param style      Style 
    */
   virtual void MakeRingdNdeta(const TList* input, 
                              const char*  inName,
                              TList*       output,
                              const char*  outName,
                              Int_t        style=20) const;
-  Bool_t                 fEnableLowFlux;// Whether to use low-flux specific code
-  Bool_t                 fFirstEvent;   // Whether the event is the first seen 
+  Bool_t fEnableLowFlux;// Whether to use low-flux specific code
+  Bool_t fFirstEvent;   // Whether the event is the first seen 
 private:
   /**
    * A pointer to the corrections manager.  This is here to make the
index 605913e..706fb88 100644 (file)
@@ -133,6 +133,8 @@ protected:
      * @param triggerMask Trigger mask 
      * @param color       Marker colour 
      * @param marker      Marker style 
+     * @param mclist      List of MC results 
+     * @param truthlist   List of MC truth results 
      */
     virtual void End(TList*      sums, 
                     TList*      results,
index 79da3e1..ccb6a79 100644 (file)
@@ -171,6 +171,8 @@ protected:
      * @param triggerMask Trigger mask 
      * @param color       Marker colour 
      * @param marker      Marker style 
+     * @param mclist      List of MC results 
+     * @param truthlist   List of MC truth results 
      */
     virtual void End(TList*      sums, 
                     TList*      results,
index d983f59..29695af 100644 (file)
@@ -109,6 +109,8 @@ protected:
    * 
    * @param particle  Particle to store
    * @param mother    Ultimate mother 
+   * @param refNo     Reference number
+   * @param vz        Vertex z coordinate 
    * @param output    Output structure 
    */  
   void StoreParticle(AliMCParticle*       particle, 
@@ -120,7 +122,7 @@ protected:
    * Get ultimate mother of a track 
    * 
    * @param iTr   Track number 
-   * @param stack Stack 
+   * @param event Event
    * 
    * @return Pointer to mother or null 
    */
index 7883d71..8e487dc 100644 (file)
@@ -8,7 +8,7 @@
  * This script is independent of any AliROOT code - and should stay
  * that way.
  * 
- * The script is <emph>very</emph> long - sigh - the joy of drawing
+ * The script is @i very long - sigh - the joy of drawing
  * things nicely in ROOT
  * 
  * @ingroup pwg2_forward_dndeta
@@ -822,7 +822,6 @@ struct dNdetaDrawer
   /** 
    * Build centrality legend 
    * 
-   * @param axis    Stack to include 
    * @param x1      Lower X coordinate in the range [0,1]
    * @param y1      Lower Y coordinate in the range [0,1]
    * @param x2      Upper X coordinate in the range [0,1]
@@ -1637,10 +1636,10 @@ struct dNdetaDrawer
    * Fix the apperance of the axis in a stack
    *
    * @param stack  stack of histogram
-   * @param s      Scaling factor
+   * @param yd     How the canvas is cut
    * @param ytitle Y axis title
-   * @param force  Whether to draw the stack first or not
    * @param ynDiv  Divisions on Y axis
+   * @param force  Whether to draw the stack first or not
    */
   void FixAxis(THStack* stack, Double_t yd, const char* ytitle,
                Int_t ynDiv=210, Bool_t force=true)
@@ -1773,6 +1772,8 @@ struct dNdetaDrawer
    * Make band of systematic errors 
    * 
    * @param tmp Histogram
+   * @param cen Central 
+   * @param fwd Forward 
    * @param fit Fit 
    */
   void
@@ -2051,10 +2052,10 @@ Usage()
  * Draw @f$ dN/d\eta@f$ 
  * 
  * @param filename  File name 
- * @param flags     Flags 
  * @param title     Title 
  * @param rebin     Rebinning factor 
- * @param cutEdges  Whether to cut edges when rebinning
+ * @param others    What other data to show 
+ * @param flags     Flags 
  * @param sNN       (optional) Collision energy [GeV]
  * @param sys       (optional) Collision system (1: pp, 2: PbPb)
  * @param trg       (optional) Trigger (1: INEL, 2: INEL>0, 4: NSD)   
index 604a7fe..bccfef0 100644 (file)
  * in a sub-directory named by @a name after escaping spaces and special 
  * characters 
  * 
- * @param aoddir     AOD input directory. Any file matching the pattern 
+ * @param esddir     AOD input directory. Any file matching the pattern 
  *                   *AliAODs*.root are added to the chain 
  * @param nEvents    Number of events to process.  If 0 or less, then 
  *                   all events are analysed
- * @param trig       Trigger to use 
- * @param useCent    Whether to use centrality or not 
- * @param scheme     Normalisation scheme 
  * @param vzMin      Least @f$ v_z@f$ (centimeter)
  * @param vzMax      Largest @f$ v_z@f$ (centimeter)
  * @param proof      If larger then 1, run in PROOF-Lite mode with this 
index 1d4f9a5..c01f7e0 100644 (file)
@@ -29,6 +29,7 @@
  *                   many number of workers. 
  * @param name       Name of train - free form.  This will be the name
  *                   of the output directory if the plug-in is used 
+ * @param mcfile     Final MC corrections from this, if present
  *
  * @ingroup pwg2_forward_dndeta
  */
index 2abf54d..d115d14 100644 (file)
@@ -1273,7 +1273,7 @@ AppendItem(TString& s, char delim, const char* what)
  *   - 0x4 NSD 
  * @param centLow   Low centrality cut (only for PbPB)
  * @param centHigh  High centrality cut (only for PbPB)
- * @param aliceOnly Only return other ALICE data
+ * @param which     What to get
  * 
  * @return A multi graph with the selected data. 
  * 
@@ -1381,7 +1381,7 @@ GetData(UShort_t sys,
  *   - 0x4 NSD 
  * @param centLow   Low centrality cut (only for PbPB)
  * @param centHigh  High centrality cut (only for PbPB)
- * @param alice Only return other ALICE data
+ * @param which     Which data to show 
  * 
  * @ingroup pwg2_forward_otherdata
  */
index 52fd277..06f4975 100644 (file)
@@ -1,5 +1,5 @@
 /**
- * @mainpage Forward/Backward Correlations 
+ * @section Forward/Backward Correlations 
  * 
  * A script containing a class ForwardBackwardTask and a
  * function to run the analysis.
@@ -498,7 +498,7 @@ protected:
 /** 
  * Run the analysis 
  * 
- * @param aoddir  Input directory 
+ * @param esddir  Input directory 
  * @param nEvents Number of events, negative means all 
  */
 void