From 82c0c8002beb639854dd1b4afb129700913755e9 Mon Sep 17 00:00:00 2001 From: Andreas Salzburger Date: Tue, 9 Jan 2024 11:20:17 +0100 Subject: [PATCH] fix: documentation - missing/extra parameters (#2859) This PR collects a few fixes of missing documented parameters in various packages that makes the doc build break (albeit not reproducibly). --- Core/include/Acts/Detector/GeometryIdGenerator.hpp | 2 +- Core/include/Acts/Material/ProtoSurfaceMaterial.hpp | 3 +-- .../Acts/TrackFinding/CombinatorialKalmanFilter.hpp | 1 + .../Acts/Vertexing/AdaptiveGridTrackDensity.hpp | 4 ++++ .../Acts/Vertexing/KalmanVertexTrackUpdater.hpp | 11 +++-------- Core/include/Acts/Vertexing/KalmanVertexUpdater.hpp | 6 +++--- 6 files changed, 13 insertions(+), 14 deletions(-) diff --git a/Core/include/Acts/Detector/GeometryIdGenerator.hpp b/Core/include/Acts/Detector/GeometryIdGenerator.hpp index 925a34ac85e..83e2ed90b9b 100644 --- a/Core/include/Acts/Detector/GeometryIdGenerator.hpp +++ b/Core/include/Acts/Detector/GeometryIdGenerator.hpp @@ -197,7 +197,7 @@ class ChainedGeometryIdGenerator : public IGeometryIdGenerator { /// /// @tparam gometry_object_t the geometry object type /// - /// @param the cache object with the array of sub caches + /// @param cache object with the array of sub caches /// @param object the object to assign the geometry id to template void assign(IGeometryIdGenerator::GeoIdCache& cache, diff --git a/Core/include/Acts/Material/ProtoSurfaceMaterial.hpp b/Core/include/Acts/Material/ProtoSurfaceMaterial.hpp index f0fe83b86dd..65ef53bc113 100644 --- a/Core/include/Acts/Material/ProtoSurfaceMaterial.hpp +++ b/Core/include/Acts/Material/ProtoSurfaceMaterial.hpp @@ -66,9 +66,8 @@ class ProtoSurfaceMaterialT : public ISurfaceMaterial { ProtoSurfaceMaterialT& operator=( ProtoSurfaceMaterialT&& smproxy) = default; - /// Scale operator + /// Scale operator - dummy implementation /// - /// @param scale The value to scale this material by ProtoSurfaceMaterialT& operator*=(double /*unused*/) final { return (*this); } diff --git a/Core/include/Acts/TrackFinding/CombinatorialKalmanFilter.hpp b/Core/include/Acts/TrackFinding/CombinatorialKalmanFilter.hpp index dacfda0eb36..2c50da23793 100644 --- a/Core/include/Acts/TrackFinding/CombinatorialKalmanFilter.hpp +++ b/Core/include/Acts/TrackFinding/CombinatorialKalmanFilter.hpp @@ -132,6 +132,7 @@ struct CombinatorialKalmanFilterExtensions { /// Default branch stopper which will never stop /// @param tipState The tip state to decide whether to stop (unused) + /// @param trackState The track state to decide whether to stop (unused) /// @return false static bool voidBranchStopper( const CombinatorialKalmanFilterTipState& tipState, diff --git a/Core/include/Acts/Vertexing/AdaptiveGridTrackDensity.hpp b/Core/include/Acts/Vertexing/AdaptiveGridTrackDensity.hpp index bfd563479f1..9677a2826d1 100644 --- a/Core/include/Acts/Vertexing/AdaptiveGridTrackDensity.hpp +++ b/Core/include/Acts/Vertexing/AdaptiveGridTrackDensity.hpp @@ -197,6 +197,10 @@ class AdaptiveGridTrackDensity { /// @param centralBin Central z and t bin of the track (where its /// density is the highest) /// @param cov 3x3 impact parameter covariance matrix + /// @param spatialTrkGridSize Number of bins in z direction + /// @param temporalTrkGridSize Number of bins in time direction + /// + /// @return The track density map DensityMap createTrackGrid(const Acts::Vector3& impactParams, const Bin& centralBin, const Acts::SquareMatrix3& cov, diff --git a/Core/include/Acts/Vertexing/KalmanVertexTrackUpdater.hpp b/Core/include/Acts/Vertexing/KalmanVertexTrackUpdater.hpp index d9bff7203eb..7c4d46b1d40 100644 --- a/Core/include/Acts/Vertexing/KalmanVertexTrackUpdater.hpp +++ b/Core/include/Acts/Vertexing/KalmanVertexTrackUpdater.hpp @@ -31,12 +31,10 @@ namespace KalmanVertexTrackUpdater { /// @brief Refits a single track with the knowledge of /// the vertex it has originated from /// -/// @tparam input_track_t Track object type -/// @tparam nDimVertex number of dimensions of the vertex. Can be 3 (if we only -/// fit its spatial coordinates) or 4 (if we also fit time). -/// /// @param track Track to update -/// @param vtx Vertex `track` belongs to +/// @param vtxPosFull full vertex position +/// @param vtxCovFull full vertex covariance matrix +/// @param nDimVertex number of dimensions of the vertex void update(TrackAtVertexRef track, const Vector4& vtxPosFull, const SquareMatrix4& vtxCovFull, unsigned int nDimVertex); @@ -44,9 +42,6 @@ namespace detail { /// @brief Calculates a covariance matrix for the refitted track parameters /// -/// @tparam nDimVertex number of dimensions of the vertex. Can be 3 (if we only -/// fit its spatial coordinates) or 4 (if we also fit time). -/// /// @param wMat W_k matrix from Ref. (1) /// @param crossCovVP Cross-covariance matrix between vertex position and track /// momentum diff --git a/Core/include/Acts/Vertexing/KalmanVertexUpdater.hpp b/Core/include/Acts/Vertexing/KalmanVertexUpdater.hpp index 2cb237ab540..543abdb1c05 100644 --- a/Core/include/Acts/Vertexing/KalmanVertexUpdater.hpp +++ b/Core/include/Acts/Vertexing/KalmanVertexUpdater.hpp @@ -92,17 +92,17 @@ void calculateUpdate4(const Vector4& vtxPos, const SquareMatrix4& vtxCov, /// updated track momentum when adding/removing linTrack. Saves the result in /// cache. /// -/// @tparam input_track_t Track object type /// @tparam nDimVertex number of dimensions of the vertex. Can be 3 (if we only /// fit its spatial coordinates) or 4 (if we also fit time). /// -/// @param vtx Vertex +/// @param vtxPos Vertex position +/// @param vtxCov Vertex covariance matrix /// @param linTrack Linearized track to be added or removed /// @param trackWeight Track weight /// @param sign +1 (add track) or -1 (remove track) /// @note Tracks are removed during the smoothing procedure to compute /// the chi2 of the track wrt the updated vertex position -/// @param[out] cache A cache to store the results of this function +/// @param[in,out] cache A cache to store the results of this function template void calculateUpdate(const Vector4& vtxPos, const SquareMatrix4& vtxCov, const Acts::LinearizedTrack& linTrack,