chore: rename unused params (acts-project#1952)

- rename `/*unused*/` params into something more understandable
- improve doc

Author: andiwand

Core/include/Acts/EventData/Charge.hpp

@@ -77,8 +77,7 @@ struct Neutral {
   ///
   /// This is always `true` as `Neutral` has no internal state.
   /// Must be available to provide a consistent interface.
-  friend constexpr bool operator==(Neutral /*unused*/,
-                                   Neutral /*unused*/) noexcept {
+  friend constexpr bool operator==(Neutral /*lhs*/, Neutral /*rhs*/) noexcept {
     return true;
   }
 };
@@ -110,8 +109,8 @@ struct SinglyCharged {
   ///
   /// This is always `true` as `SinglyCharged` has no internal state.
   /// Must be available to provide a consistent interface.
-  friend constexpr bool operator==(SinglyCharged /*unused*/,
-                                   SinglyCharged /*unused*/) noexcept {
+  friend constexpr bool operator==(SinglyCharged /*lhs*/,
+                                   SinglyCharged /*rhs*/) noexcept {
     return true;
   }
 };

Core/include/Acts/Geometry/CuboidVolumeBuilder.hpp

@@ -181,8 +181,8 @@ class CuboidVolumeBuilder : public ITrackingVolumeBuilder {
   /// @return Pointer to the created TrackingGeometry
   std::shared_ptr<TrackingVolume> trackingVolume(
       const GeometryContext& gctx,
-      std::shared_ptr<const TrackingVolume> /*unused*/,
-      std::shared_ptr<const VolumeBounds> /*unused*/) const override;
+      std::shared_ptr<const TrackingVolume> /*oppositeVolume*/,
+      std::shared_ptr<const VolumeBounds> /*outsideBounds*/) const override;
 
  private:
   /// Configuration of the world volume

Core/include/Acts/Navigation/NavigationStateUpdators.hpp

@@ -136,7 +136,7 @@ class IndexedUpdatorImpl : public INavigationDelegate {
   /// @param a is the array to be filled
   template <typename Array, std::size_t... idx>
   void fillCasts(const Vector3& position, Array& a,
-                 std::index_sequence<idx...> /*unused*/) const {
+                 std::index_sequence<idx...> /*indices*/) const {
     ((a[idx] = VectorHelpers::cast(position, casts[idx])), ...);
   }
 };

Core/include/Acts/Propagator/detail/GenericDefaultExtension.hpp

@@ -31,8 +31,8 @@ struct GenericDefaultExtension {
   /// @tparam stepper_t Type of the stepper
   /// @return Boolean flag if the step would be valid
   template <typename propagator_state_t, typename stepper_t>
-  int bid(const propagator_state_t& /*unused*/,
-          const stepper_t& /*unused*/) const {
+  int bid(const propagator_state_t& /*state*/,
+          const stepper_t& /*stepper*/) const {
     return 1;
   }
 

Core/include/Acts/Propagator/detail/VoidPropagatorComponents.hpp

@@ -46,7 +46,7 @@ struct VoidNavigator {
   /// Empty call, compiler should optimise that
   template <typename propagator_state_t, typename stepper_t>
   void status(propagator_state_t& /*state*/,
-              const stepper_t& /*unused*/) const {}
+              const stepper_t& /*stepper*/) const {}
 
   /// Navigation call - void
   ///
@@ -56,7 +56,7 @@ struct VoidNavigator {
   /// Empty call, compiler should optimise that
   template <typename propagator_state_t, typename stepper_t>
   void target(propagator_state_t& /*state*/,
-              const stepper_t& /*unused*/) const {}
+              const stepper_t& /*stepper*/) const {}
 };
 
 }  // namespace detail

Core/src/Detector/DetectorVolume.cpp

@@ -46,7 +46,7 @@ Acts::Experimental::DetectorVolume::DetectorVolume(
 }
 
 Acts::Experimental::DetectorVolume::DetectorVolume(
-    const GeometryContext& /*unused*/, const std::string& name,
+    const GeometryContext& /*gctx*/, const std::string& name,
     const Transform3& transform, std::unique_ptr<VolumeBounds> bounds,
     SurfaceCandidatesUpdator&& surfaceCandidateUpdator)
     : m_name(name),

Core/src/Geometry/CuboidVolumeBuilder.cpp

@@ -221,8 +221,8 @@ std::shared_ptr<Acts::TrackingVolume> Acts::CuboidVolumeBuilder::buildVolume(
 }
 
 Acts::MutableTrackingVolumePtr Acts::CuboidVolumeBuilder::trackingVolume(
-    const GeometryContext& gctx, Acts::TrackingVolumePtr /*unused*/,
-    Acts::VolumeBoundsPtr /*unused*/) const {
+    const GeometryContext& gctx, Acts::TrackingVolumePtr /*gctx*/,
+    Acts::VolumeBoundsPtr /*bounds*/) const {
   // Build volumes
   std::vector<std::shared_ptr<TrackingVolume>> volumes;
   volumes.reserve(m_cfg.volumeCfg.size());

Core/src/Geometry/CylinderVolumeHelper.cpp

@@ -418,7 +418,7 @@ bool Acts::CylinderVolumeHelper::estimateAndCheckDimension(
     const CylinderVolumeBounds*& cylinderVolumeBounds,
     const Transform3& transform, double& rMinClean, double& rMaxClean,
     double& zMinClean, double& zMaxClean, BinningValue& bValue,
-    BinningType /*unused*/) const {
+    BinningType /*bType*/) const {
   // some verbose output
 
   ACTS_VERBOSE("Parsing the " << layers.size()

Core/src/Geometry/GeometryIdentifier.cpp

@@ -40,6 +40,6 @@ std::ostream& Acts::operator<<(std::ostream& os, Acts::GeometryIdentifier id) {
 
 Acts::GeometryIdentifier Acts::GeometryIdentifierHook::decorateIdentifier(
     Acts::GeometryIdentifier identifier,
-    const Acts::Surface& /*unused*/) const {
+    const Acts::Surface& /*surface*/) const {
   return identifier;
 }

Core/src/Surfaces/ConeSurface.cpp

@@ -81,7 +81,7 @@ Acts::Vector3 Acts::ConeSurface::rotSymmetryAxis(
 
 Acts::RotationMatrix3 Acts::ConeSurface::referenceFrame(
     const GeometryContext& gctx, const Vector3& position,
-    const Vector3& /*unused*/) const {
+    const Vector3& /*momentum*/) const {
   RotationMatrix3 mFrame;
   // construct the measurement frame
   // measured Y is the local z axis
@@ -102,7 +102,7 @@ Acts::RotationMatrix3 Acts::ConeSurface::referenceFrame(
 
 Acts::Vector3 Acts::ConeSurface::localToGlobal(
     const GeometryContext& gctx, const Vector2& lposition,
-    const Vector3& /*unused*/) const {
+    const Vector3& /*momentum*/) const {
   // create the position in the local 3d frame
   double r = lposition[Acts::eBoundLoc1] * bounds().tanAlpha();
   double phi = lposition[Acts::eBoundLoc0] / r;
@@ -112,7 +112,7 @@ Acts::Vector3 Acts::ConeSurface::localToGlobal(
 
 Acts::Result<Acts::Vector2> Acts::ConeSurface::globalToLocal(
     const GeometryContext& gctx, const Vector3& position,
-    const Vector3& /*unused*/, double tolerance) const {
+    const Vector3& /*momentum*/, double tolerance) const {
   Vector3 loc3Dframe = transform(gctx).inverse() * position;
   double r = loc3Dframe.z() * bounds().tanAlpha();
   if (std::abs(perp(loc3Dframe) - r) > tolerance) {