update of documentation
authorrichterm <richterm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 3 Jul 2008 08:08:18 +0000 (08:08 +0000)
committerrichterm <richterm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Thu, 3 Jul 2008 08:08:18 +0000 (08:08 +0000)
HLT/rec/AliHLTOUTHomerCollection.cxx
HLT/rec/AliHLTOUTHomerCollection.h
HLT/rec/AliHLTReconstructor.h
HLT/rec/test/testAliRawReader.C

index 88ef869..f6c9f18 100644 (file)
@@ -19,7 +19,7 @@
 /** @file   AliHLTOUTHomerCollection.cxx
     @author Matthias Richter
     @date   
-    @brief  General HLTOUT data collection.
+    @brief  General collection for HLTOUT data in DDL format.
 */
 
 #include "AliHLTOUTHomerCollection.h"
index 0841643..f00cb06 100644 (file)
@@ -10,8 +10,8 @@
 /** @file   AliHLTOUTHomerCollection.h
     @author Matthias Richter
     @date   
-    @brief  General HLTOUT data collection.
-                                                                          */
+    @brief  General collection for HLTOUT data in DDL format.
+*/
 #include "AliHLTOUTHomerBuffer.h"
 
 class AliHLTHOMERReader;
@@ -20,8 +20,16 @@ class AliHLTEsdManager;
 
 /**
  * @class AliHLTOUTHomerCollection
- * Handler of HLTOUT data, base class for specific handlers for
- * RawReader or Digit data.
+ * Handler of HLTOUT data in DDL format, base class for specific
+ * handlers for RawReader or Digit data.
+ *
+ * The class expects the data to be in the DDL data format.
+ * In contrast to the AliHLTOUTHomerBuffer, it also takes the
+ * additional CDH and HLT headers and optional HLT decision into
+ * account when opening the HOMER reader (see OpenReader()).
+ *
+ * The data access must be provided by the child class, the
+ * interface is pretty much like the AliRawReader interface.
  */
 class AliHLTOUTHomerCollection : public AliHLTOUTHomerBuffer {
  public:
index 8c518a2..144643e 100644 (file)
@@ -156,6 +156,16 @@ class AliHLTEsdManager;
  * stored to files.
  *
  * @section sec_alihltreconstructor_helper Tools and helper functions
+ * Some helper functions of the AliHLTReconstruction can be used in stand-alone
+ * mode. Remember to Init() the reconstructor.
+ * <pre>
+ * {
+ * gSystem->Load("libHLTrec.so");
+ * AliHLTReconstructor rec;
+ * rec.Init();
+ * // do something
+ * }
+ * </pre>
  * @subsection sec_alihltreconstructor_hltout_standalone Stand-alone HLTOUT processing
  * - HLTOUT processing from a digit file:
  * <pre>
index 7729156..730238f 100644 (file)
@@ -16,7 +16,7 @@
  * provided "as is" without express or implied warranty.                  *
  **************************************************************************/
 
-/** @file   testAliRawReaderMemory.C
+/** @file   testAliRawReader.C
     @author Matthias Richter
     @date   
     @brief  Test macro/program for the AliRawReaderMemory