Coding conventions (Philippe)

diff --git a/MUON/AliMUONGlobalTrigger.cxx b/MUON/AliMUONGlobalTrigger.cxx
index f93cd5de78623a4993e1b829f4fb065784d834aa..16c4e325f6881754db7477f580b270bb18319d2a 100644 (file)
--- a/MUON/AliMUONGlobalTrigger.cxx
+++ b/MUON/AliMUONGlobalTrigger.cxx
@@ -16,6 +16,12 @@
 
 /* $Id$ */
 
+// ------------------
+// Class AliMUONGlobalTrigger
+// ------------------
+// Global Trigger algorithm data output
+// built from Local and Regional algorithms 
+
 #include "AliMUONGlobalTrigger.h"
 
 ClassImp(AliMUONGlobalTrigger)

diff --git a/MUON/AliMUONLocalTrigger.cxx b/MUON/AliMUONLocalTrigger.cxx
index 7203c3868c42d84084570ced2daa78efb9aa61d2..9fec7cf27e534f15ea71b2f2c9bcc10625fb4289 100644 (file)
--- a/MUON/AliMUONLocalTrigger.cxx
+++ b/MUON/AliMUONLocalTrigger.cxx
@@ -15,6 +15,12 @@
 
 /* $Id$ */
 
+// ------------------
+// Class AliMUONLocalTrigger
+// ------------------
+// Local Trigger algorithm data outputs
+// (contains local trigger decision and bit patterns)
+
 #include "AliMUONLocalTrigger.h"
 #include <assert.h>
 #include "AliLog.h"
@@ -135,6 +141,7 @@ AliMUONLocalTrigger::AliMUONLocalTrigger(const Int_t* localtr, const TArrayI& di
 //----------------------------------------------------------------------
 Char_t AliMUONLocalTrigger::GetLoDecision()
 {
+// returns local trigger decision
   fLoDecision  = (fLoLpt & 0x3);
   fLoDecision |= (fLoHpt << 2) & 0xC;
 

diff --git a/MUON/AliMUONLocalTrigger.h b/MUON/AliMUONLocalTrigger.h
index 3b068c5c94a8ac80a90cdb8632968c6190da28ce..501f487d3433a6f60d3e1870a0ababc545c02690 100644 (file)
--- a/MUON/AliMUONLocalTrigger.h
+++ b/MUON/AliMUONLocalTrigger.h
@@ -80,15 +80,15 @@ private:
   Int_t fLoHpt;     // High pt 0 : nothing, 1 : Minus, 2 : Plus, 3 : Undef
   Int_t fLoApt;     // All pt  0 : nothing, 1 : Minus, 2 : Plus, 3 : Undef
 
-  UShort_t fX1Pattern; // X and Y strip pattern for each chamber
-  UShort_t fX2Pattern;
-  UShort_t fX3Pattern;
-  UShort_t fX4Pattern;
+  UShort_t fX1Pattern; // X strip pattern for chamber 11
+  UShort_t fX2Pattern; // X strip pattern for chamber 12
+  UShort_t fX3Pattern; // X strip pattern for chamber 21
+  UShort_t fX4Pattern; // X strip pattern for chamber 22
  
-  UShort_t fY1Pattern;
-  UShort_t fY2Pattern;
-  UShort_t fY3Pattern;
-  UShort_t fY4Pattern;
+  UShort_t fY1Pattern; // Y strip pattern for chamber 11
+  UShort_t fY2Pattern; // Y strip pattern for chamber 12
+  UShort_t fY3Pattern; // Y strip pattern for chamber 21
+  UShort_t fY4Pattern; // Y strip pattern for chamber 22
 
   Char_t fLoDecision; // local decision word (4 bits)
 

diff --git a/MUON/AliMUONResponseTriggerV1.cxx b/MUON/AliMUONResponseTriggerV1.cxx
index 5688f71f160fb381e9af6f03631d2c009a0e239e..62b9969e51f91eada06a6873241301ff4c44cdde 100644 (file)
--- a/MUON/AliMUONResponseTriggerV1.cxx
+++ b/MUON/AliMUONResponseTriggerV1.cxx
@@ -15,6 +15,12 @@
 
 /* $Id$ */
 
+// ------------------
+// Class AliMUONTriggerResponseV1
+// ------------------
+// Trigger chamber response 
+// with cluster size activated
+
 #include <TMath.h>
 #include <TRandom.h>
 

diff --git a/MUON/AliMUONTriggerCircuit.cxx b/MUON/AliMUONTriggerCircuit.cxx
index 65dd019696b6f016ce629d9b05996848217a9353..15cd8ef44493c5b20abe339aa088ea4198b7da3f 100644 (file)
--- a/MUON/AliMUONTriggerCircuit.cxx
+++ b/MUON/AliMUONTriggerCircuit.cxx
@@ -15,6 +15,13 @@
 
 /* $Id$ */
 
+// ------------------
+// Class AliMUONTriggerCircuit
+// ------------------
+// description of the global position of the trigger boards strip positions
+// based on the "old" segmentation (to be replaced soon)
+
+
 #include <TMath.h>
 
 #include "AliMUONTriggerCircuit.h"
@@ -396,7 +403,7 @@ void AliMUONTriggerCircuit::LoadXPos2(){
   Int_t nStrY=AliMUONTriggerConstants::NstripY(ModuleNumber(idModule)); 
   Int_t idSector=segmentation->Sector(idDE, idModule,0); // corresp. sector
   Float_t width=segmentation->Dpx(idDE, idSector);      // corresponding strip width
-  
+
 // first case : up middle and down parts have all 8 or 16 strip 
   if ((nStrY==16)||(nStrY==8&&fX2m==0&&fX2ud==0)) { 
     for (istrip=0; istrip<nStrY; istrip++) {
@@ -544,6 +551,7 @@ void dump(const char* what, const Int_t* array, Int_t size)
 void
 AliMUONTriggerCircuit::Print(Option_t* ) const
 {
+// prints-out data member
   cout << "IdCircuit " << fIdCircuit << " X2m,X2ud=" << fX2m << ","
   << fX2ud;
   for ( Int_t i = 0; i < 2; ++i )

diff --git a/MUON/AliMUONTriggerCircuit.h b/MUON/AliMUONTriggerCircuit.h
index a74fcf56ec800101ab3cd0d9f091ac35311560bf..951ff0f5bc673eb2cb5cf5b57c886fac050e57d3 100644 (file)
--- a/MUON/AliMUONTriggerCircuit.h
+++ b/MUON/AliMUONTriggerCircuit.h
@@ -9,6 +9,8 @@
 /// \ingroup base
 /// \class AliMUONTriggerCircuit
 /// \brief MUON Trigger circuit
+///
+/// \author Philippe Crochet (LPCCFd)
 
 #include <TObject.h>
 #include <TObjArray.h>

diff --git a/MUON/AliMUONTriggerConstants.cxx b/MUON/AliMUONTriggerConstants.cxx
index b0c84a572ea787fcfbc0de6168ed39524fe0d113..9b15b338efc33b9b5e79aa76392347b62098d2a2 100644 (file)
--- a/MUON/AliMUONTriggerConstants.cxx
+++ b/MUON/AliMUONTriggerConstants.cxx
@@ -15,6 +15,12 @@
 
 /* $Id$ */
 
+// ------------------
+// Class AliMUONTriggerConstants
+// ------------------
+// constants for building the trigger segmentation
+// to be removed soon (the next version is based on mapping only)
+
 #include "AliMUONTriggerConstants.h"
 
 ClassImp(AliMUONTriggerConstants)

diff --git a/MUON/AliMUONTriggerDecision.cxx b/MUON/AliMUONTriggerDecision.cxx
index 8a487c182fdc9bee118dcf29978a3e4444fd00c7..a3911a6d8b7c19c68e4a8fbbb46bd89d4e6d367b 100644 (file)
--- a/MUON/AliMUONTriggerDecision.cxx
+++ b/MUON/AliMUONTriggerDecision.cxx
@@ -15,6 +15,13 @@
 
 /* $Id$ */
 
+// ------------------
+// Class AliMUONTriggerDecision
+// ------------------
+// The (very-old) version of the trigger algorithm.
+// to be removed soon (the current version is AliMUONTriggerDecisionV1)
+
+
 #include <TError.h>
 
 #include "AliMUONTriggerCircuit.h"
@@ -138,6 +145,7 @@ AliMUONTriggerDecision::AliMUONTriggerDecision(const AliMUONTriggerDecision& rhs
 //----------------------------------------------------------------------
 void AliMUONTriggerDecision::ClearDigits()
 {
+// cleaning digits
   for ( int i=0;i<AliMUONConstants::NCh();i++ )
   {
     if ((*fDigits)[i]) ((TClonesArray*)fDigits->At(i))->Clear();

diff --git a/MUON/AliMUONTriggerDecision.h b/MUON/AliMUONTriggerDecision.h
index dc6b3c2bd92b884c7a94f050b1c614127b03d898..93779c3accba0d479e68d2916cbfeb46a32aaa7b 100644 (file)
--- a/MUON/AliMUONTriggerDecision.h
+++ b/MUON/AliMUONTriggerDecision.h
@@ -11,9 +11,8 @@
 /// \class AliMUONTriggerDecision
 /// \brief MUON trigger decision class 
 ///
-/////////////////////////////////////////////////
-///  MUON Trigger Decision Class               //
-/////////////////////////////////////////////////
+/// \author Philippe Crochet (LPCCFd)
+
 
 #include <TObject.h>
 #include "AliMUONLocalTrigger.h"

diff --git a/MUON/AliMUONTriggerGeometryBuilder.cxx b/MUON/AliMUONTriggerGeometryBuilder.cxx
index ec903c77cdfac5fda891cb32e8c7d8854555950f..c58891cab3e4f736bdf74971c4b94299df4a7b5e 100644 (file)
--- a/MUON/AliMUONTriggerGeometryBuilder.cxx
+++ b/MUON/AliMUONTriggerGeometryBuilder.cxx
@@ -14,12 +14,13 @@
  **************************************************************************/
 
 // $Id$
-//
+
+// -----------------------------------
 // Class AliMUONTriggerGeometryBuilder
 // -----------------------------------
-// MUON Trigger stations geometry construction class.
-//
-// Author: Philippe Crochette, LPC Clermont-Ferrand
+// MUON Trigger stations geometry 
+// construction class.
+// Author: Philippe Crochet (LPCCFd)
 
 #include <TVirtualMC.h>
 #include <TGeoMatrix.h>

diff --git a/MUON/AliMUONTriggerGeometryBuilder.h b/MUON/AliMUONTriggerGeometryBuilder.h
index 52927d45d0fb896a30c90f240dcab61ebb91917b..9e278d08348c39512f6e99b69623b4734e1b9534 100644 (file)
--- a/MUON/AliMUONTriggerGeometryBuilder.h
+++ b/MUON/AliMUONTriggerGeometryBuilder.h
@@ -8,7 +8,7 @@
 /// \class AliMUONTriggerGeometryBuilder
 /// \brief MUON Trigger stations geometry construction class
 ///
-/// Author: Philippe Crochette, LPC Clermont-Ferrand
+/// \author Philippe Crochet (LPCCFd)
 
 #ifndef ALI_MUON_TRIGGER_GEOMETRY_BUILDER_H
 #define ALI_MUON_TRIGGER_GEOMETRY_BUILDER_H

diff --git a/MUON/AliMUONTriggerLut.cxx b/MUON/AliMUONTriggerLut.cxx
index 40bf136fa4dd1efbdf07e1a84769c41b65cc5633..9e8dd59b82fd62b59fcc54ad043c7decb2ecf829 100644 (file)
--- a/MUON/AliMUONTriggerLut.cxx
+++ b/MUON/AliMUONTriggerLut.cxx
@@ -15,6 +15,13 @@
 
 /* $Id$ */
 
+// -----------------------------------
+// Class AliMUONTriggerLut
+// -----------------------------------
+// Local Trigger Look Up Table - reading interface
+// LUT data is stored into TH3S histograms and readout 
+// from the Local Trigger algorithm.
+
 #include "AliMUONTriggerLut.h"
 
 #include "AliLog.h"
@@ -73,6 +80,7 @@ AliMUONTriggerLut::operator=(const AliMUONTriggerLut& rhs)
 void
 AliMUONTriggerLut::ReadFromFile(const char* filename)
 {
+// return output of LuT for corresponding TH3S  
   TFile f(filename);
   
   if ( f.IsZombie() )

diff --git a/MUON/AliMUONTriggerTrack.cxx b/MUON/AliMUONTriggerTrack.cxx
index 84412d18e35902869257cef8302b3a6d288f8d52..12349e0e1bed69a1b8df9e56dfd56a0a41acf1a0 100644 (file)
--- a/MUON/AliMUONTriggerTrack.cxx
+++ b/MUON/AliMUONTriggerTrack.cxx
@@ -46,6 +46,7 @@ AliMUONTriggerTrack::AliMUONTriggerTrack()
 AliMUONTriggerTrack::AliMUONTriggerTrack(Float_t x11, Float_t y11, Float_t thetax, Float_t thetay, Long_t theGTPattern)
   : TObject()
 {
+// ctor from local trigger output
     fx11 = x11;
     fy11 = y11;
     fthetax = thetax;