From b31d4a63c392d5551f77e322cca115bb2e069bc9 Mon Sep 17 00:00:00 2001
From: Dereck Kachere <tendekai.kachere@stfc.ac.uk>
Date: Thu, 14 Feb 2013 18:35:01 +0000
Subject: [PATCH] refs #6485 Mantid framework algorithms doxygen fixes.
Not done all. NormaliseToMonitor, GetDetOffsetsMultiPeaks, NormaliseByCurrent, SumSpectra and Transpose still need finishing.
---
.../src/CreateGroupingWorkspace.cpp | 1 +
.../Algorithms/src/DetectorDiagnostic.cpp | 1 +
.../Framework/Algorithms/src/FindPeaks.cpp | 8 +++--
.../Algorithms/src/GenerateEventsFilter.cpp | 30 +++++++++++--------
.../src/GetDetOffsetsMultiPeaks.cpp | 13 ++++++--
.../Algorithms/src/MedianDetectorTest.cpp | 17 ++++++-----
.../Framework/Algorithms/src/ResampleX.cpp | 2 +-
.../Algorithms/src/ResetNegatives.cpp | 2 ++
8 files changed, 49 insertions(+), 25 deletions(-)
diff --git a/Code/Mantid/Framework/Algorithms/src/CreateGroupingWorkspace.cpp b/Code/Mantid/Framework/Algorithms/src/CreateGroupingWorkspace.cpp
index 13e9704a4cd..5a81b2ed967 100644
--- a/Code/Mantid/Framework/Algorithms/src/CreateGroupingWorkspace.cpp
+++ b/Code/Mantid/Framework/Algorithms/src/CreateGroupingWorkspace.cpp
@@ -164,6 +164,7 @@ namespace Algorithms
* @param inst :: instrument
* @param detIDtoGroup :: output: map of detID: to group number
* @param prog :: progress report
+ * @param sortnames :: sort names - a boolean
*/
void makeGroupingByNames(std::string GroupNames, Instrument_const_sptr inst, std::map<detid_t, int> & detIDtoGroup, Progress & prog, bool sortnames)
{
diff --git a/Code/Mantid/Framework/Algorithms/src/DetectorDiagnostic.cpp b/Code/Mantid/Framework/Algorithms/src/DetectorDiagnostic.cpp
index b74a8a61121..9d7a53c51e7 100644
--- a/Code/Mantid/Framework/Algorithms/src/DetectorDiagnostic.cpp
+++ b/Code/Mantid/Framework/Algorithms/src/DetectorDiagnostic.cpp
@@ -605,6 +605,7 @@ namespace Mantid
* The median is an average that is less affected by small numbers of very large values.
* @param input :: A histogram workspace with one entry in each bin
* @param excludeZeroes :: If true then zeroes will not be included in the median calculation
+ * @param indexmap :: indexmap
* @return The median value of the histograms in the workspace that was passed to it
* @throw out_of_range if a value is negative
*/
diff --git a/Code/Mantid/Framework/Algorithms/src/FindPeaks.cpp b/Code/Mantid/Framework/Algorithms/src/FindPeaks.cpp
index 64b45a53420..0c9afcb9bc1 100644
--- a/Code/Mantid/Framework/Algorithms/src/FindPeaks.cpp
+++ b/Code/Mantid/Framework/Algorithms/src/FindPeaks.cpp
@@ -311,7 +311,7 @@ void FindPeaks::exec()
//=================================================================================================
/** Use the Mariscotti method to find the start positions to fit gaussian peaks
- * @param peakCenters Vector of the center x-positions specified to perform fits.
+ * @param peakCentres Vector of the center x-positions specified to perform fits.
* @param fitWindows List of windows around each peak. If not specified windows will
* be determined automatically.
*/
@@ -763,7 +763,7 @@ void FindPeaks::fitPeak(const API::MatrixWorkspace_sptr &input, const int spectr
*
* @param input The input workspace
* @param spectrum The spectrum index of the peak (is actually the WorkspaceIndex)
- * @param center Channel number of peak candidate i0 - the higher side of the peak (right side)
+ * @param centre Channel number of peak candidate i0 - the higher side of the peak (right side)
* @param left Channel number of peak candidate i2 - the lower side of the peak (left side)
* @param right Channel number of peak candidate i4 - the center of the peak
*/
@@ -1405,6 +1405,10 @@ void FindPeaks::updateFitResults(API::IAlgorithm_sptr fitAlg, std::vector<double
/**
* Create a function for fitting.
+ * @param height Height
+ * @param centre Centre
+ * @param sigma Sigma
+ * @param a0, a1, a2 Variables dependent on background order.
* @param withPeak If this is set to false then return only a background function.
* @return The requested function to fit.
*/
diff --git a/Code/Mantid/Framework/Algorithms/src/GenerateEventsFilter.cpp b/Code/Mantid/Framework/Algorithms/src/GenerateEventsFilter.cpp
index 2911a5d63b0..a6ab72f89ec 100644
--- a/Code/Mantid/Framework/Algorithms/src/GenerateEventsFilter.cpp
+++ b/Code/Mantid/Framework/Algorithms/src/GenerateEventsFilter.cpp
@@ -577,13 +577,17 @@ namespace Algorithms
* SINGLE log values >= min and < max. Creates SplittingInterval's where
* times match the log values, and going to index==0.
*
+ * @param mlog :: Log.
+ * @param filterIncrease :: As log value increase, and within (min, max), include this range in the filter.
+ * @param filterDecrease :: As log value increase, and within (min, max), include this range in the filter.
+ * @param startTime :: Start time.
+ * @param stopTime :: Stop time.
+ * @param wsindex :: Workspace index.
* @param split :: Splitter that will be filled.
- * @param min :: min value
- * @param max :: max value
- * @param TimeTolerance :: offset added to times in seconds.
+ * @param min :: Min value.
+ * @param max :: Max value.
+ * @param TimeTolerance :: Offset added to times in seconds.
* @param centre :: Whether the log value time is considered centred or at the beginning.
- * @filterIncrease: as log value increase, and within (min, max), include this range in the filter
- * @filterDecrease: as log value increase, and within (min, max), include this range in the filter
*/
void GenerateEventsFilter::makeFilterByValue(Kernel::TimeSeriesProperty<double>* mlog,
Kernel::TimeSplitterType& split, double min, double max, double TimeTolerance, bool centre,
@@ -725,13 +729,15 @@ namespace Algorithms
* SINGLE log values >= min and < max. Creates SplittingInterval's where
* times match the log values, and going to index==0.
*
+ * @param mlog :: Log.
* @param split :: Splitter that will be filled.
- * @param min :: min value
- * @param max :: max value
+ * @param indexwsindexmap :: Index.
+ * @param logvalueranges :: A vector of double. Each 2i and 2i+1 pair is one individual log value range.
* @param centre :: Whether the log value time is considered centred or at the beginning.
- * @param log valuerange: a vector of double. Each 2i and 2i+1 pair is one individual log value range.
- * @filterIncrease: as log value increase, and within (min, max), include this range in the filter
- * @filterDecrease: as log value increase, and within (min, max), include this range in the filter
+ * @param filterIncrease :: As log value increase, and within (min, max), include this range in the filter.
+ * @param filterDecrease :: As log value increase, and within (min, max), include this range in the filter.
+ * @param startTime :: Start time.
+ * @param stopTime :: Stop time.
*/
void GenerateEventsFilter::makeMultipleFiltersByValues(Kernel::TimeSeriesProperty<double>* mlog,
Kernel::TimeSplitterType& split, std::map<size_t, int> indexwsindexmap, std::vector<double> logvalueranges,
@@ -983,8 +989,8 @@ namespace Algorithms
* Warning: if the vector is not sorted, the error will happen.
* This algorithm won't guarantee for it
*
- * @param dataranges: a list of data to search for value;
- * @param value: value to look up
+ * @param sorteddata :: Sorted data.
+ * @param value :: Value to look up.
*
* return: if value is out of range, then return datarange.size() + 1
*/
diff --git a/Code/Mantid/Framework/Algorithms/src/GetDetOffsetsMultiPeaks.cpp b/Code/Mantid/Framework/Algorithms/src/GetDetOffsetsMultiPeaks.cpp
index 4b0a156c494..79f12601909 100644
--- a/Code/Mantid/Framework/Algorithms/src/GetDetOffsetsMultiPeaks.cpp
+++ b/Code/Mantid/Framework/Algorithms/src/GetDetOffsetsMultiPeaks.cpp
@@ -446,8 +446,17 @@ namespace Mantid
//-----------------------------------------------------------------------------------------
/** Calls Gaussian1D as a child algorithm to fit the offset peak in a spectrum
*
- * @param s :: The Workspace Index to fit
- * @return The calculated offset value
+ * @param s :: The Workspace Index to fit.
+ * @param inputW :: Input workspace.
+ * @param peakPositions :: Peak positions.
+ * @param fitWindows :: Fit windows.
+ * @param nparams :: Number of parameters.
+ * @param minD :: Min distance.
+ * @param maxD :: Max distance.
+ * @param peakPosToFit :: Peak positions to fit.
+ * @param peakPosFitted :: Peak positions fitted.
+ * @param chisq :: chisq.
+ * @return The calculated offset value
*/
void GetDetOffsetsMultiPeaks::fitSpectra(const int64_t s, MatrixWorkspace_sptr inputW, const std::vector<double> &peakPositions,
diff --git a/Code/Mantid/Framework/Algorithms/src/MedianDetectorTest.cpp b/Code/Mantid/Framework/Algorithms/src/MedianDetectorTest.cpp
index d058acc2464..49205496f8d 100644
--- a/Code/Mantid/Framework/Algorithms/src/MedianDetectorTest.cpp
+++ b/Code/Mantid/Framework/Algorithms/src/MedianDetectorTest.cpp
@@ -238,9 +238,10 @@ namespace Mantid
/**
* Mask the outlier values to get a better median value.
- * @param median The median value calculated from the current counts
- * @param countsWS The counts workspace. Any outliers will be masked here
- * @returns The number masked
+ * @param medianvec The median value calculated from the current counts.
+ * @param countsWS The counts workspace. Any outliers will be masked here.
+ * @param indexmap Index map.
+ * @returns The number failed.
*/
int MedianDetectorTest::maskOutliers(const std::vector<double> medianvec, API::MatrixWorkspace_sptr countsWS,std::vector<std::vector<size_t> > indexmap)
{
@@ -298,11 +299,11 @@ namespace Mantid
/**
* Takes a single valued histogram workspace and assesses which histograms are within the limits.
* Those that are not are masked on the input workspace.
- * @param countWorkspace :: Input/Output Integrated workspace to diagnose
- * @param maskWS :: A mask workspace to apply
- * @param average :: The expected number of counts, spectra within defined threshold won't fail
- * @param badIndices :: If an index is in this list then it will not be included in the tests
- * @return The number of detectors that failed the tests, not including those skipped
+ * @param countsWS :: Input/Output Integrated workspace to diagnose.
+ * @param medianvec The median value calculated from the current counts.
+ * @param indexmap Index map.
+ * @param maskWS :: A mask workspace to apply.
+ * @return The number of detectors that failed the tests, not including those skipped.
*/
int MedianDetectorTest::doDetectorTests(const API::MatrixWorkspace_sptr countsWS, const std::vector<double> medianvec,
std::vector<std::vector<size_t> > indexmap, API::MatrixWorkspace_sptr maskWS)
diff --git a/Code/Mantid/Framework/Algorithms/src/ResampleX.cpp b/Code/Mantid/Framework/Algorithms/src/ResampleX.cpp
index 2804238e213..8e04885edcc 100644
--- a/Code/Mantid/Framework/Algorithms/src/ResampleX.cpp
+++ b/Code/Mantid/Framework/Algorithms/src/ResampleX.cpp
@@ -177,7 +177,7 @@ namespace Algorithms
}
/**
- * Set the instance variables before running a test of @link ResampleX::determineBinning.
+ * Set the instance variables before running a test of @link ResampleX::determineBinning @endlink
*
* @param numBins The number of bins that will be used.
* @param useLogBins True if you want log binning.
diff --git a/Code/Mantid/Framework/Algorithms/src/ResetNegatives.cpp b/Code/Mantid/Framework/Algorithms/src/ResetNegatives.cpp
index b64e32b48ac..7145e457238 100644
--- a/Code/Mantid/Framework/Algorithms/src/ResetNegatives.cpp
+++ b/Code/Mantid/Framework/Algorithms/src/ResetNegatives.cpp
@@ -169,6 +169,7 @@ namespace Algorithms
* @param minWS A workspace of minimum values for each spectra. This is calculated in
* the @see exec portion of the algorithm.
* @param wksp The workspace to modify.
+ * @param prog The progress.
*/
void ResetNegatives::pushMinimum(MatrixWorkspace_const_sptr minWS, MatrixWorkspace_sptr wksp, Progress &prog)
{
@@ -200,6 +201,7 @@ namespace Algorithms
* @param minWS A workspace of minimum values for each spectra.
* @param value Reset negative values in the spectra to this number.
* @param wksp The workspace to modify.
+ * @param prog The progress.
*/
void ResetNegatives::changeNegatives(MatrixWorkspace_const_sptr minWS, const double value, MatrixWorkspace_sptr wksp,
Progress &prog)
--
GitLab