Merge branch 'feature-movesplit'

[u/mrichter/AliRoot.git] / PWGLF / FORWARD / analysis2 / AliMCAuxHandler.h

diff --git a/PWGLF/FORWARD/analysis2/AliMCAuxHandler.h b/PWGLF/FORWARD/analysis2/AliMCAuxHandler.h
index 36a44029093786f048b1030f37e7403f75659020..ce4a4ea27fe8a2c0a617be687cf2a4224e2f1613 100644 (file)
--- a/PWGLF/FORWARD/analysis2/AliMCAuxHandler.h
+++ b/PWGLF/FORWARD/analysis2/AliMCAuxHandler.h
@@ -25,12 +25,14 @@ public:
   /** 
    * Constructor 
    * 
-   * @param name Name 
+   * @param name    Name 
+   * @param clsName Class name of hits 
+   * @param parent  Parent event handler 
    */
   AliMCAuxHandler(const char* name="FMD",
                     const char* clsName="AliFMDHit",
                     AliMCEventHandler* parent=0);
-
+  /** Destructor */
   virtual ~AliMCAuxHandler() {}
   /** 
    * @{
@@ -64,8 +66,6 @@ public:
   /** 
    * Called when the input file is changed 
    * 
-   * @param path New path 
-   *
    * @return true on success
    */
   virtual Bool_t Notify() { return AliMCEventHandler::Notify(); }
@@ -115,9 +115,21 @@ public:
    */
   virtual void  SetNumberOfEventsInContainer(Int_t nev) {
     this->fNEventsInContainer = nev;}
+  /** 
+   * Open a file 
+   * 
+   * @param ev event number 
+   * 
+   * @return true on success
+   */
   virtual Bool_t OpenFile(Int_t ev);
   /* @} */
 
+  /** 
+   * Get the parent handler 
+   * 
+   * @return Parent handler
+   */
   AliMCEventHandler* GetParent() { return fParent; }
   /** 
    * Get the tree 
@@ -125,21 +137,52 @@ public:
    * @return The connected hits tree
    */
   virtual TTree*  GetTree() const { return fTree;}  
+  /** 
+   * Get array of hits 
+   * 
+   * @return Array of hits
+   */
   TClonesArray*  GetArray() const { return fArray; }
+  /** 
+   * Get the number of entries
+   * 
+   * @return Entries in array 
+   */
   Int_t         GetNEntry() const;
+  /** 
+   * Get array of track-refs for an entry 
+   * 
+   * @param entry Entry number 
+   * 
+   * @return Array 
+   */
   TClonesArray* GetEntryArray(Int_t entry);
   /** 
    * Static member function to create and attach this handler 
    * 
    * @param name Name of the handler 
+   * @param what What to get 
    * 
    * @return Newly allocated handler or null
    */
   static AliMCAuxHandler* Create(const char* name="FMD",
                                    const char* what="Hits");
+  /** 
+   * Static member function to get the kinamtics array
+   * 
+   * @param handler   Unput handler
+   * @param particle  Particle number 
+   * 
+   * @return Array of hits 
+   */
   static TClonesArray* GetParticleArray(AliMCAuxHandler* handler, 
                                        Int_t particle);
 protected:
+  /** 
+   * Copy constructor
+   * 
+   * @param o Object to copy from
+   */
   AliMCAuxHandler(const AliMCAuxHandler& o)
     : AliMCEventHandler(), 
       fParent(o.fParent),
@@ -155,6 +198,13 @@ protected:
       fTreeName(""),
       fFileBase("")
   {}
+  /** 
+   * Assignment operator
+   * 
+   * @param o Object to assign from 
+   * 
+   * @return reference to this object 
+   */
   AliMCAuxHandler& operator=(const AliMCAuxHandler& o)
   {
     if (&o == this) return *this;
@@ -164,6 +214,11 @@ protected:
     fTree   = o.fTree;
     return *this;
   }
+  /** 
+   * Get the parent path 
+   * 
+   * @return Parent path
+   */
   TString* GetParentPath() const;
   AliMCEventHandler* fParent; // Parent MC handler 
   TFile*             fFile;                //!