added collector component and HLTOUT handler for component statistics blocks and

[u/mrichter/AliRoot.git] / HLT / BASE / util / AliHLTRawReaderPublisherComponent.h

diff --git a/HLT/BASE/util/AliHLTRawReaderPublisherComponent.h b/HLT/BASE/util/AliHLTRawReaderPublisherComponent.h
index 420644d105143b44d09924476c822c14d2045658..ddfe00705d02a2fb86702443fd6e85e2baa7c20f 100644 (file)
--- a/HLT/BASE/util/AliHLTRawReaderPublisherComponent.h
+++ b/HLT/BASE/util/AliHLTRawReaderPublisherComponent.h
@@ -3,9 +3,9 @@
 
 #ifndef ALIHLTRAWREADERPUBLISHERCOMPONENT_H
 #define ALIHLTRAWREADERPUBLISHERCOMPONENT_H
-/* This file is property of and copyright by the ALICE HLT Project        * 
- * ALICE Experiment at CERN, All rights reserved.                         *
- * See cxx source for full Copyright notice                               */
+//* This file is property of and copyright by the ALICE HLT Project        * 
+//* ALICE Experiment at CERN, All rights reserved.                         *
+//* See cxx source for full Copyright notice                               *
 
 /** @file   AliHLTRawReaderPublisherComponent.h
     @author Matthias Richter
@@ -13,12 +13,6 @@
     @brief  A general data publisher component for the AliRawReader.
 */
 
-// see header file for class documentation
-// or
-// refer to README to build package
-// or
-// visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
-
 #include "AliHLTOfflineDataSource.h"
 
 /**
@@ -34,19 +28,29 @@
  * give range. If the RawReader does not provide any data, an empty data
  * block consisting of the Common Data Header is produced. 
  * 
- * Component ID: \b AliRawReaderPublisher <br>
- * Library: \b libAliHLTUtil.
+ * <h2>General properties:</h2>
+ *
+ * Component ID: \b AliRawReaderPublisher                               <br>
+ * Library: \b libAliHLTUtil.so                                                <br>
+ * Input Data Types: none                                              <br>
+ * Output Data Types: according to parameters and available RAW data   <br>
  *
- * Mandatory arguments: <br>
+ * <h2>Mandatory arguments:</h2>
  * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
+ * The equipment id(s) must be defined by argument(s) out of:
  * \li -detector     <i> detector name      </i>
  *      e.g. <tt> -detector TPC </tt>
  * \li -equipmentid  <i> id      </i>
  *      the equipmentid within the detector, e.g. TPC 0 is 768
  * \li -minid  <i> id      </i>
- *      the minimum equipmentid including detector offset, e.g. 768 is TPC 0
+ *      the minimum equipmentid including detector offset, e.g. 768 is TPC 0<br>
+ *      if the -detector option is used, the id is without detector offset
  * \li -maxid  <i> id      </i>
- *      the maximum equipmentid including detector offset (default = minid)
+ *      the maximum equipmentid including detector offset (default = minid)<br>
+ *      if the -detector option is used, the id is without detector offset
+ *
+ * <h2>Optional arguments:</h2>
+ * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
  * \li -verbose<br>
  *      print out some more info messages, mainly for the sake of tutorials
  * \li -skipempty
@@ -58,10 +62,25 @@
  *      data specification treated as decimal number or hex number if
  *      prepended by '0x'
  *
- * Optional arguments:<br>
+ * <h2>Configuration:</h2>
+ * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
+ * Configuration by component arguments.
+ *
+ * <h2>Default CDB entries:</h2>
+ * The component loads no CDB entries.
+ *
+ * <h2>Performance:</h2>
+ * The component does not process any event data.
+ *
+ * <h2>Memory consumption:</h2>
+ * The component does not process any event data.
  *
+ * <h2>Output size:</h2>
+ * According to the available data. The component is an AliHLTDataSource
+ * and inteded to be used in the AliHLTSystem framework only. The component
+ * implements the standard AliHLTSystem adaptive buffer allocation. 
  *
- * @ingroup alihlt_system
+ * @ingroup alihlt_util_components
  */
 class AliHLTRawReaderPublisherComponent : public AliHLTOfflineDataSource {
  public: