code documantation and minor cleanup

[u/mrichter/AliRoot.git] / HLT / RCU / AliHLTAltroGenerator.h

diff --git a/HLT/RCU/AliHLTAltroGenerator.h b/HLT/RCU/AliHLTAltroGenerator.h
index e34599b376df07cb5625d91d610a683a575af7dd..7af0c3f1a15ee90212d1d36e8d810f46603bd2e3 100644 (file)
--- a/HLT/RCU/AliHLTAltroGenerator.h
+++ b/HLT/RCU/AliHLTAltroGenerator.h
@@ -31,6 +31,20 @@ class TRandom;
 
 /**
  * @class AliHLTAltroGenerator
+ * Helper class to generate data in the Altro format.
+ * 
+ * The class can be configured through the parameters of the
+ * AliHLTAltroGenerator(int, int, int, int, int) constructor.
+ * The data is generated by the Generate() method and stored internally 
+ * for subsequent use. The data is encoded into a buffer with the 
+ * GetData(AliHLTUInt8_t) or GetData(AliHLTUInt8_t, int) methods.
+ *
+ * A couple of functions provide access to the simulated data on a
+ * signal by signal basis (Next()) or a bunch by bunch basis
+ * (NextChannel() / NextBunch()). The scheme follows pretty much the
+ * AliRawReader or AliAltroDecoder scheme respectively.
+ *
+ * @ingroup alihlt_rcu
  */
 class AliHLTAltroGenerator : AliHLTLogging {
  public: