correcting doxygen warnings

diff --git a/HLT/TPCLib/AliHLTTPCClusterConverterComponent.h b/HLT/TPCLib/AliHLTTPCClusterConverterComponent.h
index e3f9914062e12bf49409624162fb7393ff3772f6..6f4edcad9757b284856f5ef6bcf1ffe1a86ca8e2 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCClusterConverterComponent.h
+++ b/HLT/TPCLib/AliHLTTPCClusterConverterComponent.h
@@ -43,26 +43,26 @@ public:
   // Public functions to implement AliHLTComponent's interface.
   // These functions are required for the registration process
 
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   const char* GetComponentID();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   void GetInputDataTypes(AliHLTComponentDataTypeList& list);
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponentDataType GetOutputDataType();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int GetOutputDataTypes(AliHLTComponentDataTypeList& tgtList);
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponent* Spawn();
 
 protected:
 
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int DoInit( int argc, const char** argv );
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int DoDeinit();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int DoEvent(const AliHLTComponentEventData& /*evtData*/, AliHLTComponentTriggerData& trigData);
 
   int Reconfigure(const char* cdbEntry, const char* chainId);

diff --git a/HLT/TPCLib/AliHLTTPCClusterFinderComponent.h b/HLT/TPCLib/AliHLTTPCClusterFinderComponent.h
index e20d6f5feb8cb7afdae0e8e560759854d3ade927..2ae3130245535511287db946493f05c9d20efd73 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCClusterFinderComponent.h
+++ b/HLT/TPCLib/AliHLTTPCClusterFinderComponent.h
@@ -98,17 +98,17 @@ class AliHLTTPCClusterFinderComponent : public AliHLTProcessor
        // Public functions to implement AliHLTComponent's interface.
        // These functions are required for the registration process
 
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   const char* GetComponentID();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   void GetInputDataTypes( vector<AliHLTComponentDataType>& list);
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponentDataType GetOutputDataType();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int GetOutputDataTypes(AliHLTComponentDataTypeList& tgtList);
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponent* Spawn();
 
     protected:

diff --git a/HLT/TPCLib/AliHLTTPCClusterHistoComponent.h b/HLT/TPCLib/AliHLTTPCClusterHistoComponent.h
index 780945278c56695d748def64d0fbca708f9913fc..779cf5174efdb100693d3d12b4b88d6a5c522222 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCClusterHistoComponent.h
+++ b/HLT/TPCLib/AliHLTTPCClusterHistoComponent.h
@@ -43,15 +43,15 @@ public:
   // Public functions to implement AliHLTComponent's interface.
   // These functions are required for the registration process
 
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   const char* GetComponentID();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   void GetInputDataTypes(AliHLTComponentDataTypeList& list);
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponentDataType GetOutputDataType();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponent* Spawn();
 
 protected:
@@ -60,11 +60,11 @@ protected:
   // These functions provide initialization as well as the actual processing
   // capabilities of the component. 
 
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int DoInit( int argc, const char** argv );
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int DoDeinit();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int DoEvent( const AliHLTComponentEventData& /*evtData*/, AliHLTComponentTriggerData& trigData );
 
   int Reconfigure(const char* cdbEntry, const char* chainId);

diff --git a/HLT/TPCLib/AliHLTTPCGlobalMergerComponent.h b/HLT/TPCLib/AliHLTTPCGlobalMergerComponent.h
index 1b4651195e0f227cafa919e6918f18e1b5c61b36..208ed67948ea364390fda2261433e78d35b3e94c 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCGlobalMergerComponent.h
+++ b/HLT/TPCLib/AliHLTTPCGlobalMergerComponent.h
@@ -37,19 +37,19 @@ class AliHLTTPCGlobalMergerComponent : public AliHLTProcessor
        // Public functions to implement AliHLTComponent's interface.
        // These functions are required for the registration process
 
-      /** @see component interface @ref AliHLTComponent::GetComponentID */
+      /** @see component interface AliHLTComponent::GetComponentID */
        const char* GetComponentID();
       
-      /** @see component interface @ref AliHLTComponent::GetInputDataTypes */
+      /** @see component interface AliHLTComponent::GetInputDataTypes */
        void GetInputDataTypes(AliHLTComponentDataTypeList& list);
 
-      /** @see component interface @ref AliHLTComponent::GetOutputDataType */
+      /** @see component interface AliHLTComponent::GetOutputDataType */
        AliHLTComponentDataType GetOutputDataType();
 
-      /** @see component interface @ref AliHLTComponent::GetOutputDataSize */
+      /** @see component interface AliHLTComponent::GetOutputDataSize */
        virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
 
-      /** @see component interface @ref AliHLTComponent::Spawn */
+      /** @see component interface AliHLTComponent::Spawn */
        AliHLTComponent* Spawn();
 
     protected:
@@ -65,10 +65,10 @@ class AliHLTTPCGlobalMergerComponent : public AliHLTProcessor
        // capabilities of the component. 
 
 
-      /** @see component interface @ref AliHLTComponent::DoInit */
+      /** @see component interface AliHLTComponent::DoInit */
        int DoInit( int argc, const char** argv );
 
-      /** @see component interface @ref AliHLTComponent::DoDeinit */
+      /** @see component interface AliHLTComponent::DoDeinit */
        int DoDeinit();
 
       /** @see component interface @ref AliHLTProcessor::DoEvent */

diff --git a/HLT/TPCLib/AliHLTTPCHistogramHandlerComponent.h b/HLT/TPCLib/AliHLTTPCHistogramHandlerComponent.h
index 1904c466c043cd6e468c0b03342fbf4ab0e84bb9..4b3351f71a481e9d9d889d3b23962e7472bee0f1 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCHistogramHandlerComponent.h
+++ b/HLT/TPCLib/AliHLTTPCHistogramHandlerComponent.h
@@ -61,17 +61,17 @@ public:
   // Public functions to implement AliHLTComponent's interface.
   // These functions are required for the registration process
       
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   const char* GetComponentID();                                                             
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   void GetInputDataTypes( vector<AliHLTComponentDataType>& list);                           
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponentDataType GetOutputDataType();                                      
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int GetOutputDataTypes(AliHLTComponentDataTypeList& tgtList);                           
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier ); 
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponent* Spawn();                                                       
   /** function for acting on the saving and cleaning histograms, after they are filled */
   void MakeHistosPublic();

diff --git a/HLT/TPCLib/AliHLTTPCKryptonClusterFinderComponent.h b/HLT/TPCLib/AliHLTTPCKryptonClusterFinderComponent.h
index 65772f0ed3665b3ac2b197ddaff4212838927279..c97a01a26a6daec45be4d4a20bf0aa69a52ef3a0 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCKryptonClusterFinderComponent.h
+++ b/HLT/TPCLib/AliHLTTPCKryptonClusterFinderComponent.h
@@ -37,17 +37,17 @@ class AliHLTTPCKryptonClusterFinderComponent : public AliHLTProcessor
        // Public functions to implement AliHLTComponent's interface.
        // These functions are required for the registration process
 
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   const char* GetComponentID();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   void GetInputDataTypes( vector<AliHLTComponentDataType>& list);
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponentDataType GetOutputDataType();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int GetOutputDataTypes(AliHLTComponentDataTypeList& tgtList);
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponent* Spawn();
 
     protected:

diff --git a/HLT/TPCLib/AliHLTTPCNoiseMapComponent.h b/HLT/TPCLib/AliHLTTPCNoiseMapComponent.h
index 02665a5280176b576e90f012d6aa45dbd0159768..d07509e7d6a4e6d0a65875cd1588c9c04619f450 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCNoiseMapComponent.h
+++ b/HLT/TPCLib/AliHLTTPCNoiseMapComponent.h
@@ -65,17 +65,17 @@ class AliHLTTPCNoiseMapComponent : public AliHLTProcessor {
       // Public functions to implement AliHLTComponent's interface.
       // These functions are required for the registration process
       
-      /** interface function, see @ref AliHLTComponent for description */
+      /** interface function, see AliHLTComponent for description */
       const char* GetComponentID();                                                         
-      /** interface function, see @ref AliHLTComponent for description */
+      /** interface function, see AliHLTComponent for description */
       void GetInputDataTypes( vector<AliHLTComponentDataType>& list);                       
-      /** interface function, see @ref AliHLTComponent for description */
+      /** interface function, see AliHLTComponent for description */
       AliHLTComponentDataType GetOutputDataType();                                          
-      /** interface function, see @ref AliHLTComponent for description */
+      /** interface function, see AliHLTComponent for description */
       int GetOutputDataTypes(AliHLTComponentDataTypeList& tgtList);                       
-      /** interface function, see @ref AliHLTComponent for description */
+      /** interface function, see AliHLTComponent for description */
       virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier ); 
-      /** interface function, see @ref AliHLTComponent for description */
+      /** interface function, see AliHLTComponent for description */
       AliHLTComponent* Spawn();                                                           
       /** function for acting on the saving and cleaning histograms, after they are filled */
       void MakeHistosPublic();

diff --git a/HLT/TPCLib/AliHLTTPCPad.h b/HLT/TPCLib/AliHLTTPCPad.h
index ec8a1fd28da3a202304ff6fb602fccb1da1b0da8..373d154a0b660a50e5e1397be72ce185160ba4b0 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCPad.h
+++ b/HLT/TPCLib/AliHLTTPCPad.h
@@ -296,6 +296,7 @@ public:
    * @param timebinsLeft       Timebins to include left of the signals above threshold (to include tails)
    * @param timebinsRight      Timebins to include right of the signals above threshold (to include tails)
    * @param valueBelowAverage  The number of adc-counts below the average value. (sometimes there can be useful to also add some signals below average for your signals, especially when there is a lot of noise) It means that more of the tails of the signal is added.
+   * @param speedup            Do not the full zero suppression but terminate if it is clear wheter the channel has some signal or not.
    */
   void ZeroSuppress(Double_t nRMS,Int_t threshold,Int_t reqMinPoint,Int_t beginTime,Int_t endTime,Int_t timebinsLeft, Int_t timebinsRight, Int_t valueBelowAverage, bool speedup=false);
   

diff --git a/HLT/TPCLib/AliHLTTPCSliceTrackerComponent.h b/HLT/TPCLib/AliHLTTPCSliceTrackerComponent.h
index 02c71dff66a54c232a73a2dbe6397ccd15f2b821..e7911966058c9c5123b4c02bdd3a38ddfb3802d3 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCSliceTrackerComponent.h
+++ b/HLT/TPCLib/AliHLTTPCSliceTrackerComponent.h
@@ -74,15 +74,15 @@ public:
   // Public functions to implement AliHLTComponent's interface.
   // These functions are required for the registration process
 
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   const char* GetComponentID();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   void GetInputDataTypes(AliHLTComponentDataTypeList& list);
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponentDataType GetOutputDataType();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponent* Spawn();
 
 protected:
@@ -121,11 +121,11 @@ protected:
   // These functions provide initialization as well as the actual processing
   // capabilities of the component. 
 
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int DoInit( int argc, const char** argv );
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int DoDeinit();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int DoEvent( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks, 
               AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, 
               AliHLTUInt32_t& size, AliHLTComponentBlockDataList& outputBlocks );

diff --git a/HLT/TPCLib/AliHLTTPCTrackHistoComponent.h b/HLT/TPCLib/AliHLTTPCTrackHistoComponent.h
index 3755dae37238bb39806c08e4cb44af88c54241a5..794a9f543a2e49d2c21f44cb576012218645dd5a 100644 (file)
--- a/HLT/TPCLib/AliHLTTPCTrackHistoComponent.h
+++ b/HLT/TPCLib/AliHLTTPCTrackHistoComponent.h
@@ -96,15 +96,15 @@ public:
   // Public functions to implement AliHLTComponent's interface.
   // These functions are required for the registration process
 
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   const char* GetComponentID();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   void GetInputDataTypes(AliHLTComponentDataTypeList& list);
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponentDataType GetOutputDataType();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponent* Spawn();
 
 protected:
@@ -113,11 +113,11 @@ protected:
   // These functions provide initialization as well as the actual processing
   // capabilities of the component. 
 
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int DoInit( int argc, const char** argv );
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int DoDeinit();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int DoEvent( const AliHLTComponentEventData& /*evtData*/, AliHLTComponentTriggerData& trigData );
 
   using AliHLTProcessor::DoEvent;

diff --git a/HLT/TPCLib/AliHLTTPCZeroSuppressionComponent.h b/HLT/TPCLib/AliHLTTPCZeroSuppressionComponent.h
index c75deeba512c67b03ee449fc7b83b32b89856ba2..6d7790311de9ee81331d9714f4e6fd544f9dc9ca 100755 (executable)
--- a/HLT/TPCLib/AliHLTTPCZeroSuppressionComponent.h
+++ b/HLT/TPCLib/AliHLTTPCZeroSuppressionComponent.h
@@ -53,17 +53,17 @@ class AliHLTTPCZeroSuppressionComponent : public AliHLTProcessor
        // Public functions to implement AliHLTComponent's interface.
        // These functions are required for the registration process
 
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   const char* GetComponentID();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   void GetInputDataTypes( vector<AliHLTComponentDataType>& list);
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponentDataType GetOutputDataType();
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   int GetOutputDataTypes(AliHLTComponentDataTypeList& tgtList);
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
-  /** interface function, see @ref AliHLTComponent for description */
+  /** interface function, see AliHLTComponent for description */
   AliHLTComponent* Spawn();
 
       Int_t DeInitializePadArray();

diff --git a/HLT/TPCLib/comp/AliHLTTPCCompModelAnalysis.h b/HLT/TPCLib/comp/AliHLTTPCCompModelAnalysis.h
index 06a61951f44e11605f203c21d1a2ea232ceb00d8..f5ff6686445f2ab3e2fc702095d9bdddceacb143 100644 (file)
--- a/HLT/TPCLib/comp/AliHLTTPCCompModelAnalysis.h
+++ b/HLT/TPCLib/comp/AliHLTTPCCompModelAnalysis.h
@@ -178,7 +178,7 @@ private:
    */
   Int_t ComparePythiaTrackInfo(AliHLTTPCTrackList* firsttracklistelement, AliHLTTPCTrackList* secondtracklistelement);
 
-  /** if -graphfile <filename>.root is given as input parameter, histrograms are created
+  /** if -graphfile filename.root is given as input parameter, histrograms are created
    * @param relativedifferences boolean to decide whether to plot histograms 
    *                            with relative differences in track paramters (1) or not (0), 1 by default
    * @return 0 upon success

diff --git a/HLT/TPCLib/tracking-ca/AliHLTTPCCATrackerComponent.h b/HLT/TPCLib/tracking-ca/AliHLTTPCCATrackerComponent.h
index eeb1d7294057e10c90b81deeedacd06d8fdedf86..d65b9234ed77ba914996fdf2e400290018e05842 100644 (file)
--- a/HLT/TPCLib/tracking-ca/AliHLTTPCCATrackerComponent.h
+++ b/HLT/TPCLib/tracking-ca/AliHLTTPCCATrackerComponent.h
@@ -35,19 +35,19 @@ public:
   // Public functions to implement AliHLTComponent's interface.
   // These functions are required for the registration process
   
-  /** @see component interface @ref AliHLTComponent::GetComponentID */
+  /** @see component interface AliHLTComponent::GetComponentID */
   const char* GetComponentID() ;
   
-  /** @see component interface @ref AliHLTComponent::GetInputDataTypes */
+  /** @see component interface AliHLTComponent::GetInputDataTypes */
   void GetInputDataTypes( vector<AliHLTComponentDataType>& list)  ;
   
-  /** @see component interface @ref AliHLTComponent::GetOutputDataType */
+  /** @see component interface AliHLTComponent::GetOutputDataType */
   AliHLTComponentDataType GetOutputDataType() ;
 
-  /** @see component interface @ref AliHLTComponent::GetOutputDataSize */
+  /** @see component interface AliHLTComponent::GetOutputDataSize */
   virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier ) ;
 
-  /** @see component interface @ref AliHLTComponent::Spawn */
+  /** @see component interface AliHLTComponent::Spawn */
   AliHLTComponent* Spawn() ;
 
 protected:
@@ -56,10 +56,10 @@ protected:
   // These functions provide initialization as well as the actual processing
   // capabilities of the component. 
   
-  /** @see component interface @ref AliHLTComponent::DoInit */
+  /** @see component interface AliHLTComponent::DoInit */
   int DoInit( int argc, const char** argv );
   
-  /** @see component interface @ref AliHLTComponent::DoDeinit */
+  /** @see component interface AliHLTComponent::DoDeinit */
   int DoDeinit();
   
   /** @see component interface @ref AliHLTProcessor::DoEvent */