DDCore: Purely cosmectic commit: only comments are affected.

Modifications concern spelling, typos and eliminating repetitions.
AIDASoft · Jul 18, 2024 · 677acb7 · 677acb7
1 parent e43295f
commit 677acb7
Show file tree

Hide file tree

Showing 23 changed files with 26 additions and 91 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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);
 }