Fix documentation issues
authorcholm <cholm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 7 Jun 2012 09:02:13 +0000 (09:02 +0000)
committercholm <cholm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 7 Jun 2012 09:02:13 +0000 (09:02 +0000)
PWGLF/FORWARD/analysis2/corrs/CompareCentralSecMaps.C
PWGLF/FORWARD/analysis2/corrs/CompareCorrs.C
PWGLF/FORWARD/analysis2/corrs/DrawAnaELoss.C
PWGLF/FORWARD/analysis2/corrs/DrawCorrCentralSecMap2.C
PWGLF/FORWARD/analysis2/corrs/MakeCorrRepository.C

index 252ba59..d01f99c 100644 (file)
@@ -1,6 +1,8 @@
 /**
  * @defgroup pwglf_forward_scripts_corr Correction scripts 
  * 
+ * Scripts and functions to handle corrections 
+ *
  * @ingroup pwglf_forward_scripts
  */
 
index 3510c93..29ef3ed 100644 (file)
@@ -21,7 +21,7 @@
 
 //======================================================================
 /**
- * 
+ * A canvas 
  * 
  *
  * @ingroup pwglf_forward_scripts_corr
 struct Canvas 
 {
   //____________________________________________________________________
+  /** 
+   * CTOR
+   * 
+   * @param name  Name 
+   * @param title Title 
+   * @param n1    N1, 
+   * @param n2    N2 
+   */  
   Canvas(const char* name, const char* title,
         const char* n1,   const char* n2)
     : fName(name),
@@ -47,6 +55,10 @@ struct Canvas
     gStyle->SetTitleBorderSize(0);
   }
   //____________________________________________________________________
+  /** 
+   * Open it
+   * 
+   */
   void Open() 
   {
     fCanvas = new TCanvas(fName, fTitle, 800, TMath::Sqrt(2)*800);
@@ -55,6 +67,15 @@ struct Canvas
     fCanvas->Print("comparison.pdf[", "pdf");
   }
   //____________________________________________________________________
+  /** 
+   * Clear pad 
+   * 
+   * @param nPad Pad number 
+   * @param d    Detector
+   * @param r    Ring 
+   * 
+   * @return Pointer to pad 
+   */
   TPad* 
   Clear(UShort_t nPad, UShort_t d, Char_t r)
   {
@@ -80,6 +101,13 @@ struct Canvas
     return fBody;
   }  
   //____________________________________________________________________
+  /** 
+   * Change to pad 
+   * 
+   * @param i Pad number 
+   * 
+   * @return Pointer to pad 
+   */
   TVirtualPad* cd(Int_t i) 
   {
     if (!fBody) return 0;
@@ -87,22 +115,39 @@ struct Canvas
     return fBody->cd(i);
   }
   //____________________________________________________________________
+  /** 
+   * Print information
+   * 
+   * @param d Detector
+   * @param r Ring 
+   * @param extra  more stuff
+   */
   void Print(UShort_t d, Char_t r, const char* extra="")
   {
     fCanvas->Print("comparison.pdf", 
                   Form("Title:FMD%d%c %s", d, r, extra));
   }
   //____________________________________________________________________
+  /** 
+   * Close it 
+   * 
+   */
   void Close()
   {
     fCanvas->Print("comparison.pdf]", "pdf");
   }    
   //____________________________________________________________________
+  /// NAme 
   const char* fName;
+  /// Title
   const char* fTitle;
+  /// N1
   const char* fN1;
+  /// N2
   const char* fN2;
+  /// Canvas
   TCanvas*    fCanvas;
+  /// Body 
   TPad*       fBody;
 };
 
index 1651a78..3a5e5a4 100644 (file)
 
 //____________________________________________________________________
 // Global 
+/** List of fitters */
 TList* fitter = 0;
+/** Canvas */
 TCanvas* canvas = 0;
+/** Name of output file */
 const char* pdfName = "FitResults.pdf";
+/** Produce plots in landscape mode */
 bool landscape = true;
 
 //____________________________________________________________________
@@ -195,11 +199,10 @@ AddToStack(TList* stacks, TList* list, const char* name)
 /** 
  * Draw summary 
  * 
- * @param fname 
+ * @param fname       File name to read 
+ * @param onlySummary Only plot summary pae 
  * 
  * @ingroup pwglf_forward_scripts_corr
- *
- * @ingroup pwglf_forward_scripts_corr
  */
 void DrawSummary(const char* fname="forward_eloss.root", 
                 bool onlySummary=true)
@@ -477,7 +480,8 @@ void DrawEtaBins(const char* fname="AnalysisResults.root")
  *           ...
  * @endverbatim
  *
- * @param fname 
+ * @param fname       File name to read 
+ * @param onlySummary Only plot summary pae 
  * 
  * @ingroup pwglf_forward_scripts_corr
  */
index 0869cf9..fe02181 100644 (file)
@@ -22,6 +22,10 @@ ClearCanvas(TCanvas* c)
   c->Clear();
 }
 
+/** 
+ * Load the needed libraries
+ * 
+ */
 void
 LoadLibraries()
 {
index dd104e1..33b69c6 100644 (file)
@@ -1,5 +1,5 @@
 /** 
- * 
+ * Make the repository for corrections
  * 
  *
  * @ingroup pwglf_forward_scripts_corr
@@ -31,3 +31,6 @@ MakeCorrRepository()
  }
 }
 
+/*
+ * EOF 
+ */