From 7202d670c2ed74c0e6859e1da86bae095cf20fda Mon Sep 17 00:00:00 2001
From: Danny Hindson <danny.hindson@stfc.ac.uk>
Date: Thu, 23 Jan 2020 10:53:09 +0000
Subject: [PATCH] Fix Doxygen documentation warnings
---
.../Algorithms/src/SampleCorrections/MCAbsorptionStrategy.cpp | 2 +-
.../Algorithms/src/SampleCorrections/MCInteractionVolume.cpp | 1 +
2 files changed, 2 insertions(+), 1 deletion(-)
diff --git a/Framework/Algorithms/src/SampleCorrections/MCAbsorptionStrategy.cpp b/Framework/Algorithms/src/SampleCorrections/MCAbsorptionStrategy.cpp
index ecc657117f2..2eda78efa3a 100644
--- a/Framework/Algorithms/src/SampleCorrections/MCAbsorptionStrategy.cpp
+++ b/Framework/Algorithms/src/SampleCorrections/MCAbsorptionStrategy.cpp
@@ -23,6 +23,7 @@ namespace Algorithms {
* @param sample A reference to the object defining details of the sample
* @param nevents The number of Monte Carlo events used in the simulation
* @param maxScatterPtAttempts The maximum number of tries to generate a random
+ * @param logger Logger from parent algorithm to write logging info
* point within the object.
*/
MCAbsorptionStrategy::MCAbsorptionStrategy(const IBeamProfile &beamProfile,
@@ -44,7 +45,6 @@ MCAbsorptionStrategy::MCAbsorptionStrategy(const IBeamProfile &beamProfile,
* where it is detected
* @param lambdaBefore Wavelength, in \f$\\A^-1\f$, before scattering
* @param lambdaAfter Wavelength, in \f$\\A^-1\f$, after scattering
- * @param debugString String describing debug information from calculation
* @return A tuple of the <correction factor, associated error>.
*/
std::tuple<double, double>
diff --git a/Framework/Algorithms/src/SampleCorrections/MCInteractionVolume.cpp b/Framework/Algorithms/src/SampleCorrections/MCInteractionVolume.cpp
index 71bdaf1274b..1f9ce25fec8 100644
--- a/Framework/Algorithms/src/SampleCorrections/MCInteractionVolume.cpp
+++ b/Framework/Algorithms/src/SampleCorrections/MCInteractionVolume.cpp
@@ -26,6 +26,7 @@ namespace Algorithms {
* @param sample A reference to a sample object that defines a valid shape
* & material
* @param activeRegion Restrict scattering point sampling to this region
+ * @param logger Logger to write debug information on scatter pt stats
* @param maxScatterAttempts The maximum number of tries to generate a random
* point within the object. [Default=5000]
*/
--
GitLab