From 2b8a404c0494c4cc075c6407dd423ccf83028a89 Mon Sep 17 00:00:00 2001
From: ybedfer <ybedfer@cern.ch>
Date: Thu, 18 Jul 2024 17:58:10 +0200
Subject: [PATCH] DDCore: Purely cosmectic commit: only comments are affected.
Modifications concern spelling, typos and eliminating repetitions.
---
DDCore/include/DD4hep/CartesianGridXY.h | 2 +-
DDCore/include/DD4hep/CartesianGridXYZ.h | 2 +-
DDCore/include/DD4hep/CartesianGridXZ.h | 2 +-
DDCore/include/DD4hep/CartesianGridYZ.h | 2 +-
DDCore/include/DD4hep/CartesianStripX.h | 2 +-
DDCore/include/DD4hep/CartesianStripY.h | 4 ++--
DDCore/include/DD4hep/CartesianStripZ.h | 4 ++--
DDCore/include/DD4hep/CylindricalGridPhiZ.h | 4 ++--
DDCore/include/DD4hep/GridPhiEta.h | 2 +-
DDCore/include/DD4hep/GridRPhiEta.h | 2 +-
DDCore/include/DD4hep/MultiSegmentation.h | 2 +-
DDCore/include/DD4hep/PolarGridRPhi.h | 2 +-
DDCore/include/DD4hep/PolarGridRPhi2.h | 2 +-
DDCore/include/DD4hep/WaferGridXY.h | 2 +-
DDCore/include/DDSegmentation/CartesianGridXZ.h | 2 +-
DDCore/src/CartesianGridXY.cpp | 10 +---------
DDCore/src/CartesianGridXYZ.cpp | 11 +----------
DDCore/src/CartesianGridXZ.cpp | 10 +---------
DDCore/src/CartesianGridYZ.cpp | 10 +---------
DDCore/src/CartesianStripX.cpp | 10 +---------
DDCore/src/CartesianStripY.cpp | 10 +---------
DDCore/src/CartesianStripZ.cpp | 10 +---------
DDCore/src/CylindricalGridPhiZ.cpp | 10 +---------
23 files changed, 26 insertions(+), 91 deletions(-)
diff --git a/DDCore/include/DD4hep/CartesianGridXY.h b/DDCore/include/DD4hep/CartesianGridXY.h
index 2b8057a5e..5ef9062ad 100644
--- a/DDCore/include/DD4hep/CartesianGridXY.h
+++ b/DDCore/include/DD4hep/CartesianGridXY.h
@@ -41,7 +41,7 @@ namespace dd4hep {
* fiddled with the handled object directly.....
*
* Note:
- * The handle base corrsponding to this object in for
+ * The handle base corresponding to this object in for
* conveniance reasons instantiated in dd4hep/src/Segmentations.cpp.
*
* \author M.Frank
diff --git a/DDCore/include/DD4hep/CartesianGridXYZ.h b/DDCore/include/DD4hep/CartesianGridXYZ.h
index ad8952660..79e788948 100644
--- a/DDCore/include/DD4hep/CartesianGridXYZ.h
+++ b/DDCore/include/DD4hep/CartesianGridXYZ.h
@@ -41,7 +41,7 @@ namespace dd4hep {
* fiddled with the handled object directly.....
*
* Note:
- * The handle base corrsponding to this object in for
+ * The handle base corresponding to this object in for
* conveniance reasons instantiated in dd4hep/src/Segmentations.cpp.
*
* \author M.Frank
diff --git a/DDCore/include/DD4hep/CartesianGridXZ.h b/DDCore/include/DD4hep/CartesianGridXZ.h
index da5941188..9ff16d756 100644
--- a/DDCore/include/DD4hep/CartesianGridXZ.h
+++ b/DDCore/include/DD4hep/CartesianGridXZ.h
@@ -41,7 +41,7 @@ namespace dd4hep {
* fiddled with the handled object directly.....
*
* Note:
- * The handle base corrsponding to this object in for
+ * The handle base corresponding to this object in for
* conveniance reasons instantiated in dd4hep/src/Segmentations.cpp.
*
* \author M.Frank
diff --git a/DDCore/include/DD4hep/CartesianGridYZ.h b/DDCore/include/DD4hep/CartesianGridYZ.h
index 1767b5fbe..ec9d5477b 100644
--- a/DDCore/include/DD4hep/CartesianGridYZ.h
+++ b/DDCore/include/DD4hep/CartesianGridYZ.h
@@ -41,7 +41,7 @@ namespace dd4hep {
* fiddled with the handled object directly.....
*
* Note:
- * The handle base corrsponding to this object in for
+ * The handle base corresponding to this object in for
* conveniance reasons instantiated in dd4hep/src/Segmentations.cpp.
*
* \author M.Frank
diff --git a/DDCore/include/DD4hep/CartesianStripX.h b/DDCore/include/DD4hep/CartesianStripX.h
index 9e07ce640..f64773a94 100644
--- a/DDCore/include/DD4hep/CartesianStripX.h
+++ b/DDCore/include/DD4hep/CartesianStripX.h
@@ -42,7 +42,7 @@ typedef Handle<SegmentationWrapper<DDSegmentation::CartesianStripX> > CartesianS
* fiddled with the handled object directly.....
*
* Note:
- * The handle base corrsponding to this object in for
+ * The handle base corresponding to this object in for
* conveniance reasons instantiated in dd4hep/src/Segmentations.cpp.
*
* \author M.Frank
diff --git a/DDCore/include/DD4hep/CartesianStripY.h b/DDCore/include/DD4hep/CartesianStripY.h
index 9fade74b4..e350a82ea 100644
--- a/DDCore/include/DD4hep/CartesianStripY.h
+++ b/DDCore/include/DD4hep/CartesianStripY.h
@@ -42,7 +42,7 @@ typedef Handle<SegmentationWrapper<DDSegmentation::CartesianStripY> > CartesianS
* fiddled with the handled object directly.....
*
* Note:
- * The handle base corrsponding to this object in for
+ * The handle base corresponding to this object in for
* conveniance reasons instantiated in dd4hep/src/Segmentations.cpp.
*
* \author M.Frank
@@ -87,7 +87,7 @@ class CartesianStripY : public CartesianStripYHandle {
Returns a vector of the cellDimensions of the given cell ID
\param cellID is ignored as all cells have the same dimension
\return std::vector<double> size 1:
- -# size in x
+ -# size in y
*/
std::vector<double> cellDimensions(const CellID& cellID) const;
};
diff --git a/DDCore/include/DD4hep/CartesianStripZ.h b/DDCore/include/DD4hep/CartesianStripZ.h
index e70e0ae84..3367d1427 100644
--- a/DDCore/include/DD4hep/CartesianStripZ.h
+++ b/DDCore/include/DD4hep/CartesianStripZ.h
@@ -43,7 +43,7 @@ typedef Handle<SegmentationWrapper<DDSegmentation::CartesianStripZ> > CartesianS
* fiddled with the handled object directly.....
*
* Note:
- * The handle base corrsponding to this object in for
+ * The handle base corresponding to this object in for
* conveniance reasons instantiated in dd4hep/src/Segmentations.cpp.
*
* \author M.Frank
@@ -88,7 +88,7 @@ class CartesianStripZ : public CartesianStripZHandle {
Returns a vector of the cellDimensions of the given cell ID
\param cellID is ignored as all cells have the same dimension
\return std::vector<double> size 1:
- -# size in x
+ -# size in z
*/
std::vector<double> cellDimensions(const CellID& cellID) const;
};
diff --git a/DDCore/include/DD4hep/CylindricalGridPhiZ.h b/DDCore/include/DD4hep/CylindricalGridPhiZ.h
index 9597a0b89..5300a0e31 100644
--- a/DDCore/include/DD4hep/CylindricalGridPhiZ.h
+++ b/DDCore/include/DD4hep/CylindricalGridPhiZ.h
@@ -97,12 +97,12 @@ namespace dd4hep {
/// access the field name used for Z
const std::string& fieldNameZ() const;
/** \brief Returns a vector<double> of the cellDimensions of the given cell ID
- in natural order of dimensions, e.g., dx/dy/dz, or dr/r*dPhi
+ in the following order: R*dPhi,dZ
Returns a vector of the cellDimensions of the given cell ID
\param cellID is ignored as all cells have the same dimension
\return std::vector<double> size 2:
- -# size in x
+ -# size in x = R * size in phi
-# size in z
*/
std::vector<double> cellDimensions(const CellID& cellID) const;
diff --git a/DDCore/include/DD4hep/GridPhiEta.h b/DDCore/include/DD4hep/GridPhiEta.h
index 054301da2..29392051c 100644
--- a/DDCore/include/DD4hep/GridPhiEta.h
+++ b/DDCore/include/DD4hep/GridPhiEta.h
@@ -39,7 +39,7 @@ namespace dd4hep {
* fiddled with the handled object directly.....
*
* Note:
- * The handle base corrsponding to this object in for
+ * The handle base corresponding to this object in for
* conveniance reasons instantiated in dd4hep/src/Segmentations.cpp.
*
* \author A. Zaborowska
diff --git a/DDCore/include/DD4hep/GridRPhiEta.h b/DDCore/include/DD4hep/GridRPhiEta.h
index cbcc5b3b3..d0cc21994 100644
--- a/DDCore/include/DD4hep/GridRPhiEta.h
+++ b/DDCore/include/DD4hep/GridRPhiEta.h
@@ -39,7 +39,7 @@ namespace dd4hep {
* fiddled with the handled object directly.....
*
* Note:
- * The handle base corrsponding to this object in for
+ * The handle base corresponding to this object in for
* conveniance reasons instantiated in dd4hep/src/Segmentations.cpp.
*
* \author A. Zaborowska
diff --git a/DDCore/include/DD4hep/MultiSegmentation.h b/DDCore/include/DD4hep/MultiSegmentation.h
index 92bb6fb91..24df4b144 100644
--- a/DDCore/include/DD4hep/MultiSegmentation.h
+++ b/DDCore/include/DD4hep/MultiSegmentation.h
@@ -42,7 +42,7 @@ namespace dd4hep {
* fiddled with the handled object directly.....
*
* Note:
- * The handle base corrsponding to this object in for
+ * The handle base corresponding to this object in for
* conveniance reasons instantiated in dd4hep/src/Segmentations.cpp.
*
* \author M.Frank
diff --git a/DDCore/include/DD4hep/PolarGridRPhi.h b/DDCore/include/DD4hep/PolarGridRPhi.h
index 7a2a519e8..5cd949e3d 100644
--- a/DDCore/include/DD4hep/PolarGridRPhi.h
+++ b/DDCore/include/DD4hep/PolarGridRPhi.h
@@ -41,7 +41,7 @@ namespace dd4hep {
* fiddled with the handled object directly.....
*
* Note:
- * The handle base corrsponding to this object in for
+ * The handle base corresponding to this object in for
* conveniance reasons instantiated in dd4hep/src/Segmentations.cpp.
*
* \author M.Frank
diff --git a/DDCore/include/DD4hep/PolarGridRPhi2.h b/DDCore/include/DD4hep/PolarGridRPhi2.h
index e14cc99ba..7fea4a937 100644
--- a/DDCore/include/DD4hep/PolarGridRPhi2.h
+++ b/DDCore/include/DD4hep/PolarGridRPhi2.h
@@ -41,7 +41,7 @@ namespace dd4hep {
* fiddled with the handled object directly.....
*
* Note:
- * The handle base corrsponding to this object in for
+ * The handle base corresponding to this object in for
* conveniance reasons instantiated in dd4hep/src/Segmentations.cpp.
*
* \author M.Frank
diff --git a/DDCore/include/DD4hep/WaferGridXY.h b/DDCore/include/DD4hep/WaferGridXY.h
index 593f4c0e7..c4ce9d65c 100644
--- a/DDCore/include/DD4hep/WaferGridXY.h
+++ b/DDCore/include/DD4hep/WaferGridXY.h
@@ -41,7 +41,7 @@ namespace dd4hep {
* fiddled with the handled object directly.....
*
* Note:
- * The handle base corrsponding to this object in for
+ * The handle base corresponding to this object in for
* conveniance reasons instantiated in dd4hep/src/Segmentations.cpp.
*
* \author M.Frank
diff --git a/DDCore/include/DDSegmentation/CartesianGridXZ.h b/DDCore/include/DDSegmentation/CartesianGridXZ.h
index 3e358488e..2817b61d4 100644
--- a/DDCore/include/DDSegmentation/CartesianGridXZ.h
+++ b/DDCore/include/DDSegmentation/CartesianGridXZ.h
@@ -9,7 +9,7 @@
//
//==========================================================================
/*
- * CartesianGridXY.h
+ * CartesianGridXZ.h
*
* Created on: Jun 28, 2013
* Author: Christian Grefe, CERN
diff --git a/DDCore/src/CartesianGridXY.cpp b/DDCore/src/CartesianGridXY.cpp
index daa7d155f..67d21e486 100644
--- a/DDCore/src/CartesianGridXY.cpp
+++ b/DDCore/src/CartesianGridXY.cpp
@@ -80,15 +80,7 @@ const std::string& CartesianGridXY::fieldNameY() const {
return access()->implementation->fieldNameY();
}
-/** \brief Returns a vector<double> of the cellDimensions of the given cell ID
- in natural order of dimensions, e.g., dx/dy/dz, or dr/r*dPhi
-
- Returns a vector of the cellDimensions of the given cell ID
- \param cellID is ignored as all cells have the same dimension
- \return vector<double> size 2:
- -# size in x
- -# size in y
-*/
+// Returns a vector<double> of the cellDimensions of the given cell ID
std::vector<double> CartesianGridXY::cellDimensions(const CellID& id) const {
return access()->implementation->cellDimensions(id);
}
diff --git a/DDCore/src/CartesianGridXYZ.cpp b/DDCore/src/CartesianGridXYZ.cpp
index bd610e524..ad29a6531 100644
--- a/DDCore/src/CartesianGridXYZ.cpp
+++ b/DDCore/src/CartesianGridXYZ.cpp
@@ -105,16 +105,7 @@ const std::string& CartesianGridXYZ::fieldNameZ() const {
return access()->implementation->fieldNameZ();
}
-/** \brief Returns a vector<double> of the cellDimensions of the given cell ID
- in natural order of dimensions, e.g., dx/dy/dz, or dr/r*dPhi
-
- Returns a vector of the cellDimensions of the given cell ID
- \param cellID is ignored as all cells have the same dimension
- \return vector<double> size 2:
- -# size in x
- -# size in y
- -# size in z
-*/
+// Returns a vector<double> of the cellDimensions of the given cell ID
std::vector<double> CartesianGridXYZ::cellDimensions(const CellID& id) const {
return access()->implementation->cellDimensions(id);
}
diff --git a/DDCore/src/CartesianGridXZ.cpp b/DDCore/src/CartesianGridXZ.cpp
index 907559173..e59f1f415 100644
--- a/DDCore/src/CartesianGridXZ.cpp
+++ b/DDCore/src/CartesianGridXZ.cpp
@@ -80,15 +80,7 @@ const std::string& CartesianGridXZ::fieldNameZ() const {
return access()->implementation->fieldNameZ();
}
-/** \brief Returns a vector<double> of the cellDimensions of the given cell ID
- in natural order of dimensions, e.g., dx/dy/dz, or dr/r*dPhi
-
- Returns a vector of the cellDimensions of the given cell ID
- \param cellID is ignored as all cells have the same dimension
- \return vector<double> size 2:
- -# size in x
- -# size in z
-*/
+// Returns a vector<double> of the cellDimensions of the given cell ID
std::vector<double> CartesianGridXZ::cellDimensions(const CellID& id) const {
return access()->implementation->cellDimensions(id);
}
diff --git a/DDCore/src/CartesianGridYZ.cpp b/DDCore/src/CartesianGridYZ.cpp
index 4a9ab3e03..90c351ada 100644
--- a/DDCore/src/CartesianGridYZ.cpp
+++ b/DDCore/src/CartesianGridYZ.cpp
@@ -80,15 +80,7 @@ const std::string& CartesianGridYZ::fieldNameZ() const {
return access()->implementation->fieldNameZ();
}
-/** \brief Returns a vector<double> of the cellDimensions of the given cell ID
- in natural order of dimensions, e.g., dx/dy/dz, or dr/r*dPhi
-
- Returns a vector of the cellDimensions of the given cell ID
- \param cellID is ignored as all cells have the same dimension
- \return vector<double> size 2:
- -# size in y
- -# size in z
-*/
+// Returns a vector<double> of the cellDimensions of the given cell ID
std::vector<double> CartesianGridYZ::cellDimensions(const CellID& id) const {
return access()->implementation->cellDimensions(id);
}
diff --git a/DDCore/src/CartesianStripX.cpp b/DDCore/src/CartesianStripX.cpp
index 653fa590c..911df2605 100644
--- a/DDCore/src/CartesianStripX.cpp
+++ b/DDCore/src/CartesianStripX.cpp
@@ -45,15 +45,7 @@ void CartesianStripX::setOffsetX(double offset) const { access()->implementation
/// access the field name used for X
const std::string& CartesianStripX::fieldNameX() const { return access()->implementation->fieldNameX(); }
-/** \brief Returns a vector<double> of the cellDimensions of the given cell ID
- in natural order of dimensions, e.g., dx/dy/dz, or dr/r*dPhi
-
- Returns a vector of the cellDimensions of the given cell ID
- \param cellID is ignored as all cells have the same dimension
- \return vector<double> size 2:
- -# size in x
- -# size in y
-*/
+// Returns a vector<double> of the cellDimensions of the given cell ID
std::vector<double> CartesianStripX::cellDimensions(const CellID& id) const {
return access()->implementation->cellDimensions(id);
}
diff --git a/DDCore/src/CartesianStripY.cpp b/DDCore/src/CartesianStripY.cpp
index a75fe16cc..5a1d40b72 100644
--- a/DDCore/src/CartesianStripY.cpp
+++ b/DDCore/src/CartesianStripY.cpp
@@ -45,15 +45,7 @@ void CartesianStripY::setOffsetY(double offset) const { access()->implementation
/// access the field name used for Y
const std::string& CartesianStripY::fieldNameY() const { return access()->implementation->fieldNameY(); }
-/** \brief Returns a vector<double> of the cellDimensions of the given cell ID
- in natural order of dimensions, e.g., dx/dy/dz, or dr/r*dPhi
-
- Returns a vector of the cellDimensions of the given cell ID
- \param cellID is ignored as all cells have the same dimension
- \return vector<double> size 2:
- -# size in x
- -# size in y
-*/
+// Returns a vector<double> of the cellDimensions of the given cell ID
std::vector<double> CartesianStripY::cellDimensions(const CellID& id) const {
return access()->implementation->cellDimensions(id);
}
diff --git a/DDCore/src/CartesianStripZ.cpp b/DDCore/src/CartesianStripZ.cpp
index 72336031c..10a7938e6 100644
--- a/DDCore/src/CartesianStripZ.cpp
+++ b/DDCore/src/CartesianStripZ.cpp
@@ -45,15 +45,7 @@ void CartesianStripZ::setOffsetZ(double offset) const { access()->implementation
/// access the field name used for Z
const std::string& CartesianStripZ::fieldNameZ() const { return access()->implementation->fieldNameZ(); }
-/** \brief Returns a vector<double> of the cellDimensions of the given cell ID
- in natural order of dimensions, e.g., dx/dy/dz, or dr/r*dPhi
-
- Returns a vector of the cellDimensions of the given cell ID
- \param cellID is ignored as all cells have the same dimension
- \return vector<double> size 2:
- -# size in x
- -# size in y
-*/
+// Returns a vector<double> of the cellDimensions of the given cell ID
std::vector<double> CartesianStripZ::cellDimensions(const CellID& id) const {
return access()->implementation->cellDimensions(id);
}
diff --git a/DDCore/src/CylindricalGridPhiZ.cpp b/DDCore/src/CylindricalGridPhiZ.cpp
index 364f6e212..06efeb24c 100644
--- a/DDCore/src/CylindricalGridPhiZ.cpp
+++ b/DDCore/src/CylindricalGridPhiZ.cpp
@@ -80,15 +80,7 @@ const std::string& CylindricalGridPhiZ::fieldNameZ() const {
return access()->implementation->fieldNameZ();
}
-/** \brief Returns a vector<double> of the cellDimensions of the given cell ID
- in natural order of dimensions, e.g., dx/dy/dz, or dr/r*dPhi
-
- Returns a vector of the cellDimensions of the given cell ID
- \param cellID is ignored as all cells have the same dimension
- \return vector<double> size 2:
- -# size in x
- -# size in z
-*/
+// Returns a vector<double> of the cellDimensions of the given cell ID
std::vector<double> CylindricalGridPhiZ::cellDimensions(const CellID& id) const {
return access()->implementation->cellDimensions(id);
}
--
GitLab