coding conventions

diff --git a/PHOS/AliPHOSRawDecoder.cxx b/PHOS/AliPHOSRawDecoder.cxx
index 3f4dee7484d779c803955f0efd91aa2d8534f726..e7b22655ebe1a5f04cf1dcb4f9f07cecf640258f 100644 (file)
--- a/PHOS/AliPHOSRawDecoder.cxx
+++ b/PHOS/AliPHOSRawDecoder.cxx
@@ -13,6 +13,8 @@
  * provided "as is" without express or implied warranty.                  *
  **************************************************************************/
 
+/* $Id$ */
+
 // This class decodes the stream of ALTRO samples to extract
 // the PHOS "digits" of current event.
 // 
@@ -86,6 +88,8 @@ AliPHOSRawDecoder::AliPHOSRawDecoder(const AliPHOSRawDecoder &phosDecoder ):
 //-----------------------------------------------------------------------------
 AliPHOSRawDecoder& AliPHOSRawDecoder::operator = (const AliPHOSRawDecoder &phosDecode)
 {
+  //Assignment operator.
+
   if(this != &phosDecode) {
     fRawReader = phosDecode.fRawReader;
 

diff --git a/PHOS/AliPHOSRawDecoder.h b/PHOS/AliPHOSRawDecoder.h
index 4f95980bf9c3a9bb5ffa5b7f127ae6987bfa6635..6d4931e5e5392eaedd49672c33d84879ec9a8d5a 100644 (file)
--- a/PHOS/AliPHOSRawDecoder.h
+++ b/PHOS/AliPHOSRawDecoder.h
@@ -3,6 +3,8 @@
 /* Copyright(c) 2007, ALICE Experiment at CERN, All rights reserved. *
  * See cxx source for full Copyright notice                          */
 
+/* $Id$ */
+
 // This class extracts the PHOS "digits" of current event
 // (amplitude,time, position,gain) from the raw stream 
 // provided by AliRawReader. See cxx source for use case.
@@ -34,17 +36,17 @@ public:
 
 protected:   
   
-  AliRawReader* fRawReader;
-  AliCaloRawStream* fCaloStream;
-  Bool_t fPedSubtract;
+  AliRawReader* fRawReader;      // raw data reader
+  AliCaloRawStream* fCaloStream; // PHOS/EMCAL raw data stream
+  Bool_t fPedSubtract;           // pedestals subtraction (kTRUE="yes")
 
 private:
 
-  Double_t fEnergy;
-  Double_t fTime;
-  Int_t fModule;
-  Int_t fColumn;
-  Int_t fRow;
+  Double_t fEnergy; // "digit" energy
+  Double_t fTime;   // "digit" time
+  Int_t fModule;    // PHOS module number (1-5)
+  Int_t fColumn;    // column in the module
+  Int_t fRow;       // row
   
   ClassDef(AliPHOSRawDecoder,1)
 };

diff --git a/PHOS/AliPHOSRawDigiProducer.cxx b/PHOS/AliPHOSRawDigiProducer.cxx
index a3e60e7f325dba9b36a78e1eae8494cc2f612665..91c7e19dd973d91fd064e8f7cade5e59d0756cbc 100644 (file)
--- a/PHOS/AliPHOSRawDigiProducer.cxx
+++ b/PHOS/AliPHOSRawDigiProducer.cxx
@@ -1,5 +1,38 @@
+/**************************************************************************
+ * Copyright(c) 2007, ALICE Experiment at CERN, All rights reserved.      *
+ *                                                                        *
+ * Author: The ALICE Off-line Project.                                    *
+ * Contributors are mentioned in the code where appropriate.              *
+ *                                                                        *
+ * Permission to use, copy, modify and distribute this software and its   *
+ * documentation strictly for non-commercial purposes is hereby granted   *
+ * without fee, provided that the above copyright notice appears in all   *
+ * copies and that both the copyright notice and this permission notice   *
+ * appear in the supporting documentation. The authors make no claims     *
+ * about the suitability of this software for any purpose. It is          *
+ * provided "as is" without express or implied warranty.                  *
+ **************************************************************************/
+
+/* $Id$ */
+
+//This class produces PHOS digits of one event
+//using AliPHOSRawDecoder. 
+//
+//   For example:
+//   TClonesArray *digits = new TClonesArray("AliPHOSDigit",100);
+//   AliRawReader* rawReader = new AliRawReaderDate("2006run2211.raw");
+//   AliPHOSRawDecoder dc(rawReader);
+//   while (rawReader->NextEvent()) {
+//     AliPHOSRawDigiProducer producer;
+//     producer.MakeDigits(digits,&dc);
+//   }
+
+// Author: Boris Polichtchouk
+
+// --- ROOT system ---
 #include "TClonesArray.h"
 
+// --- AliRoot header files ---
 #include "AliPHOSRawDigiProducer.h"
 #include "AliPHOSRawDecoder.h"
 #include "AliPHOSGeometry.h"
@@ -7,8 +40,12 @@
 
 ClassImp(AliPHOSRawDigiProducer)
 
+//--------------------------------------------------------------------------------------
 void AliPHOSRawDigiProducer::MakeDigits(TClonesArray *digits, AliPHOSRawDecoder* decoder) 
 {
+  //Makes the job.
+  //TClonesArray *digits and raw data decoder should be provided by calling function.
+
   digits->Clear();
  
   AliPHOSGeometry* geo = AliPHOSGeometry::GetInstance();

diff --git a/PHOS/AliPHOSRawDigiProducer.h b/PHOS/AliPHOSRawDigiProducer.h
index f230c5c9c12a2c0705f095b4c0c2426e2689c63a..8a7b434d599e0a2154671bb4d568aac340cc08b3 100644 (file)
--- a/PHOS/AliPHOSRawDigiProducer.h
+++ b/PHOS/AliPHOSRawDigiProducer.h
@@ -1,5 +1,12 @@
 #ifndef ALIPHOSRAWDIGIPRODUCER_H
 #define ALIPHOSRAWDIGIPRODUCER_H
+/* Copyright(c) 2007, ALICE Experiment at CERN, All rights reserved. *
+ * See cxx source for full Copyright notice                          */
+
+/* $Id$ */
+
+//This class produces PHOS digits of one event
+//using AliPHOSRawDecoder. See cxx source for use case.
 
 class AliPHOSRawDecoder;
 
@@ -10,7 +17,7 @@ public:
   AliPHOSRawDigiProducer() {}
   virtual ~AliPHOSRawDigiProducer() {}
 
-  virtual void MakeDigits(TClonesArray *digits, AliPHOSRawDecoder* decoder);
+  void MakeDigits(TClonesArray *digits, AliPHOSRawDecoder* decoder);
 
   ClassDef(AliPHOSRawDigiProducer,1)
 };