Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
mantidproject
mantid
Commits
d76ff109
Commit
d76ff109
authored
Mar 23, 2018
by
Nick Draper
Browse files
Add SeeAlso to most algorithms
re #22143
parent
6f318cd1
Changes
554
Hide whitespace changes
Inline
Side-by-side
Framework/Algorithms/inc/MantidAlgorithms/AddLogDerivative.h
View file @
d76ff109
...
...
@@ -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"
;
}
...
...
Framework/Algorithms/inc/MantidAlgorithms/AddNote.h
View file @
d76ff109
...
...
@@ -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
;
...
...
Framework/Algorithms/inc/MantidAlgorithms/AddPeak.h
View file @
d76ff109
...
...
@@ -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"
;
}
...
...
Framework/Algorithms/inc/MantidAlgorithms/AddSampleLog.h
View file @
d76ff109
...
...
@@ -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"
;
}
...
...
Framework/Algorithms/inc/MantidAlgorithms/AddTimeSeriesLog.h
View file @
d76ff109
...
...
@@ -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:
...
...
Framework/Algorithms/inc/MantidAlgorithms/AlignDetectors.h
View file @
d76ff109
...
...
@@ -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
...
...
Framework/Algorithms/inc/MantidAlgorithms/AnnularRingAbsorption.h
View file @
d76ff109
...
...
@@ -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
;
...
...
Framework/Algorithms/inc/MantidAlgorithms/AppendSpectra.h
View file @
d76ff109
...
...
@@ -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
...
...
Framework/Algorithms/inc/MantidAlgorithms/ApplyDeadTimeCorr.h
View file @
d76ff109
...
...
@@ -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"
;
...
...
Framework/Algorithms/inc/MantidAlgorithms/ApplyTransmissionCorrection.h
View file @
d76ff109
...
...
@@ -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"
;
...
...
Framework/Algorithms/inc/MantidAlgorithms/AsymmetryCalc.h
View file @
d76ff109
...
...
@@ -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"
;
}
...
...
Framework/Algorithms/inc/MantidAlgorithms/Bin2DPowderDiffraction.h
View file @
d76ff109
...
...
@@ -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
...
...
Framework/Algorithms/inc/MantidAlgorithms/BinaryOperateMasks.h
View file @
d76ff109
...
...
@@ -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"
;
}
...
...
Framework/Algorithms/inc/MantidAlgorithms/CalMuonDeadTime.h
View file @
d76ff109
...
...
@@ -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"
;
}
...
...
Framework/Algorithms/inc/MantidAlgorithms/CalculateCountRate.h
View file @
d76ff109
...
...
@@ -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
...
...
Framework/Algorithms/inc/MantidAlgorithms/CalculateDIFC.h
View file @
d76ff109
...
...
@@ -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
;
...
...
Framework/Algorithms/inc/MantidAlgorithms/CalculateMuonAsymmetry.h
View file @
d76ff109
...
...
@@ -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"
;
}
...
...
Framework/Algorithms/inc/MantidAlgorithms/CalculatePolynomialBackground.h
View file @
d76ff109
...
...
@@ -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
;
...
...
Framework/Algorithms/inc/MantidAlgorithms/CalculateSlits.h
View file @
d76ff109
...
...
@@ -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
;
...
...
Framework/Algorithms/inc/MantidAlgorithms/CalculateTransmission.h
View file @
d76ff109
...
...
@@ -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"
;
...
...
Prev
1
2
3
4
5
…
28
Next
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment