added code documentation for BASE, SampleLib, TPCLib and build system

[u/mrichter/AliRoot.git] / HLT / BASE / AliHLTDataSink.h

diff --git a/HLT/BASE/AliHLTDataSink.h b/HLT/BASE/AliHLTDataSink.h
index 413a8a9bfcc008c111e738f1d03edca08c2106e1..2852e0bd468a0c528635a9e323bd37b1e4a9f88d 100644 (file)
--- a/HLT/BASE/AliHLTDataSink.h
+++ b/HLT/BASE/AliHLTDataSink.h
@@ -8,7 +8,9 @@
 /** @file   AliHLTDataSink.h
     @author Matthias Richter
     @date   
-    @brief  Base class declaration for HLT data sink components. */
+    @brief  Base class declaration for HLT data sink components.
+    @note   The class is used in Offline (AliRoot) context
+*/
 
 #include "AliHLTComponent.h"
 
@@ -17,16 +19,16 @@
  * Base class of HLT data sink components.
  * The class provides a common interface for the implementation of HLT data
  * sink components. The child class must implement the functions:
- * - DoInit (optional)
- * - DoDeinit (optional)
- * - DumpEvent
- * - GetComponentID
- * - GetInputDataTypes
- * - GetOutputDataType
- * - GetOutputDataSize
- * - Spawn
+ * - @ref DoInit (optional)
+ * - @ref DoDeinit (optional)
+ * - @ref DumpEvent
+ * - @ref GetComponentID
+ * - @ref GetInputDataTypes
+ * - @ref GetOutputDataType
+ * - @ref GetOutputDataSize
+ * - @ref Spawn
  *
- * @ingroup AliHLTbase
+ * @ingroup alihlt_component
  */
 class AliHLTDataSink : public AliHLTComponent {
  public: