Record changes.

[u/mrichter/AliRoot.git] / FMD / AliFMDAltroIO.h

diff --git a/FMD/AliFMDAltroIO.h b/FMD/AliFMDAltroIO.h
index bd579283b884856d7a1873bd6a2c1428dd734dbc..57b0850d38aadc386f5124886524d4d8a11650fa 100644 (file)
--- a/FMD/AliFMDAltroIO.h
+++ b/FMD/AliFMDAltroIO.h
@@ -7,13 +7,22 @@
  *
  * See cxx source for full Copyright notice                               
  */
+/** @file    AliFMDAltroIO.h
+    @author  Christian Holm Christensen <cholm@nbi.dk>
+    @date    Sun Mar 26 18:27:31 2006
+    @brief   ALTRO Input/output
+*/
 #include <iosfwd>
 #include <TObject.h>
 
 //____________________________________________________________________
+/** @class AliFMDAltroIO AliFMDAltroIO.h <FMD/AliFMDAltroIO.h>
+    @brief Base class for ALTRO Input/Output classes.
+    @ingroup FMD_base
+ */
 class AliFMDAltroIO  : public TObject
 {
- public:
+public:
   /** Type of 40 bit words (signed) */
   typedef long long W40_t;
   /** Type of 10 bit words (signed) */
@@ -70,11 +79,21 @@ protected:
 };
 
 //____________________________________________________________________
+/** @class AliFMDAltroReader AliFMDAltroIO.h <FMD/AliFMDAltroIO.h>
+    @brief Class to read ALTRO formated raw data from an AliRawReader
+    object. 
+    @code 
+    AliRawReader*    reader    = new AliRawReaderFile(0);
+    AliFMDRawReader* fmdReader = new AliFMDRawReader(reader);
+    TClonesArray*    array     = new TClonesArray("AliFMDDigit");
+    fmdReader->ReadAdcs(array);
+    @endcode 
+*/
 class AliFMDAltroReader : public AliFMDAltroIO
 {
 public:
   /** Constructor 
-      @param filename File to read from 
+      @param stream Stream to read from
       @exception Int_t A negative error code in case of failure */
   AliFMDAltroReader(std::istream& stream);
   virtual ~AliFMDAltroReader() {}
@@ -152,11 +171,20 @@ protected:
 };
 
 //____________________________________________________________________
+/** @class AliFMDAltroWriter AliFMDAltroIO.h <FMD/AliFMDAltroIO.h>
+    @brief Class to write ALTRO formated raw data from an array of
+    AliFMDDigit objects.
+    @code 
+    AliFMDRawWriter* fmdWriter = new AliFMDRawWriter(0);
+    TClonesArray*    array     = fmd->DigitArray();
+    fmdWriter->WriteDigits(array);
+    @endcode 
+ */
 class AliFMDAltroWriter : public AliFMDAltroIO
 {
 public:
   /** Constructor.
-      @param filename File to read from
+      @param stream File to read from
       @exception Int_t A negative error code in case of failure */
   AliFMDAltroWriter(std::ostream& stream);
   virtual ~AliFMDAltroWriter() {}