more docu

src/include/PRunBase.h

@@ -44,7 +44,7 @@ using namespace std;
 
 //------------------------------------------------------------------------------------------
 /**
- * <p>
+ * <p>The run base class is enforcing a common interface to all supported fit-types.
  */
 class PRunBase
 {
@@ -53,24 +53,24 @@ class PRunBase
     PRunBase(PMsrHandler *msrInfo, PRunDataHandler *rawData, UInt_t runNo, EPMusrHandleTag tag);
     virtual ~PRunBase();
 
-    virtual Double_t CalcChiSquare(const vector<Double_t>& par) = 0; // pure virtual, i.e. needs to be implemented by the deriving class!!
-    virtual Double_t CalcMaxLikelihood(const vector<Double_t>& par) = 0; // pure virtual, i.e. needs to be implemented by the deriving class!!
+    virtual Double_t CalcChiSquare(const vector<Double_t>& par) = 0; ///< pure virtual, i.e. needs to be implemented by the deriving class!!
+    virtual Double_t CalcMaxLikelihood(const vector<Double_t>& par) = 0; ///< pure virtual, i.e. needs to be implemented by the deriving class!!
 
-    virtual void CalcTheory() = 0; // pure virtual, i.e. needs to be implemented by the deriving class!!
+    virtual void CalcTheory() = 0; ///< pure virtual, i.e. needs to be implemented by the deriving class!!
 
-    virtual UInt_t GetRunNo() { return fRunNo; }
-    virtual PRunData* GetData() { return &fData; }
+    virtual UInt_t GetRunNo() { return fRunNo; } ///< returns the number of runs of the msr-file
+    virtual PRunData* GetData() { return &fData; } ///< returns the data to be fitted
     virtual void CleanUp();
-    virtual Bool_t IsValid() { return fValid; }
+    virtual Bool_t IsValid() { return fValid; } ///< returns if the state is valid
 
   protected:
-    Bool_t fValid;
+    Bool_t fValid; ///< flag showing if the state of the class is valid
 
     EPMusrHandleTag fHandleTag; ///< tag telling whether this is used for fit, view, ...
 
     Int_t fRunNo;               ///< number of the run within the msr file
     PMsrHandler      *fMsrInfo; ///< msr-file handler
-    PMsrRunBlock     *fRunInfo; ///< run info used to filter out needed infos for the run
+    PMsrRunBlock     *fRunInfo; ///< run info used to filter out needed infos of a run
     PRunDataHandler  *fRawData; ///< holds the raw run data
 
     PIntVector fParamNo;        ///< vector of parameter numbers for the specifc run
@@ -82,9 +82,9 @@ class PRunBase
     PDoubleVector fFuncValues;  ///< is keeping the values of the functions from the FUNCTIONS block
     PTheory *fTheory;           ///< theory needed to calculate chi-square
 
-    PDoubleVector fKaiserFilter;
+    PDoubleVector fKaiserFilter; ///< stores the Kaiser filter vector (needed for the RRF).
 
-    virtual Bool_t PrepareData() = 0; // pure virtual, i.e. needs to be implemented by the deriving class!!
+    virtual Bool_t PrepareData() = 0; ///< pure virtual, i.e. needs to be implemented by the deriving class!!
 
     virtual void CalculateKaiserFilterCoeff(Double_t wc, Double_t A, Double_t dw);
     virtual void FilterTheo();

src/include/PRunDataHandler.h

@@ -40,6 +40,9 @@ using namespace std;
 #include "PMusr.h"
 #include "PMsrHandler.h"
 
+/**
+ * <p>Handler class needed to read/handle raw data files.
+ */
 class PRunDataHandler
 {
   public:
@@ -51,8 +54,8 @@ class PRunDataHandler
     virtual PRawRunData* GetRunData(const TString &runName);
 
   private:
-    PMsrHandler   *fMsrInfo;
-    PStringVector fDataPath;
+    PMsrHandler   *fMsrInfo; ///< pointer to the msr-file handler
+    PStringVector fDataPath; ///< vector containing all the search paths where to look for data files
 
     Bool_t fAllDataAvailable; ///< flag indicating if all data sets could be read
     TString fRunName;       ///< current run name

src/include/PRunListCollection.h

@@ -43,6 +43,9 @@ using namespace std;
 #include "PRunMuMinus.h"
 #include "PRunNonMusr.h"
 
+/**
+ * <p>Handler class handling all processed data of an msr-file. All calls of minuit2 are going through this class.
+ */
 class PRunListCollection
 {
   public:
@@ -65,10 +68,10 @@ class PRunListCollection
 
     virtual UInt_t GetTotalNoOfBinsFitted() const;
 
-    virtual UInt_t GetNoOfSingleHisto() const { return fRunSingleHistoList.size(); }
-    virtual UInt_t GetNoOfAsymmetry() const { return fRunAsymmetryList.size(); }
-    virtual UInt_t GetNoOfMuMinus() const { return fRunMuMinusList.size(); }
-    virtual UInt_t GetNoOfNonMusr() const { return fRunNonMusrList.size(); }
+    virtual UInt_t GetNoOfSingleHisto() const { return fRunSingleHistoList.size(); } ///< returns the number of single histogram data sets present in the msr-file
+    virtual UInt_t GetNoOfAsymmetry() const { return fRunAsymmetryList.size(); }     ///< returns the number of asymmetry data sets present in the msr-file
+    virtual UInt_t GetNoOfMuMinus() const { return fRunMuMinusList.size(); }         ///< returns the number of mu minus data sets present in the msr-file
+    virtual UInt_t GetNoOfNonMusr() const { return fRunNonMusrList.size(); }         ///< returns the number of non-muSR data sets present in the msr-file
 
     virtual PRunData* GetSingleHisto(UInt_t index, EDataSwitch tag=kIndex);
     virtual PRunData* GetAsymmetry(UInt_t index, EDataSwitch tag=kIndex);
@@ -83,13 +86,13 @@ class PRunListCollection
     virtual const Char_t* GetYAxisTitle(const TString &runName, const UInt_t idx) const;
 
   private:
-    PMsrHandler *fMsrInfo;  ///< keeps all msr file info
-    PRunDataHandler *fData; ///< handles all raw data
+    PMsrHandler *fMsrInfo;  ///< pointer to the msr-file handler
+    PRunDataHandler *fData; ///< pointer to the run-data handler
 
-    vector<PRunSingleHisto*> fRunSingleHistoList;
-    vector<PRunAsymmetry*>   fRunAsymmetryList;
-    vector<PRunMuMinus*>     fRunMuMinusList;
-    vector<PRunNonMusr*>     fRunNonMusrList;
+    vector<PRunSingleHisto*> fRunSingleHistoList; ///< stores all precessed single histogram data
+    vector<PRunAsymmetry*>   fRunAsymmetryList;   ///< stores all precessed asymmetry data
+    vector<PRunMuMinus*>     fRunMuMinusList;     ///< stores all precessed mu-minus data
+    vector<PRunNonMusr*>     fRunNonMusrList;     ///< stores all precessed non-muSR data
 };
 
 #endif // _PRUNLISTCOLLECTION_H_