From cfa2912ec1a50f9d1cbe7e3ac3df573657d01a34 Mon Sep 17 00:00:00 2001
From: Jay Rainey <jawrainey@gmail.com>
Date: Thu, 29 May 2014 10:23:08 +0100
Subject: [PATCH] Added summary method to WorkFlow algorithms. Refs #9523.
---
.../MantidWorkflowAlgorithms/AlignAndFocusPowder.h | 7 ++++---
.../inc/MantidWorkflowAlgorithms/ComputeSensitivity.h | 4 ++--
.../DgsAbsoluteUnitsReduction.h | 4 ++--
.../DgsConvertToEnergyTransfer.h | 4 ++--
.../inc/MantidWorkflowAlgorithms/DgsDiagnose.h | 4 +++-
.../inc/MantidWorkflowAlgorithms/DgsPreprocessData.h | 4 +++-
.../DgsProcessDetectorVanadium.h | 4 +++-
.../inc/MantidWorkflowAlgorithms/DgsReduction.h | 4 +++-
.../inc/MantidWorkflowAlgorithms/DgsRemap.h | 4 +++-
.../EQSANSDarkCurrentSubtraction.h | 4 ++--
.../inc/MantidWorkflowAlgorithms/EQSANSLoad.h | 5 ++---
.../inc/MantidWorkflowAlgorithms/EQSANSMonitorTOF.h | 4 ++--
.../MantidWorkflowAlgorithms/EQSANSPatchSensitivity.h | 4 ++--
.../inc/MantidWorkflowAlgorithms/EQSANSQ2D.h | 4 ++--
.../inc/MantidWorkflowAlgorithms/EQSANSReduce.h | 4 ++--
.../HFIRDarkCurrentSubtraction.h | 4 ++--
.../inc/MantidWorkflowAlgorithms/HFIRLoad.h | 5 ++---
.../inc/MantidWorkflowAlgorithms/HFIRSANSNormalise.h | 4 ++--
.../MantidWorkflowAlgorithms/MuonCalculateAsymmetry.h | 4 +++-
.../inc/MantidWorkflowAlgorithms/MuonLoad.h | 4 +++-
.../inc/MantidWorkflowAlgorithms/RefReduction.h | 4 ++--
.../inc/MantidWorkflowAlgorithms/RefRoi.h | 4 ++--
.../inc/MantidWorkflowAlgorithms/SANSBeamFinder.h | 4 ++--
.../MantidWorkflowAlgorithms/SANSBeamFluxCorrection.h | 4 ++--
.../SANSSensitivityCorrection.h | 4 ++--
.../SANSSolidAngleCorrection.h | 4 ++--
.../MantidWorkflowAlgorithms/SetupEQSANSReduction.h | 5 ++---
.../inc/MantidWorkflowAlgorithms/SetupHFIRReduction.h | 5 ++---
.../MantidWorkflowAlgorithms/SetupILLD33Reduction.h | 6 +++---
.../inc/MantidWorkflowAlgorithms/StepScan.h | 4 +++-
.../WorkflowAlgorithms/src/AlignAndFocusPowder.cpp | 11 -----------
.../WorkflowAlgorithms/src/ComputeSensitivity.cpp | 7 -------
.../src/DgsAbsoluteUnitsReduction.cpp | 6 ------
.../src/DgsConvertToEnergyTransfer.cpp | 6 ------
.../Framework/WorkflowAlgorithms/src/DgsDiagnose.cpp | 6 ------
.../WorkflowAlgorithms/src/DgsPreprocessData.cpp | 6 ------
.../src/DgsProcessDetectorVanadium.cpp | 6 ------
.../Framework/WorkflowAlgorithms/src/DgsReduction.cpp | 6 ------
.../Framework/WorkflowAlgorithms/src/DgsRemap.cpp | 6 ------
.../src/EQSANSDarkCurrentSubtraction.cpp | 7 -------
.../Framework/WorkflowAlgorithms/src/EQSANSLoad.cpp | 7 -------
.../WorkflowAlgorithms/src/EQSANSMonitorTOF.cpp | 7 -------
.../WorkflowAlgorithms/src/EQSANSPatchSensitivity.cpp | 7 -------
.../Framework/WorkflowAlgorithms/src/EQSANSQ2D.cpp | 7 -------
.../src/HFIRDarkCurrentSubtraction.cpp | 7 -------
.../Framework/WorkflowAlgorithms/src/HFIRLoad.cpp | 7 -------
.../WorkflowAlgorithms/src/HFIRSANSNormalise.cpp | 7 -------
.../WorkflowAlgorithms/src/MuonCalculateAsymmetry.cpp | 7 -------
.../Framework/WorkflowAlgorithms/src/MuonLoad.cpp | 7 -------
.../Framework/WorkflowAlgorithms/src/RefReduction.cpp | 7 -------
.../Framework/WorkflowAlgorithms/src/RefRoi.cpp | 7 -------
.../WorkflowAlgorithms/src/SANSBeamFinder.cpp | 7 -------
.../WorkflowAlgorithms/src/SANSBeamFluxCorrection.cpp | 7 -------
.../src/SANSSensitivityCorrection.cpp | 7 -------
.../src/SANSSolidAngleCorrection.cpp | 7 -------
.../WorkflowAlgorithms/src/SetupEQSANSReduction.cpp | 7 -------
.../WorkflowAlgorithms/src/SetupHFIRReduction.cpp | 7 -------
.../WorkflowAlgorithms/src/SetupILLD33Reduction.cpp | 7 -------
.../Framework/WorkflowAlgorithms/src/StepScan.cpp | 6 ------
59 files changed, 71 insertions(+), 257 deletions(-)
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/AlignAndFocusPowder.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/AlignAndFocusPowder.h
index ccaae6a81dc..59f7f26e97e 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/AlignAndFocusPowder.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/AlignAndFocusPowder.h
@@ -67,10 +67,11 @@ namespace Mantid
virtual int version() const;
/// Algorithm's category for identification overriding a virtual method
virtual const std::string category() const;
-
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Algorithm to focus powder diffraction data into a number of histograms "
+ "according to a grouping scheme defined in a CalFile.";}
+
private:
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
// Overridden Algorithm methods
void init();
void exec();
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/ComputeSensitivity.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/ComputeSensitivity.h
index c81aeb014f6..e9404c0cf4e 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/ComputeSensitivity.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/ComputeSensitivity.h
@@ -42,14 +42,14 @@ public:
virtual ~ComputeSensitivity() {}
/// Algorithm's name
virtual const std::string name() const { return "ComputeSensitivity"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Workflow to calculate EQSANS sensitivity correction.";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\SANS\\UsesPropertyManager"; }
private:
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsAbsoluteUnitsReduction.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsAbsoluteUnitsReduction.h
index d4c7fa8c8b2..d7845d62cd2 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsAbsoluteUnitsReduction.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsAbsoluteUnitsReduction.h
@@ -39,13 +39,13 @@ namespace Mantid
public:
DgsAbsoluteUnitsReduction();
virtual ~DgsAbsoluteUnitsReduction();
-
virtual const std::string name() const;
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Process the absolute units sample.";}
virtual int version() const;
virtual const std::string category() const;
private:
- virtual void initDocs();
void init();
void exec();
};
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsConvertToEnergyTransfer.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsConvertToEnergyTransfer.h
index ee076fd54a7..de0c84bb934 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsConvertToEnergyTransfer.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsConvertToEnergyTransfer.h
@@ -39,13 +39,13 @@ namespace Mantid
public:
DgsConvertToEnergyTransfer();
virtual ~DgsConvertToEnergyTransfer();
-
virtual const std::string name() const;
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Algorithm to convert from TOF to energy transfer.";}
virtual int version() const;
virtual const std::string category() const;
private:
- virtual void initDocs();
void init();
void exec();
};
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsDiagnose.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsDiagnose.h
index c71cfcd62b4..24c64360863 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsDiagnose.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsDiagnose.h
@@ -42,11 +42,13 @@ namespace Mantid
virtual ~DgsDiagnose();
virtual const std::string name() const;
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Setup and run DetectorDiagnostic.";}
+
virtual int version() const;
virtual const std::string category() const;
private:
- virtual void initDocs();
void init();
void exec();
};
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsPreprocessData.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsPreprocessData.h
index c4e5293482a..289f38a50fc 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsPreprocessData.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsPreprocessData.h
@@ -42,11 +42,13 @@ namespace Mantid
virtual ~DgsPreprocessData();
virtual const std::string name() const;
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Preprocess data via an incident beam parameter.";}
+
virtual int version() const;
virtual const std::string category() const;
private:
- virtual void initDocs();
void init();
void exec();
};
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsProcessDetectorVanadium.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsProcessDetectorVanadium.h
index 7f4f5adac59..532e338dcbb 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsProcessDetectorVanadium.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsProcessDetectorVanadium.h
@@ -42,11 +42,13 @@ namespace Mantid
virtual ~DgsProcessDetectorVanadium();
virtual const std::string name() const;
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Algorithm to process detector vanadium.";}
+
virtual int version() const;
virtual const std::string category() const;
private:
- virtual void initDocs();
void init();
void exec();
};
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsReduction.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsReduction.h
index 8239418f207..0ab2636359c 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsReduction.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsReduction.h
@@ -42,11 +42,13 @@ namespace Mantid
virtual ~DgsReduction();
virtual const std::string name() const;
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Top-level workflow algorithm for DGS reduction.";}
+
virtual int version() const;
virtual const std::string category() const;
private:
- virtual void initDocs();
void init();
void exec();
API::Workspace_sptr loadInputData(const std::string prop,
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsRemap.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsRemap.h
index c16743ab7fd..0d771fd77c1 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsRemap.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/DgsRemap.h
@@ -42,11 +42,13 @@ namespace WorkflowAlgorithms
virtual ~DgsRemap();
virtual const std::string name() const;
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Mask and/or group the given workspace.";}
+
virtual int version() const;
virtual const std::string category() const;
private:
- virtual void initDocs();
void init();
void exec();
void execGrouping(API::MatrixWorkspace_sptr iWS, API::MatrixWorkspace_sptr &oWS);
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSDarkCurrentSubtraction.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSDarkCurrentSubtraction.h
index fc45b858d55..31ac70d3850 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSDarkCurrentSubtraction.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSDarkCurrentSubtraction.h
@@ -40,14 +40,14 @@ public:
virtual ~EQSANSDarkCurrentSubtraction() {}
/// Algorithm's name
virtual const std::string name() const { return "EQSANSDarkCurrentSubtraction"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Perform EQSANS dark current subtraction.";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\SANS\\UsesPropertyManager"; }
private:
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSLoad.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSLoad.h
index eab8fd5933f..af4fe8a06ce 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSLoad.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSLoad.h
@@ -58,15 +58,14 @@ public:
virtual ~EQSANSLoad() {}
/// Algorithm's name
virtual const std::string name() const { return "EQSANSLoad"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Load EQSANS data.";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\SANS"; }
private:
-
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSMonitorTOF.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSMonitorTOF.h
index 66677f243e0..942f0d7a70a 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSMonitorTOF.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSMonitorTOF.h
@@ -55,14 +55,14 @@ public:
virtual ~EQSANSMonitorTOF() {}
/// Algorithm's name
virtual const std::string name() const { return "EQSANSMonitorTOF"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Converts the TOF into a wavelength for the beam monitor. This algorithm needs to be run once on every data set.";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\SANS"; }
private:
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSPatchSensitivity.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSPatchSensitivity.h
index f4628ae94cb..333f9e46d5c 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSPatchSensitivity.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSPatchSensitivity.h
@@ -42,14 +42,14 @@ public:
virtual ~EQSANSPatchSensitivity() {}
/// Algorithm's name
virtual const std::string name() const { return "EQSANSPatchSensitivity"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Patch EQSANS sensitivity correction.";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\SANS"; }
private:
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSQ2D.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSQ2D.h
index 19855b57a66..05051195e3e 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSQ2D.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSQ2D.h
@@ -28,14 +28,14 @@ public:
virtual ~EQSANSQ2D() {}
/// Algorithm's name
virtual const std::string name() const { return "EQSANSQ2D"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Workflow algorithm to process a reduced EQSANS workspace and produce I(Qx,Qy).";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\SANS"; }
private:
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSReduce.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSReduce.h
index 579b7455e4d..e022a3fe0e3 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSReduce.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/EQSANSReduce.h
@@ -47,10 +47,10 @@ public:
virtual int version() const { return (1); }
/// Algorithm's category for identification. @see Algorithm::category
virtual const std::string category() const { return "Workflow\\SANS\\UsesPropertyManager"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Perform EQSANS data reduction.";}
private:
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/HFIRDarkCurrentSubtraction.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/HFIRDarkCurrentSubtraction.h
index 337e78ca41e..e006184848c 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/HFIRDarkCurrentSubtraction.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/HFIRDarkCurrentSubtraction.h
@@ -41,14 +41,14 @@ public:
virtual ~HFIRDarkCurrentSubtraction() {}
/// Algorithm's name
virtual const std::string name() const { return "HFIRDarkCurrentSubtraction"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Perform HFIR SANS dark current subtraction.";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\SANS\\UsesPropertyManager"; }
private:
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/HFIRLoad.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/HFIRLoad.h
index 81372f7e52a..7773aac3d80 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/HFIRLoad.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/HFIRLoad.h
@@ -51,15 +51,14 @@ public:
virtual ~HFIRLoad() {}
/// Algorithm's name
virtual const std::string name() const { return "HFIRLoad"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Load HFIR SANS data.";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\SANS\\UsesPropertyManager"; }
private:
-
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/HFIRSANSNormalise.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/HFIRSANSNormalise.h
index 206f9d1f8f0..c03683bb33f 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/HFIRSANSNormalise.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/HFIRSANSNormalise.h
@@ -20,14 +20,14 @@ public:
virtual ~HFIRSANSNormalise() {}
/// Algorithm's name
virtual const std::string name() const { return "HFIRSANSNormalise"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Apply normalisation correction to HFIR SANS data.";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\SANS"; }
private:
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/MuonCalculateAsymmetry.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/MuonCalculateAsymmetry.h
index a86e132c541..d4ad5fd4cb6 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/MuonCalculateAsymmetry.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/MuonCalculateAsymmetry.h
@@ -37,11 +37,13 @@ namespace WorkflowAlgorithms
virtual ~MuonCalculateAsymmetry();
virtual const std::string name() const;
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Converts loaded/prepared Muon data to a data suitable for analysis.";}
+
virtual int version() const;
virtual const std::string category() const;
private:
- virtual void initDocs();
void init();
void exec();
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/MuonLoad.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/MuonLoad.h
index 269dbc2ada0..8c620871390 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/MuonLoad.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/MuonLoad.h
@@ -38,11 +38,13 @@ namespace WorkflowAlgorithms
virtual ~MuonLoad();
virtual const std::string name() const;
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Loads Muon workspace ready for analysis.";}
+
virtual int version() const;
virtual const std::string category() const;
private:
- virtual void initDocs();
void init();
void exec();
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/RefReduction.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/RefReduction.h
index 449436fadd2..b15e39afd5e 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/RefReduction.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/RefReduction.h
@@ -45,14 +45,14 @@ public:
virtual ~RefReduction() {}
/// Algorithm's name
virtual const std::string name() const { return "RefReduction"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Data reduction for reflectometry.";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\Reflectometry"; }
private:
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/RefRoi.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/RefRoi.h
index 5946b9e9cae..7b54cf10ca7 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/RefRoi.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/RefRoi.h
@@ -44,14 +44,14 @@ public:
virtual ~RefRoi() {}
/// Algorithm's name
virtual const std::string name() const { return "RefRoi"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Workflow algorithm for reflectometry to sum up a region of interest on a 2D detector.";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\Reflectometry"; }
private:
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SANSBeamFinder.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SANSBeamFinder.h
index ebb10d4fa18..4493d813778 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SANSBeamFinder.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SANSBeamFinder.h
@@ -44,14 +44,14 @@ public:
virtual ~SANSBeamFinder() {}
/// Algorithm's name
virtual const std::string name() const { return "SANSBeamFinder"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Beam finder workflow algorithm for SANS instruments.";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\SANS\\UsesPropertyManager"; }
private:
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SANSBeamFluxCorrection.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SANSBeamFluxCorrection.h
index 3c582638096..57199379799 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SANSBeamFluxCorrection.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SANSBeamFluxCorrection.h
@@ -25,14 +25,14 @@ public:
virtual ~SANSBeamFluxCorrection() {}
/// Algorithm's name
virtual const std::string name() const { return "SANSBeamFluxCorrection"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Performs beam flux correction on TOF SANS data.";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\SANS\\UsesPropertyManager;CorrectionFunctions\\InstrumentCorrections"; }
private:
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SANSSensitivityCorrection.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SANSSensitivityCorrection.h
index 06815d8f154..bdcd5deed0e 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SANSSensitivityCorrection.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SANSSensitivityCorrection.h
@@ -45,14 +45,14 @@ public:
virtual ~SANSSensitivityCorrection() {}
/// Algorithm's name
virtual const std::string name() const { return "SANSSensitivityCorrection"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Perform SANS sensitivity correction.";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\SANS\\UsesPropertyManager"; }
private:
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SANSSolidAngleCorrection.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SANSSolidAngleCorrection.h
index 484135dc06d..3c7fc782113 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SANSSolidAngleCorrection.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SANSSolidAngleCorrection.h
@@ -43,14 +43,14 @@ public:
virtual ~SANSSolidAngleCorrection() {}
/// Algorithm's name
virtual const std::string name() const { return "SANSSolidAngleCorrection"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Performs solid angle correction on SANS 2D data.";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\SANS\\UsesPropertyManager;CorrectionFunctions\\InstrumentCorrections"; }
private:
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SetupEQSANSReduction.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SetupEQSANSReduction.h
index b9c497bab96..3f68b8e9885 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SetupEQSANSReduction.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SetupEQSANSReduction.h
@@ -46,15 +46,14 @@ public:
virtual ~SetupEQSANSReduction() {}
/// Algorithm's name
virtual const std::string name() const { return "SetupEQSANSReduction"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Set up EQSANS SANS reduction options.";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\SANS"; }
private:
-
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SetupHFIRReduction.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SetupHFIRReduction.h
index e6f6d8dcd37..7e0b392f572 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SetupHFIRReduction.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SetupHFIRReduction.h
@@ -47,15 +47,14 @@ public:
virtual ~SetupHFIRReduction() {}
/// Algorithm's name
virtual const std::string name() const { return "SetupHFIRReduction"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Set up HFIR SANS reduction options.";}
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\SANS"; }
private:
-
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SetupILLD33Reduction.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SetupILLD33Reduction.h
index 8364e1c88db..bf3ba6b3d58 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SetupILLD33Reduction.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/SetupILLD33Reduction.h
@@ -46,15 +46,15 @@ public:
virtual ~SetupILLD33Reduction() {}
/// Algorithm's name
virtual const std::string name() const { return "SetupILLD33Reduction"; }
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Set up ILL D33 SANS reduction options.";}
+
/// Algorithm's version
virtual int version() const { return (1); }
/// Algorithm's category for identification
virtual const std::string category() const { return "Workflow\\SANS"; }
private:
-
- /// Sets documentation strings for this algorithm
- virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/StepScan.h b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/StepScan.h
index 358dcd68d57..3369759def9 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/StepScan.h
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/StepScan.h
@@ -40,11 +40,13 @@ namespace WorkflowAlgorithms
virtual ~StepScan();
virtual const std::string name() const;
+ ///Summary of algorithms purpose
+ virtual const std::string summary() const {return "Workflow algorithm for analysis of an alignment scan from an SNS Adara-enabled beam line";}
+
virtual int version() const;
virtual const std::string category() const;
private:
- virtual void initDocs();
void init();
void exec();
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/AlignAndFocusPowder.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/AlignAndFocusPowder.cpp
index 7f2ebf865e3..dfa6f92b3da 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/AlignAndFocusPowder.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/AlignAndFocusPowder.cpp
@@ -81,17 +81,6 @@ namespace WorkflowAlgorithms
return "Workflow\\Diffraction";
}
- //----------------------------------------------------------------------------------------------
- /** Sets documentation strings for this algorithm
- */
- void AlignAndFocusPowder::initDocs()
- {
- this->setWikiSummary("Algorithm to focus powder diffraction data into a number of histograms "
- "according to a grouping scheme defined in a [[CalFile]]. ");
- this->setOptionalMessage("Algorithm to focus powder diffraction data into a number of histograms "
- "according to a grouping scheme defined in a CalFile.");
- }
-
//----------------------------------------------------------------------------------------------
/** Initialisation method. Declares properties to be used in algorithm.
*/
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/ComputeSensitivity.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/ComputeSensitivity.cpp
index 558ad312a79..609069a8add 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/ComputeSensitivity.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/ComputeSensitivity.cpp
@@ -28,13 +28,6 @@ namespace WorkflowAlgorithms
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(ComputeSensitivity)
-/// Sets documentation strings for this algorithm
-void ComputeSensitivity::initDocs()
-{
- this->setWikiSummary("Workflow to calculate EQSANS sensitivity correction.");
- this->setOptionalMessage("Workflow to calculate EQSANS sensitivity correction.");
-}
-
using namespace Kernel;
using namespace API;
using namespace Geometry;
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsAbsoluteUnitsReduction.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsAbsoluteUnitsReduction.cpp
index c4b986eb299..d7f0b0d179e 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsAbsoluteUnitsReduction.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsAbsoluteUnitsReduction.cpp
@@ -101,12 +101,6 @@ namespace Mantid
const std::string DgsAbsoluteUnitsReduction::category() const { return "Workflow\\Inelastic\\UsesPropertyManager"; }
//----------------------------------------------------------------------------------------------
- /// Sets documentation strings for this algorithm
- void DgsAbsoluteUnitsReduction::initDocs()
- {
- this->setWikiSummary("Process the absolute units sample.");
- this->setOptionalMessage("Process the absolute units sample.");
- }
//----------------------------------------------------------------------------------------------
/** Initialize the algorithm's properties.
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsConvertToEnergyTransfer.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsConvertToEnergyTransfer.cpp
index 3ed127c1d8f..845048876c8 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsConvertToEnergyTransfer.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsConvertToEnergyTransfer.cpp
@@ -90,12 +90,6 @@ namespace Mantid
const std::string DgsConvertToEnergyTransfer::category() const { return "Workflow\\Inelastic\\UsesPropertyManager"; }
//----------------------------------------------------------------------------------------------
- /// Sets documentation strings for this algorithm
- void DgsConvertToEnergyTransfer::initDocs()
- {
- this->setWikiSummary("Algorithm to convert from TOF to energy transfer.");
- this->setOptionalMessage("Algorithm to convert from TOF to energy transfer.");
- }
//----------------------------------------------------------------------------------------------
/** Initialize the algorithm's properties.
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsDiagnose.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsDiagnose.cpp
index 47393b4519f..e4a26ec2f53 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsDiagnose.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsDiagnose.cpp
@@ -133,12 +133,6 @@ namespace Mantid
const std::string DgsDiagnose::category() const { return "Workflow\\Inelastic\\UsesPropertyManager"; }
//----------------------------------------------------------------------------------------------
- /// Sets documentation strings for this algorithm
- void DgsDiagnose::initDocs()
- {
- this->setWikiSummary("Setup and run DetectorDiagnostic.");
- this->setOptionalMessage("Setup and run DetectorDiagnostic.");
- }
//----------------------------------------------------------------------------------------------
/** Initialize the algorithm's properties.
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsPreprocessData.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsPreprocessData.cpp
index e79ab8dee76..0c9da40c4a1 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsPreprocessData.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsPreprocessData.cpp
@@ -81,12 +81,6 @@ namespace Mantid
const std::string DgsPreprocessData::category() const { return "Workflow\\Inelastic\\UsesPropertyManager"; }
//----------------------------------------------------------------------------------------------
- /// Sets documentation strings for this algorithm
- void DgsPreprocessData::initDocs()
- {
- this->setWikiSummary("Preprocess data via an incident beam parameter.");
- this->setOptionalMessage("Preprocess data via an incident beam parameter.");
- }
//----------------------------------------------------------------------------------------------
/** Initialize the algorithm's properties.
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsProcessDetectorVanadium.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsProcessDetectorVanadium.cpp
index 246a2d6c822..add6c8b607e 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsProcessDetectorVanadium.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsProcessDetectorVanadium.cpp
@@ -74,12 +74,6 @@ namespace Mantid
const std::string DgsProcessDetectorVanadium::category() const { return "Workflow\\Inelastic\\UsesPropertyManager"; }
//----------------------------------------------------------------------------------------------
- /// Sets documentation strings for this algorithm
- void DgsProcessDetectorVanadium::initDocs()
- {
- this->setWikiSummary("Algorithm to process detector vanadium.");
- this->setOptionalMessage("Algorithm to process detector vanadium.");
- }
//----------------------------------------------------------------------------------------------
/** Initialize the algorithm's properties.
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsReduction.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsReduction.cpp
index 1848b57fe13..5af5380ec3f 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsReduction.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsReduction.cpp
@@ -70,12 +70,6 @@ namespace Mantid
const std::string DgsReduction::category() const { return "Workflow\\Inelastic"; }
//----------------------------------------------------------------------------------------------
- /// Sets documentation strings for this algorithm
- void DgsReduction::initDocs()
- {
- this->setWikiSummary("Top-level workflow algorithm for DGS reduction.");
- this->setOptionalMessage("Top-level workflow algorithm for DGS reduction.");
- }
//----------------------------------------------------------------------------------------------
/** Initialize the algorithm's properties.
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsRemap.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsRemap.cpp
index 847e2181965..e3d6e0ee171 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsRemap.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/DgsRemap.cpp
@@ -49,12 +49,6 @@ namespace WorkflowAlgorithms
const std::string DgsRemap::category() const { return "Workflow\\Inelastic"; }
//----------------------------------------------------------------------------------------------
- /// Sets documentation strings for this algorithm
- void DgsRemap::initDocs()
- {
- this->setWikiSummary("Mask and/or group the given workspace.");
- this->setOptionalMessage("Mask and/or group the given workspace.");
- }
//----------------------------------------------------------------------------------------------
/** Initialize the algorithm's properties.
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSDarkCurrentSubtraction.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSDarkCurrentSubtraction.cpp
index b37ea6eefa3..aed0e453215 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSDarkCurrentSubtraction.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSDarkCurrentSubtraction.cpp
@@ -33,13 +33,6 @@ namespace WorkflowAlgorithms
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(EQSANSDarkCurrentSubtraction)
-/// Sets documentation strings for this algorithm
-void EQSANSDarkCurrentSubtraction::initDocs()
-{
- this->setWikiSummary("Perform EQSANS dark current subtraction.");
- this->setOptionalMessage("Perform EQSANS dark current subtraction.");
-}
-
using namespace Kernel;
using namespace API;
using namespace Geometry;
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSLoad.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSLoad.cpp
index 210fc5045ae..d8fdfb62d90 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSLoad.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSLoad.cpp
@@ -48,13 +48,6 @@ namespace WorkflowAlgorithms
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(EQSANSLoad)
-/// Sets documentation strings for this algorithm
-void EQSANSLoad::initDocs()
-{
- this->setWikiSummary("Load EQSANS data.");
- this->setOptionalMessage("Load EQSANS data.");
-}
-
using namespace Kernel;
using namespace API;
using namespace Geometry;
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSMonitorTOF.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSMonitorTOF.cpp
index fbd906ab595..b412a374fc1 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSMonitorTOF.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSMonitorTOF.cpp
@@ -25,13 +25,6 @@ namespace WorkflowAlgorithms
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(EQSANSMonitorTOF)
-/// Sets documentation strings for this algorithm
-void EQSANSMonitorTOF::initDocs()
-{
- this->setWikiSummary("Converts the TOF into a wavelength for the beam monitor. This algorithm needs to be run once on every data set. ");
- this->setOptionalMessage("Converts the TOF into a wavelength for the beam monitor. This algorithm needs to be run once on every data set.");
-}
-
using namespace Kernel;
using namespace API;
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSPatchSensitivity.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSPatchSensitivity.cpp
index a13b323c07a..684cbe83adc 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSPatchSensitivity.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSPatchSensitivity.cpp
@@ -15,13 +15,6 @@ namespace WorkflowAlgorithms
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(EQSANSPatchSensitivity)
-/// Sets documentation strings for this algorithm
-void EQSANSPatchSensitivity::initDocs()
-{
- this->setWikiSummary("Patch EQSANS sensitivity correction.");
- this->setOptionalMessage("Patch EQSANS sensitivity correction.");
-}
-
using namespace Kernel;
using namespace API;
using namespace Geometry;
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSQ2D.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSQ2D.cpp
index 0492405c945..48af8be0a8d 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSQ2D.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSQ2D.cpp
@@ -20,13 +20,6 @@ namespace WorkflowAlgorithms
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(EQSANSQ2D)
-/// Sets documentation strings for this algorithm
-void EQSANSQ2D::initDocs()
-{
- this->setWikiSummary("Workflow algorithm to process a reduced EQSANS workspace and produce I(Qx,Qy).");
- this->setOptionalMessage("Workflow algorithm to process a reduced EQSANS workspace and produce I(Qx,Qy).");
-}
-
using namespace Kernel;
using namespace API;
using namespace Geometry;
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/HFIRDarkCurrentSubtraction.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/HFIRDarkCurrentSubtraction.cpp
index 8c07a9ae4d3..f0dd03e31a6 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/HFIRDarkCurrentSubtraction.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/HFIRDarkCurrentSubtraction.cpp
@@ -33,13 +33,6 @@ namespace WorkflowAlgorithms
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(HFIRDarkCurrentSubtraction)
-/// Sets documentation strings for this algorithm
-void HFIRDarkCurrentSubtraction::initDocs()
-{
- this->setWikiSummary("Perform HFIR SANS dark current subtraction.");
- this->setOptionalMessage("Perform HFIR SANS dark current subtraction.");
-}
-
using namespace Kernel;
using namespace API;
using namespace Geometry;
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/HFIRLoad.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/HFIRLoad.cpp
index 838d7afedff..0405f6cc6ef 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/HFIRLoad.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/HFIRLoad.cpp
@@ -33,13 +33,6 @@ namespace WorkflowAlgorithms
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(HFIRLoad)
-/// Sets documentation strings for this algorithm
-void HFIRLoad::initDocs()
-{
- this->setWikiSummary("Load HFIR SANS data.");
- this->setOptionalMessage("Load HFIR SANS data.");
-}
-
using namespace Kernel;
using namespace API;
using namespace Geometry;
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/HFIRSANSNormalise.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/HFIRSANSNormalise.cpp
index 8fffc9ad1a7..910fcb8c7d8 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/HFIRSANSNormalise.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/HFIRSANSNormalise.cpp
@@ -22,13 +22,6 @@ using namespace API;
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(HFIRSANSNormalise)
-/// Sets documentation strings for this algorithm
-void HFIRSANSNormalise::initDocs()
-{
- this->setWikiSummary("Apply normalisation correction to HFIR SANS data.");
- this->setOptionalMessage("Apply normalisation correction to HFIR SANS data.");
-}
-
void HFIRSANSNormalise::init()
{
declareProperty(new WorkspaceProperty<>("InputWorkspace","",Direction::Input),
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/MuonCalculateAsymmetry.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/MuonCalculateAsymmetry.cpp
index 90caec9beee..56a8305468d 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/MuonCalculateAsymmetry.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/MuonCalculateAsymmetry.cpp
@@ -51,13 +51,6 @@ namespace WorkflowAlgorithms
//----------------------------------------------------------------------------------------------
- /// Sets documentation strings for this algorithm
- void MuonCalculateAsymmetry::initDocs()
- {
- this->setWikiSummary("Converts loaded/prepared Muon data to a data suitable for analysis.");
- this->setOptionalMessage("Converts loaded/prepared Muon data to a data suitable for analysis.");
- }
-
//----------------------------------------------------------------------------------------------
/**
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/MuonLoad.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/MuonLoad.cpp
index 6d91a13aeb5..802169f1255 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/MuonLoad.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/MuonLoad.cpp
@@ -61,13 +61,6 @@ namespace WorkflowAlgorithms
//----------------------------------------------------------------------------------------------
- /// Sets documentation strings for this algorithm
- void MuonLoad::initDocs()
- {
- this->setWikiSummary("Loads Muon workspace ready for analysis.");
- this->setOptionalMessage("Loads Muon workspace ready for analysis.");
- }
-
//----------------------------------------------------------------------------------------------
/*
* Initialize the algorithm's properties.
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/RefReduction.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/RefReduction.cpp
index d0294433c54..68fffc91dd2 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/RefReduction.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/RefReduction.cpp
@@ -38,13 +38,6 @@ const int RefReduction::NX_PIXELS(304);
const int RefReduction::NY_PIXELS(256);
const double RefReduction::PIXEL_SIZE(0.0007);
-/// Sets documentation strings for this algorithm
-void RefReduction::initDocs()
-{
- this->setWikiSummary("Data reduction for reflectometry.");
- this->setOptionalMessage("Data reduction for reflectometry.");
-}
-
using namespace Kernel;
using namespace API;
using namespace Geometry;
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/RefRoi.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/RefRoi.cpp
index aa9afc0a661..947983a59ab 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/RefRoi.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/RefRoi.cpp
@@ -19,13 +19,6 @@ namespace WorkflowAlgorithms
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(RefRoi)
-/// Sets documentation strings for this algorithm
-void RefRoi::initDocs()
-{
- this->setWikiSummary("Workflow algorithm for reflectometry to sum up a region of interest on a 2D detector.");
- this->setOptionalMessage("Workflow algorithm for reflectometry to sum up a region of interest on a 2D detector.");
-}
-
using namespace Kernel;
using namespace API;
using namespace Geometry;
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/SANSBeamFinder.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/SANSBeamFinder.cpp
index 26aa8955393..32fbf4f520a 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/SANSBeamFinder.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/SANSBeamFinder.cpp
@@ -28,13 +28,6 @@ namespace WorkflowAlgorithms
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(SANSBeamFinder)
-/// Sets documentation strings for this algorithm
-void SANSBeamFinder::initDocs()
-{
- this->setWikiSummary("Beam finder workflow algorithm for SANS instruments.");
- this->setOptionalMessage("Beam finder workflow algorithm for SANS instruments.");
-}
-
using namespace Kernel;
using namespace API;
using namespace Geometry;
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/SANSBeamFluxCorrection.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/SANSBeamFluxCorrection.cpp
index a969019e6a1..b447873e4cd 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/SANSBeamFluxCorrection.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/SANSBeamFluxCorrection.cpp
@@ -32,13 +32,6 @@ using namespace Geometry;
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(SANSBeamFluxCorrection)
-/// Sets documentation strings for this algorithm
-void SANSBeamFluxCorrection::initDocs()
-{
- this->setWikiSummary("Performs beam flux correction on TOF SANS data.");
- this->setOptionalMessage("Performs beam flux correction on TOF SANS data.");
-}
-
void SANSBeamFluxCorrection::init()
{
declareProperty(new WorkspaceProperty<>("InputWorkspace","",Direction::Input),
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/SANSSensitivityCorrection.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/SANSSensitivityCorrection.cpp
index 3ae6697f887..030dba8869a 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/SANSSensitivityCorrection.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/SANSSensitivityCorrection.cpp
@@ -43,13 +43,6 @@ namespace WorkflowAlgorithms
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(SANSSensitivityCorrection)
-/// Sets documentation strings for this algorithm
-void SANSSensitivityCorrection::initDocs()
-{
- this->setWikiSummary("Perform SANS sensitivity correction.");
- this->setOptionalMessage("Perform SANS sensitivity correction.");
-}
-
using namespace Kernel;
using namespace API;
using namespace Geometry;
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/SANSSolidAngleCorrection.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/SANSSolidAngleCorrection.cpp
index a02865b37b9..ae5146e1bd7 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/SANSSolidAngleCorrection.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/SANSSolidAngleCorrection.cpp
@@ -60,13 +60,6 @@ static double getYTubeAngle(IDetector_const_sptr det,
return sampleDetVec.angle(beamLine);
}
-/// Sets documentation strings for this algorithm
-void SANSSolidAngleCorrection::initDocs()
-{
- this->setWikiSummary("Performs solid angle correction on SANS 2D data.");
- this->setOptionalMessage("Performs solid angle correction on SANS 2D data.");
-}
-
void SANSSolidAngleCorrection::init()
{
auto wsValidator = boost::make_shared<CompositeValidator>();
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/SetupEQSANSReduction.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/SetupEQSANSReduction.cpp
index 3e39ddb494f..80fdee8e7cd 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/SetupEQSANSReduction.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/SetupEQSANSReduction.cpp
@@ -29,13 +29,6 @@ namespace WorkflowAlgorithms
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(SetupEQSANSReduction)
-/// Sets documentation strings for this algorithm
-void SetupEQSANSReduction::initDocs()
-{
- this->setWikiSummary("Set up EQSANS SANS reduction options.");
- this->setOptionalMessage("Set up EQSANS SANS reduction options.");
-}
-
using namespace Kernel;
using namespace API;
using namespace Geometry;
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/SetupHFIRReduction.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/SetupHFIRReduction.cpp
index 67688faec02..de840ffa1ae 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/SetupHFIRReduction.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/SetupHFIRReduction.cpp
@@ -27,13 +27,6 @@ namespace WorkflowAlgorithms
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(SetupHFIRReduction)
-/// Sets documentation strings for this algorithm
-void SetupHFIRReduction::initDocs()
-{
- this->setWikiSummary("Set up HFIR SANS reduction options.");
- this->setOptionalMessage("Set up HFIR SANS reduction options.");
-}
-
using namespace Kernel;
using namespace API;
using namespace Geometry;
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/SetupILLD33Reduction.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/SetupILLD33Reduction.cpp
index ba718cca98f..a4a9faccf32 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/SetupILLD33Reduction.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/SetupILLD33Reduction.cpp
@@ -29,13 +29,6 @@ namespace WorkflowAlgorithms
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(SetupILLD33Reduction)
-/// Sets documentation strings for this algorithm
-void SetupILLD33Reduction::initDocs()
-{
- this->setWikiSummary("Set up ILL D33 SANS reduction options.");
- this->setOptionalMessage("Set up ILL D33 SANS reduction options.");
-}
-
using namespace Kernel;
using namespace API;
using namespace Geometry;
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/StepScan.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/StepScan.cpp
index d1fd1c9aa5f..6976177df9d 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/StepScan.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/StepScan.cpp
@@ -42,12 +42,6 @@ namespace WorkflowAlgorithms
/// Algorithm's category for identification. @see Algorithm::category
const std::string StepScan::category() const { return "Workflow\\Alignment";}
- void StepScan::initDocs()
- {
- this->setWikiSummary("Workflow algorithm for analysis of an alignment scan. CAN ONLY BE USED WITH SNS DATA FROM AN ADARA-ENABLED BEAMLINE.");
- this->setOptionalMessage("Workflow algorithm for analysis of an alignment scan from an SNS Adara-enabled beam line");
- }
-
void StepScan::init()
{
// TODO: Validator to ensure that this is 'fresh' data???
--
GitLab