Fixing part of the Coding violation

[u/mrichter/AliRoot.git] / MUON / AliMUONRegionalTriggerBoard.h

diff --git a/MUON/AliMUONRegionalTriggerBoard.h b/MUON/AliMUONRegionalTriggerBoard.h
index 1c20c12eb41f9b122da27530cb2a94654ef14ef7..67761cc7de321c163eb114ae09756c9561e2ec88 100644 (file)
--- a/MUON/AliMUONRegionalTriggerBoard.h
+++ b/MUON/AliMUONRegionalTriggerBoard.h
@@ -1,11 +1,15 @@
-#ifndef ALIMUONREGIONALTRIGGERRBOARD_H
-#define ALIMUONREGIONALTRIGGERRBOARD_H
+#ifndef ALIMUONREGIONALTRIGGERBOARD_H
+#define ALIMUONREGIONALTRIGGERBOARD_H
 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
  * See cxx source for full Copyright notice                               */
 
 /* $Id$ */
 
-//*-- Author: Rachid Guernane (LPCCFd)
+/// \ingroup trigger
+/// \class AliMUONRegionalTriggerBoard
+/// \brief Regional trigger - real HW algorithm is implemented
+///
+//  Author: Rachid Guernane (LPCCFd)
 
 #include "AliMUONTriggerBoard.h"
 
@@ -14,27 +18,32 @@ class AliMUONRegionalTriggerBoard : public AliMUONTriggerBoard
    public: 
       AliMUONRegionalTriggerBoard();  
       AliMUONRegionalTriggerBoard(const char *name, Int_t a);
-      virtual ~AliMUONRegionalTriggerBoard() {;}
+      virtual ~AliMUONRegionalTriggerBoard();
     
+      /// Reset Local trigger inputs
       virtual void Reset() {for (Int_t i=0; i<16; i++) fLocalResponse[i] = 0;}
 
-      virtual void Scan(Option_t *option);
+      virtual void Scan(Option_t *option) const;
 
-      virtual void Resp(Option_t*) {}
+      /// Dummy implementation
+      virtual void Resp(Option_t*) const {}
 
       virtual void Response();
 
+      /// Set Local trigger inputs
       virtual void SetLocalResponse(UShort_t val[16]) {for (Int_t i=0;i<16;i++) fLocalResponse[i] = val[i];}
 
+      /// response of the algorithm
       virtual UShort_t Algo(UShort_t i, UShort_t j, char *thres, Int_t level);
 
-      void Mask(Int_t index, UShort_t mask);
+      /// set local boards enable
+      void Mask(UShort_t mask);
       
    private:
-      UShort_t fLocalResponse[16];
-      UShort_t fMask[16];
+      UShort_t fLocalResponse[16]; ///< Local trigger inputs
+      UShort_t fMask;              ///< Entry mask
       
-      ClassDef(AliMUONRegionalTriggerBoard,1)
+      ClassDef(AliMUONRegionalTriggerBoard,1) // Regional trigger - real HW algorithm is implemented
 };
 #endif