From 9ac1617105f9e03a1ae1dae33225ad8b6ee87a6f Mon Sep 17 00:00:00 2001
From: Andreas Salzburger <Andreas.Salzburger@cern.ch>
Date: Tue, 18 Oct 2016 14:37:09 +0200
Subject: [PATCH] doxygen fixes for classes with 'E'
---
.../ACTS/Extrapolation/ExtrapolationCell.hpp | 18 ++++++++++--------
.../ACTS/Extrapolation/ExtrapolationEngine.hpp | 6 +++---
Core/include/ACTS/Surfaces/EllipseBounds.hpp | 11 ++++++-----
3 files changed, 19 insertions(+), 16 deletions(-)
diff --git a/Core/include/ACTS/Extrapolation/ExtrapolationCell.hpp b/Core/include/ACTS/Extrapolation/ExtrapolationCell.hpp
index e88ec04a1..628190f66 100644
--- a/Core/include/ACTS/Extrapolation/ExtrapolationCell.hpp
+++ b/Core/include/ACTS/Extrapolation/ExtrapolationCell.hpp
@@ -65,8 +65,9 @@ class ExtrapolationConfig
public:
/// Constructor
///
- /// @param eval is the vonfiguration value
+ /// @param evalue is the vonfiguration value
ExtrapolationConfig(unsigned int evalue = 0) : value(evalue) {}
+
/// Copy Constructor
///
/// @param eConfig is the source object for the copy
@@ -77,7 +78,7 @@ public:
/// Add a configuration mode
/// - this sets the bit corresponding to the given mode
///
- /// @param the mode that is to be set
+ /// @param em the mode that is to be set
void
addMode(ExtrapolationMode::eMode em)
{
@@ -88,7 +89,7 @@ public:
/// Check the configuration mode
/// - this checks the bit corresponding to the configuration mode
///
- /// @param the mode that is to be checks
+ /// @param em the mode that is to be checks
///
/// @return boolean indicator if the mode was set
bool
@@ -369,13 +370,14 @@ public:
/// The process vertices that occured (for FATRAS)
std::vector<ProcessVertex> interactionVertices;
- float time; //!< timing info
- float zOaTrX; //!< z/A*rho*dInX0 (for average calculations)
- float zX; //!< z*dInX0 (for average calculations)
+ float time; ///< timing info
+ float zOaTrX; ///< z/A*rho*dInX0 (for average calculations)
+ float zX; ///< z*dInX0 (for average calculations)
/// Constructor of the Extrapolaton cell
/// start parameters are compulsory
///
+ /// @tparam sParameters are the templated parameters
/// @param pDir is the propagatio direction
/// @param econfig is the extrapolation config as value
ExtrapolationCell(const T& sParameters,
@@ -459,7 +461,7 @@ public:
/// - if the surface is already in the step vector, the new parameters
/// are atached
///
- /// @param stepParamters are the parameters of the step
+ /// @param stepParameters are the parameters of the step
/// @param fillMode is the mode under which these parameters are
/// considered
void
@@ -484,7 +486,7 @@ public:
/// - material is just a pointer copy
///
/// @param sfactor is the scale factor
- /// @param mprot is the material properties associated with the step
+ /// @param mprop is the material properties associated with the step
void
addMaterial(double sfactor, const MaterialProperties* mprop = nullptr);
diff --git a/Core/include/ACTS/Extrapolation/ExtrapolationEngine.hpp b/Core/include/ACTS/Extrapolation/ExtrapolationEngine.hpp
index 953f869a8..a2f3582c6 100644
--- a/Core/include/ACTS/Extrapolation/ExtrapolationEngine.hpp
+++ b/Core/include/ACTS/Extrapolation/ExtrapolationEngine.hpp
@@ -147,10 +147,10 @@ private:
/// Main extrapolation method, templated to chared/neutral
///
- /// @tparam eCell ist he extrapolaiton cell
+ /// @param eCell ist he extrapolaiton cell
/// @param sf is the (optional) destinaton surface
/// @param dir is the additional direction prescription
- /// @param bchk is the boudnary check directive @todo shift to cell after
+ /// @param bcheck is the boudnary check directive @todo shift to cell after
/// splitting
///
/// @return extrapolation code to indicate outcome
@@ -163,7 +163,7 @@ private:
/// Main extrapolation method, templated to chared/neutral
///
- /// @tparam eCell ist he extrapolaiton cell
+ /// @param eCell ist he extrapolaiton cell
/// @param sf is the (optional) destinaton surface
/// @param dir is the additional direction prescription
///
diff --git a/Core/include/ACTS/Surfaces/EllipseBounds.hpp b/Core/include/ACTS/Surfaces/EllipseBounds.hpp
index b4ddc458e..e3c780e4d 100644
--- a/Core/include/ACTS/Surfaces/EllipseBounds.hpp
+++ b/Core/include/ACTS/Surfaces/EllipseBounds.hpp
@@ -46,11 +46,11 @@ public:
/// Constructor for full of an ellipsoid disc
///
- /// @param minrad1
- /// @param minrad2
- /// @param maxrad1
- /// @param maxrad2
- /// @param hphisec average phi (is set to 0. as default)
+ /// @param minrad1 is the minimum radius at coorindate 1
+ /// @param minrad2 is the minimum radius at coorindate 2
+ /// @param maxrad1 is the minimum radius at coorindate 1
+ /// @param maxrad2 is the minimum radius at coorindate 2
+ /// @param avphi average phi (is set to 0. as default)
/// @param hphisec spanning phi sector (is set to pi as default)
EllipseBounds(double minrad1,
double minrad2,
@@ -63,6 +63,7 @@ public:
///
/// @param ebo is the source bounds for the copy
EllipseBounds(const EllipseBounds& ebo) : PlanarBounds(ebo) {}
+
/// Destructor
virtual ~EllipseBounds();
--
GitLab