Adding comment lines to class description needed for Root documentation,
[u/mrichter/AliRoot.git] / MUON / mapping / AliMpVPadRowSegment.cxx
index 406ca7c..1778e6c 100755 (executable)
@@ -1,21 +1,39 @@
+/**************************************************************************
+ * Copyright(c) 1998-1999, 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$
+// $MpId: AliMpVPadRowSegment.cxx,v 1.7 2006/05/24 13:58:46 ivana Exp $
 // Category: sector
-//
+
+//-----------------------------------------------------------------------------
 // Class AliMpVPadRowSegment
 // --------------------
 // The abstract base class for a pad row segment composed of the 
 // the identic pads.
-//
+// Included in AliRoot: 2003/05/02
 // Authors: David Guez, Ivana Hrivnacova; IPN Orsay
-
-#include <TError.h>
+//-----------------------------------------------------------------------------
 
 #include "AliMpVPadRowSegment.h"
 #include "AliMpPadRow.h"
 #include "AliMpMotif.h"
 #include "AliMpMotifType.h"
 
+/// \cond CLASSIMP
 ClassImp(AliMpVPadRowSegment)
+/// \endcond
 
 //_____________________________________________________________________________
 AliMpVPadRowSegment::AliMpVPadRowSegment(AliMpPadRow* padRow, AliMpMotif* motif, 
@@ -27,7 +45,7 @@ AliMpVPadRowSegment::AliMpVPadRowSegment(AliMpPadRow* padRow, AliMpMotif* motif,
     fMotif(motif),
     fMotifPositionId(motifPositionId)
 {
-// 
+/// Standard contructor 
 }
 
 //_____________________________________________________________________________
@@ -39,12 +57,13 @@ AliMpVPadRowSegment::AliMpVPadRowSegment()
     fMotif(0),
     fMotifPositionId(0)
 {
-//
+/// Default contructor 
 }
 
 //_____________________________________________________________________________
-AliMpVPadRowSegment::~AliMpVPadRowSegment() {
-//  
+AliMpVPadRowSegment::~AliMpVPadRowSegment() 
+{
+/// Destructor   
 }
 
 //
@@ -54,8 +73,7 @@ AliMpVPadRowSegment::~AliMpVPadRowSegment() {
 //_____________________________________________________________________________
 Double_t  AliMpVPadRowSegment::HalfSizeY() const
 {
-// Returns the size in y of this row segment.
-// ---
+/// Return the size in y of this row segment.
 
   return fMotif->GetPadDimensions().Y();
 }
@@ -63,8 +81,7 @@ Double_t  AliMpVPadRowSegment::HalfSizeY() const
 //_____________________________________________________________________________
 AliMpPadRow*  AliMpVPadRowSegment::GetPadRow() const
 {
-// Returns the pad row.which this pad row segment belongs to.
-// ---
+/// Return the pad row.which this pad row segment belongs to.
 
   return fPadRow;
 }  
@@ -72,8 +89,7 @@ AliMpPadRow*  AliMpVPadRowSegment::GetPadRow() const
 //_____________________________________________________________________________
 AliMpMotif*  AliMpVPadRowSegment::GetMotif() const
 {
-// Returns the motif of this pad row segment. 
-// ---
+/// Return the motif of this pad row segment. 
 
   return fMotif;
 }  
@@ -81,8 +97,7 @@ AliMpMotif*  AliMpVPadRowSegment::GetMotif() const
 //_____________________________________________________________________________
 Int_t  AliMpVPadRowSegment::GetMotifPositionId() const
 {
-// Returns the motif of this pad row segment. 
-// ---
+/// Return the motif of this pad row segment. 
 
   return fMotifPositionId;
 }  
@@ -90,8 +105,7 @@ Int_t  AliMpVPadRowSegment::GetMotifPositionId() const
 //_____________________________________________________________________________
 void  AliMpVPadRowSegment::SetOffsetX(Double_t offsetX)
 {
-// Sets the x offset.
-// ---
+/// Set the x offset.
 
   fOffsetX = offsetX;
 }