Merge branch 'MaterialEffectUpdator_comments' into 'master'

ATLASRECTS-5609 : Material effects Updator , update comments

See merge request atlas/athena!35628

Tracking/TrkExtrapolation/TrkExInterfaces/TrkExInterfaces/IMaterialEffectsUpdator.h

@@ -84,8 +84,8 @@ public:
   virtual std::unique_ptr<ICache> getCache() const = 0;
 
   /** Updator interface (full update for a layer):
-    The parameters are given as a pointer, they are delete inside the update
-    method. Layer-based material update
+    The parameters are given as a pointer owned by the caller.
+    The returned ptr is owned by the caller.
     */
   virtual const TrackParameters* update(
     ICache& icache,
@@ -132,8 +132,8 @@ public:
     MaterialUpdateMode matupmode = addNoise) const = 0;
 
   /** Updator interface:
-    The parameters are given as a pointer, they are delete inside the update
-    method. MaterialProperties based material update
+    The parameters are given as a pointer owned by the caller.
+    The returned ptr is owned by the caller
     - used by all Layer-based methods
     */
   virtual TrackParameters* update(
@@ -169,8 +169,6 @@ public:
     ParticleHypothesis particle = pion,
     MaterialUpdateMode matupmode = addNoise) const = 0;
   /** Updator interface (pre-update for a layer):
-    The parameters are given as a pointer, they are delete inside the update
-    method. Layer-based material update
     */
   virtual TrackParameters* preUpdate(
     const TrackParameters* param,
@@ -181,7 +179,6 @@ public:
 
   /** Updator interface (pre-update for a layer):
     */
-
   virtual TrackParameters* postUpdate(
     const TrackParameters& param,
     const Layer& sf,

Tracking/TrkExtrapolation/TrkExTools/TrkExTools/MaterialEffectsUpdator.h

@@ -102,9 +102,7 @@ class MaterialEffectsUpdator : public AthAlgTool,
     }
 
     /** Updator interface (full update for a layer)
-      ---> ALWAYS the same pointer is returned
-      the pointer to the same TrackParameters object is returned,
-      it is manipulated (if sf.fullUpdateMaterial())
+      ---> ALWAYS  pointer to new TrackParameters is returned
       */
     virtual TrackParameters*  update(ICache& icache, const TrackParameters* parm,
                                            const Layer& sf,
@@ -121,9 +119,7 @@ class MaterialEffectsUpdator : public AthAlgTool,
     }
     /** Updator interface (full update for a layer) according to user
       input through MaterialEffectsOnTrack
-      ---> ALWAYS the same pointer is returned
-      the pointer to the same TrackParameters object is returned,
-      it is manipulated
+      ---> ALWAYS pointer to new TrackParameters is returned
       */
     virtual TrackParameters* update(ICache& icache,
                                           const TrackParameters* parm,
@@ -142,9 +138,7 @@ class MaterialEffectsUpdator : public AthAlgTool,
     }
 
     /** Updator interface (pre-update for a layer):
-      ---> ALWAYS the same pointer is returned
-      the pointer to the same TrackParametes object is returned,
-      it is manipulated (if.preUpdateMaterial())
+      ---> ALWAYS pointer to new TrackParameters is returned
       */
     virtual TrackParameters* preUpdate(ICache& icache,
                                              const TrackParameters* parm,
@@ -163,8 +157,8 @@ class MaterialEffectsUpdator : public AthAlgTool,
     }
 
     /** Updator interface (post-update for a layer):
-      ---> ALWAYS pointer to new TrackParameters are returned
-      if no postUpdate is to be done : return 0
+      ---> ALWAYS pointer to new TrackParameters is returned
+      if no postUpdate is to be done : return nullptr
       */
     virtual TrackParameters* postUpdate(
       ICache& icache,