coding conventions and documentation

[u/mrichter/AliRoot.git] / HLT / TPCLib / AliHLTTPCGlobalMergerComponent.h

diff --git a/HLT/TPCLib/AliHLTTPCGlobalMergerComponent.h b/HLT/TPCLib/AliHLTTPCGlobalMergerComponent.h
index 97722c95ba14904e135958615edc51504a64e650..0a09d0b50a42fe0607c4a1d8ab3a46ef7b70c58a 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCGlobalMergerComponent.h
+++ b/HLT/TPCLib/AliHLTTPCGlobalMergerComponent.h
@@ -6,32 +6,58 @@
 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
  * See cxx source for full Copyright notice                               */
 
-/* AliHLTTPCGlobalMergerComponent
- */
+/** @file   AliHLTTPCGlobalMergerComponent.h
+    @author Timm Steinbeck, Matthias Richter
+    @date   
+    @brief  HLT TPC global merger component.
+*/
 
 #include "AliHLTProcessor.h"
-#include "AliHLTTPCDefinitions.h"
 
 class AliHLTTPCGlobalMerger;
 class AliHLTTPCVertex;
 
+/**
+ * @class AliHLTTPCGlobalMergerComponent
+ * The TPC global merger component
+ * The component is the interface to the AliHLTGlobalMerger processing
+ * class.
+ */
 class AliHLTTPCGlobalMergerComponent : public AliHLTProcessor
     {
     public:
-       AliHLTTPCGlobalMergerComponent();
-       virtual ~AliHLTTPCGlobalMergerComponent();
+      /** standard constructor */
+      AliHLTTPCGlobalMergerComponent();
+      /** not a valid copy constructor, defined according to effective C++ style */
+      AliHLTTPCGlobalMergerComponent(const AliHLTTPCGlobalMergerComponent&);
+      /** not a valid assignment op, but defined according to effective C++ style */
+      AliHLTTPCGlobalMergerComponent& operator=(const AliHLTTPCGlobalMergerComponent&);
+      /** standard destructor */
+      virtual ~AliHLTTPCGlobalMergerComponent();
 
        // Public functions to implement AliHLTComponent's interface.
        // These functions are required for the registration process
 
+      /** @see component interface @ref AliHLTComponent::GetComponentID */
        const char* GetComponentID();
+      
+      /** @see component interface @ref AliHLTComponent::GetInputDataTypes */
        void GetInputDataTypes( vector<AliHLTComponentDataType>& list);
+
+      /** @see component interface @ref AliHLTComponent::GetOutputDataType */
        AliHLTComponentDataType GetOutputDataType();
+
+      /** @see component interface @ref AliHLTComponent::GetOutputDataSize */
        virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
+
+      /** @see component interface @ref AliHLTComponent::Spawn */
        AliHLTComponent* Spawn();
-       
+
     protected:
        
+      /**
+       * Set the parameters
+       */
        void SetMergerParameters(Double_t maxy=2.0,Double_t maxz=3.0,Double_t maxkappa=0.003,
                                 Double_t maxpsi=0.1,Double_t maxtgl=0.05);
 
@@ -39,25 +65,37 @@ class AliHLTTPCGlobalMergerComponent : public AliHLTProcessor
        // These functions provide initialization as well as the actual processing
        // capabilities of the component. 
 
+
+      /** @see component interface @ref AliHLTComponent::DoInit */
        int DoInit( int argc, const char** argv );
+
+      /** @see component interface @ref AliHLTComponent::DoDeinit */
        int DoDeinit();
+
+      /** @see component interface @ref AliHLTProcessor::DoEvent */
        int DoEvent( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks, 
                     AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, 
                     AliHLTUInt32_t& size, vector<AliHLTComponentBlockData>& outputBlocks );
        
     private:
 
-       AliHLTTPCGlobalMerger* fGlobalMerger;
-       AliHLTTPCVertex* fVertex;
-
-       struct SliceData
-           {
-               int fSlice;
-               const AliHLTComponentBlockData* fVertexBlock;
-               unsigned fVertexBlockIndex;
-               const AliHLTComponentBlockData* fTrackletBlock;
-               unsigned fTrackletBlockIndex;
-           };
+      /** the global merger object */
+      AliHLTTPCGlobalMerger* fGlobalMerger; //!
+      /** the vertexer object */
+      AliHLTTPCVertex* fVertex; //!
+
+      struct SliceData {
+       /** slice no */
+       int fSlice;                                                // see above
+       /** block descriptor for the vertex data block */
+       const AliHLTComponentBlockData* fVertexBlock;              //! transient
+       /** index of the vertex data block */
+       unsigned fVertexBlockIndex;                                // see above
+       /** block descriptor for the tracklet data block */
+       const AliHLTComponentBlockData* fTrackletBlock;            //! transient
+       /** index of the tracklet data block */
+       unsigned fTrackletBlockIndex;                              // see above
+      };
 
        ClassDef(AliHLTTPCGlobalMergerComponent, 0)