Added some documentation.

Also put in Emacs mode id lines in the header files.

Hans, please add the lines

  // Local Variables:
  //   mode: C++
  // End:

at the bottom of each header file to allow Emacs to handle the headers as C++
rather than C files.  You should also expand and/or add documentation in
all files.  Thanks.

diff --git a/FMD/analysis/AliFMDAnaCalibBackgroundCorrection.h b/FMD/analysis/AliFMDAnaCalibBackgroundCorrection.h
index 1131ed0304aa10bbfe514717e9fbc84d72022fb1..e9b747badf9aa27bc456e2a265f6f8e6a8de8ec5 100644 (file)
--- a/FMD/analysis/AliFMDAnaCalibBackgroundCorrection.h
+++ b/FMD/analysis/AliFMDAnaCalibBackgroundCorrection.h
@@ -10,6 +10,11 @@ class TH2F;
 class TH1F;
 class TBrowser;
 
+/**
+ * @ingroup FMD_ana
+ * @brief Do the background correction
+ * 
+ */
 class AliFMDAnaCalibBackgroundCorrection : public TObject
 {
   
@@ -40,3 +45,6 @@ class AliFMDAnaCalibBackgroundCorrection : public TObject
 };
 
 #endif
+// Local Variables:
+//   mode: C++
+// End:

diff --git a/FMD/analysis/AliFMDAnaCalibEnergyDistribution.h b/FMD/analysis/AliFMDAnaCalibEnergyDistribution.h
index 10c11d8ab1a65fb8aad60cc8cdda4f97bebbd6c9..be3bb885a032005fe092e8567b1340676e92877c 100644 (file)
--- a/FMD/analysis/AliFMDAnaCalibEnergyDistribution.h
+++ b/FMD/analysis/AliFMDAnaCalibEnergyDistribution.h
@@ -5,6 +5,12 @@
 #include <TObjArray.h>
 #include <TH1F.h>
 
+/**
+ * @ingroup FMD_ana
+ * @brief Find most-probable value of MIP peak for one or more
+ * particles. 
+ * 
+ */
 class AliFMDAnaCalibEnergyDistribution : public TObject
 {
   
@@ -30,3 +36,6 @@ class AliFMDAnaCalibEnergyDistribution : public TObject
 };
 
 #endif
+// Local Variables:
+//   mode: C++
+// End:

diff --git a/FMD/analysis/AliFMDAnaParameters.h b/FMD/analysis/AliFMDAnaParameters.h
index d92ebb780ad58eef10b1dd3ab21d1c013bb71ccb..8b646d32005f371c24136cb6a1bda262a1c3263d 100644 (file)
--- a/FMD/analysis/AliFMDAnaParameters.h
+++ b/FMD/analysis/AliFMDAnaParameters.h
@@ -46,6 +46,9 @@
 //  Should get ata fromm Conditions DB.
 //
 
+/**
+ * @ingroup FMD_ana
+ */
 class AliFMDAnaParameters : public TNamed
 {
 public:

diff --git a/FMD/analysis/AliFMDAnalysisTaskBackgroundCorrection.h b/FMD/analysis/AliFMDAnalysisTaskBackgroundCorrection.h
index 94623de101f1a9bb840d1934eb5fe63a2a52ea16..f70e2b564d80c1e835e2e6bfec2fa12fc8aa0c77 100644 (file)
--- a/FMD/analysis/AliFMDAnalysisTaskBackgroundCorrection.h
+++ b/FMD/analysis/AliFMDAnalysisTaskBackgroundCorrection.h
@@ -11,6 +11,12 @@
 #include "TArrayI.h"
 #include "TH1I.h"
 
+/**
+ * @ingroup FMD_ana
+ * @brief Applu the background correction
+ * particles. 
+ * 
+ */
 class AliFMDAnalysisTaskBackgroundCorrection : public AliAnalysisTask
 {
  public:
@@ -57,3 +63,6 @@ class AliFMDAnalysisTaskBackgroundCorrection : public AliAnalysisTask
 };
  
 #endif
+// Local Variables:
+//   mode: C++
+// End:

diff --git a/FMD/analysis/AliFMDAnalysisTaskCollector.h b/FMD/analysis/AliFMDAnalysisTaskCollector.h
index eb0117a8ede5576f237fb1d65a8c010361309830..f2d4242987613e5072d64eaf4a089cde47ac306a 100644 (file)
--- a/FMD/analysis/AliFMDAnalysisTaskCollector.h
+++ b/FMD/analysis/AliFMDAnalysisTaskCollector.h
@@ -14,6 +14,9 @@ class AliAODEvent;
 
 
 
+/**
+ * @ingroup FMD_ana
+ */
 class AliFMDAnalysisTaskCollector : public AliAnalysisTask
 {
  public:
@@ -53,3 +56,6 @@ class AliFMDAnalysisTaskCollector : public AliAnalysisTask
 };
  
 #endif
+// Local Variables:
+//   mode: C++ 
+// End:

diff --git a/FMD/analysis/AliFMDAnalysisTaskDensity.h b/FMD/analysis/AliFMDAnalysisTaskDensity.h
index 91b29d41d7e5d530e9e9629af1a71ab4480170b6..f38c9f6cfc3b42bd046995a0934c9c472070cc08 100644 (file)
--- a/FMD/analysis/AliFMDAnalysisTaskDensity.h
+++ b/FMD/analysis/AliFMDAnalysisTaskDensity.h
@@ -18,6 +18,9 @@ class AliAODEvent;
 class TF1;
 
 
+/**
+ * @ingroup FMD_ana
+ */
 class AliFMDAnalysisTaskDensity : public AliAnalysisTask
 {
  public:
@@ -66,3 +69,6 @@ class AliFMDAnalysisTaskDensity : public AliAnalysisTask
 };
  
 #endif
+// Local Variables:
+//   mode: C++ 
+// End:

diff --git a/FMD/analysis/AliFMDAnalysisTaskDndeta.h b/FMD/analysis/AliFMDAnalysisTaskDndeta.h
index c212907cb82ec3c659f820111af27bd7353d36fb..479c747c175a914a509fdfe4fe6e471543d842a4 100644 (file)
--- a/FMD/analysis/AliFMDAnalysisTaskDndeta.h
+++ b/FMD/analysis/AliFMDAnalysisTaskDndeta.h
@@ -12,6 +12,10 @@
 #include "TH1I.h"
 #include "AliMCEvent.h"
 #include "AliFMDFloatMap.h"
+
+/**
+ * @ingroup FMD_ana
+ */
 class AliFMDAnalysisTaskDndeta : public AliAnalysisTask
 {
  public:
@@ -67,3 +71,6 @@ class AliFMDAnalysisTaskDndeta : public AliAnalysisTask
 };
  
 #endif
+// Local Variables:
+//   mode: C++ 
+// End:

diff --git a/FMD/analysis/AliFMDAnalysisTaskESDReader.h b/FMD/analysis/AliFMDAnalysisTaskESDReader.h
index bb0ebad96b7ec66f09d7c2dbd44dafd6933e966a..e95f2fc99bba79086113df46cb6255eda6c191ed 100644 (file)
--- a/FMD/analysis/AliFMDAnalysisTaskESDReader.h
+++ b/FMD/analysis/AliFMDAnalysisTaskESDReader.h
@@ -16,6 +16,9 @@ class AliAODEvent;
 
 
 
+/**
+ * @ingroup FMD_ana
+ */
 class AliFMDAnalysisTaskESDReader : public AliAnalysisTask
 {
  public:
@@ -45,3 +48,6 @@ class AliFMDAnalysisTaskESDReader : public AliAnalysisTask
 };
  
 #endif
+// Local Variables:
+//   mode: C++ 
+// End:

diff --git a/FMD/analysis/AliFMDAnalysisTaskGenerateBackground.h b/FMD/analysis/AliFMDAnalysisTaskGenerateBackground.h
index 438e97537dbc2f5c00074facb95331896563f2bd..4de2bbd03cb5b010f2411857342c6544662bedc3 100644 (file)
--- a/FMD/analysis/AliFMDAnalysisTaskGenerateBackground.h
+++ b/FMD/analysis/AliFMDAnalysisTaskGenerateBackground.h
@@ -6,6 +6,13 @@
 #include "AliFMDFloatMap.h"
 #include "TH1F.h"
 
+/**
+ * Make a background distribution from simulated data
+ * @ingroup FMD_ana
+ * 
+ * 
+ */
+
 class AliFMDAnaCalibBackgroundCorrection;
 
 class AliFMDAnalysisTaskGenerateBackground : public AliAnalysisTaskSE
@@ -54,3 +61,6 @@ class AliFMDAnalysisTaskGenerateBackground : public AliAnalysisTaskSE
 
 };
 #endif
+// Local Variables:
+//   mode: C++ 
+// End:

diff --git a/FMD/analysis/AliFMDAnalysisTaskSE.h b/FMD/analysis/AliFMDAnalysisTaskSE.h
index 57836abb37923bae398541a83cae68263e690099..2ea9db5080b23957561658cc45dd9e0302e921b2 100644 (file)
--- a/FMD/analysis/AliFMDAnalysisTaskSE.h
+++ b/FMD/analysis/AliFMDAnalysisTaskSE.h
@@ -7,6 +7,24 @@
 #include "AliFMDAnalysisTaskBackgroundCorrection.h"
 #include "AliFMDAnalysisTaskDndeta.h"
 
+/** @defgroup FMD_ana Analysis tasks 
+    @brief Various classes to do analysis tasks 
+*/
+
+/**
+ * @class AliFMDAnalysisTaskSE
+ * @brief Collected analysis task 
+ * @ingroup FMD_ana
+ *
+ * Collector of various analysis tasks.  It will do the full chain of 
+ * analysis tasks:
+ *
+ * - AliFMDAnalysisTaskSharing
+ * - AliFMDAnalysisTaskDensity
+ * - AliFMDAnalysisTaskBackgroundCorrection
+ * - AliFMDAnalysisTaskDndeta
+ */
+
 class AliFMDAnalysisTaskSE : public AliAnalysisTaskSE
 {
  public:
@@ -42,3 +60,6 @@ class AliFMDAnalysisTaskSE : public AliAnalysisTaskSE
 
 };
 #endif
+// Local Variables:
+//  mode: C++ 
+// End:

diff --git a/FMD/analysis/AliFMDAnalysisTaskSharing.h b/FMD/analysis/AliFMDAnalysisTaskSharing.h
index 87e42f44f8bdac36524e7624f55273a4f4c8d04f..cd948a230b6803b9127b07a79534baa0bda7a2c5 100644 (file)
--- a/FMD/analysis/AliFMDAnalysisTaskSharing.h
+++ b/FMD/analysis/AliFMDAnalysisTaskSharing.h
@@ -14,7 +14,12 @@ class TChain;
 class AliAODEvent;
 class AliESDVertex;
 
-
+/**
+ * Do the sharing correction. 
+ * @ingroup FMD_ana
+ * 
+ * 
+ */
 class AliFMDAnalysisTaskSharing : public AliAnalysisTask
 {
  public:
@@ -71,3 +76,6 @@ class AliFMDAnalysisTaskSharing : public AliAnalysisTask
 };
  
 #endif
+// Local Variables:
+//  mode: C++
+// End Variables;