Commit d76ff109 authored by Nick Draper's avatar Nick Draper
Browse files

Add SeeAlso to most algorithms

re #22143
parent 6f318cd1
......@@ -47,6 +47,9 @@ public:
/// Algorithm's version for identification
int version() const override { return 1; };
const std::vector<std::string> seeAlso() const override {
return{ "AddSampleLog" };
}
/// Algorithm's category for identification
const std::string category() const override { return "DataHandling\\Logs"; }
......
......@@ -42,6 +42,9 @@ public:
const std::string name() const override;
int version() const override;
const std::vector<std::string> seeAlso() const override {
return{ "Comment" };
}
const std::string category() const override;
const std::string summary() const override;
......
......@@ -43,6 +43,9 @@ public:
}
/// Algorithm's version for identification
int version() const override { return 1; };
const std::vector<std::string> seeAlso() const override {
return{ "AddPeakHKL","CalculatePeaksHKL" };
}
/// Algorithm's category for identification
const std::string category() const override { return "Crystal\\Peaks"; }
......
......@@ -57,6 +57,9 @@ public:
/// Algorithm's version
int version() const override { return (1); }
const std::vector<std::string> seeAlso() const override {
return{ "AddSampleLogMultiple","AddTimeSeriesLog","DeleteLog","LoadLog" };
}
/// Algorithm's category for identification
const std::string category() const override { return "DataHandling\\Logs"; }
......
......@@ -42,6 +42,9 @@ public:
}
int version() const override;
const std::vector<std::string> seeAlso() const override {
return{ "AddSampleLog","GetTimeSeriesLogInformation","MergeLogs" };
}
const std::string category() const override;
private:
......
......@@ -67,6 +67,9 @@ public:
/// Algorithm's version for identification. @see Algorithm::version
int version() const override;
const std::vector<std::string> seeAlso() const override {
return{ "DiffractionFocussing","AlignAndFocusPowder" };
}
/// Algorithm's category for identification. @see Algorithm::category
const std::string category() const override;
/// Cross-check properties with each other @see IAlgorithm::validateInputs
......
......@@ -43,6 +43,9 @@ class DLLExport AnnularRingAbsorption : public API::Algorithm {
public:
const std::string name() const override;
int version() const override;
const std::vector<std::string> seeAlso() const override {
return{ "AbsorptionCorrection" };
}
const std::string category() const override;
const std::string summary() const override;
......
......@@ -46,6 +46,9 @@ class DLLExport AppendSpectra : public WorkspaceJoiners {
public:
const std::string name() const override;
int version() const override;
const std::vector<std::string> seeAlso() const override {
return{ "ConjoinSpectra" };
}
private:
// Overridden Algorithm methods
......
......@@ -45,6 +45,9 @@ public:
/// Algorithm's version for identification
int version() const override { return 1; };
const std::vector<std::string> seeAlso() const override {
return{ "CalMuonDeadTime" };
}
/// Algorithm's category for identification
const std::string category() const override {
return "Muon;CorrectionFunctions\\EfficiencyCorrections";
......
......@@ -55,6 +55,9 @@ public:
/// Algorithm's version
int version() const override { return (1); }
const std::vector<std::string> seeAlso() const override {
return{ "CalculateTransmission","CalculateTransmissionBeamSpreader" };
}
/// Algorithm's category for identification
const std::string category() const override {
return "SANS;CorrectionFunctions\\TransmissionCorrections";
......
......@@ -61,6 +61,9 @@ public:
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; }
const std::vector<std::string> seeAlso() const override {
return{ "CalculateMuonAsymmetry" };
}
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "Muon"; }
......
......@@ -40,6 +40,9 @@ class MANTID_ALGORITHMS_DLL Bin2DPowderDiffraction : public API::Algorithm {
public:
const std::string name() const override;
int version() const override;
const std::vector<std::string> seeAlso() const override {
return{ "Rebin2D" };
}
const std::string category() const override;
const std::string summary() const override;
/// Cross-check properties with each other @see IAlgorithm::validateInputs
......
......@@ -45,6 +45,9 @@ public:
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; };
const std::vector<std::string> seeAlso() const override {
return{ "InvertMask" };
}
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "Transforms\\Masking"; }
......
......@@ -45,6 +45,9 @@ public:
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; }
const std::vector<std::string> seeAlso() const override {
return{ "ApplyDeadTimeCorr" };
}
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "Muon"; }
......
......@@ -47,6 +47,9 @@ class DLLExport CalculateCountRate : public API::Algorithm {
public:
const std::string name() const override;
int version() const override;
const std::vector<std::string> seeAlso() const override {
return{ "ChangePulsetime" };
}
const std::string category() const override;
const std::string summary() const override;
/// Helper function: true if count rate should be normalized and false
......
......@@ -38,6 +38,9 @@ public:
const std::string name() const override;
/// Algorithm's version for identification. @see Algorithm::version
int version() const override;
const std::vector<std::string> seeAlso() const override {
return{ "ConvertDiffCal" };
}
const std::string category() const override;
/// Algorithm's summary for use in the GUI and help. @see Algorithm::summary
const std::string summary() const override;
......
......@@ -70,6 +70,9 @@ public:
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; }
const std::vector<std::string> seeAlso() const override {
return{ "AsymmetryCalc" };
}
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "Muon"; }
......
......@@ -37,6 +37,9 @@ class MANTID_ALGORITHMS_DLL CalculatePolynomialBackground
public:
const std::string name() const override;
int version() const override;
const std::vector<std::string> seeAlso() const override {
return{ "RemoveBackground","CreateUserDefinedBackground" };
}
const std::string category() const override;
const std::string summary() const override;
......
......@@ -40,6 +40,9 @@ public:
const std::string name() const override;
int version() const override;
const std::vector<std::string> seeAlso() const override {
return{ "NRCalculateSlitResolution" };
}
const std::string category() const override;
const std::string summary() const override;
......
......@@ -76,6 +76,9 @@ public:
/// Algorithm's version
int version() const override { return (1); }
const std::vector<std::string> seeAlso() const override {
return{ "CalculateTransmissionBeamSpreader","ApplyTransmissionCorrection" };
}
/// Algorithm's category for identification
const std::string category() const override {
return "SANS;CorrectionFunctions\\TransmissionCorrections";
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment