Commit 126c3892 authored by Janik Zikovsky's avatar Janik Zikovsky
Browse files

Refs #2572: Added an initDocs() for all algorithms that sets the summary...

Refs #2572: Added an initDocs() for all algorithms that sets the summary string to display in the dialog, as well as the wiki summary for possible later auto-wiki-fication of documentation.
parent 0dce5f15
......@@ -62,6 +62,8 @@ public:
virtual const std::string category() const { return "General"; }
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Initialisation code
void init();
///Execution code
......
......@@ -51,6 +51,8 @@ public:
virtual const std::string category() const { return "Diffraction"; }
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
API::MatrixWorkspace_sptr inputW; ///< A pointer to the input workspace
API::MatrixWorkspace_sptr outputW; ///< A pointer to the output workspace
// Overridden Algorithm methods
......
......@@ -58,6 +58,8 @@ public:
virtual const std::string category() const{return "CorrectionFunctions";}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// name of the tempory workspace that we create and use
API::MatrixWorkspace_sptr m_tempWS;
/// An estimate of the percentage of the algorithm runtimes that has been completed
......
......@@ -64,6 +64,8 @@ namespace Algorithms
virtual const std::string category() const{return "CorrectionFunctions";}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Calculate Ei from the initial guess given
double calculateEi(const double initial_guess);
/// Get the distance from the source of the detector at the workspace index given
......
......@@ -129,6 +129,8 @@ public:
virtual const std::string category() const { return "Diffraction";}
protected:
/// Sets documentation strings for this algorithm
virtual void initDocs();
// Overridden Algorithm methods
void init();
virtual void exec();
......
......@@ -71,6 +71,8 @@ public:
virtual const std::string category() const { return "Diffraction"; }
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
......
......@@ -65,6 +65,8 @@ public:
virtual const std::string category() const{ return "CorrectionFunctions"; }
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
// Implement abstract Algorithm methods
void init();
void exec();
......
......@@ -60,6 +60,8 @@ public:
virtual const std::string category() const { return "SANS"; }
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
void init();
void exec();
......
......@@ -45,6 +45,8 @@ class DLLExport IdentifyNoisyDetectors : public API::Algorithm
virtual int version() const { return (1); } ///< @return version number of algorithm
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
void init(); ///< Initialise the algorithm. Declare properties, etc.
void exec(); ///< Executes the algorithm.
......
......@@ -65,6 +65,8 @@ public:
virtual const std::string category() const { return "General";}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
// Overridden Algorithm methods
void init();
void exec();
......
......@@ -74,6 +74,8 @@ public:
virtual const std::string category() const { return "Rebin";}
protected:
/// Sets documentation strings for this algorithm
virtual void initDocs();
// Overridden Algorithm methods
void init();
virtual void exec();
......
......@@ -63,6 +63,8 @@ public:
virtual const std::string category() const { return "General"; }
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Initialisation code
void init();
/// Execution code
......
......@@ -62,6 +62,8 @@ public:
virtual const std::string category() const { return "Diffraction"; }
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
#ifndef HAS_UNORDERED_MAP_H
/// Typedef for detector to value map
typedef std::map<int,bool> udet2valuem;
......
......@@ -63,6 +63,8 @@ public:
virtual const std::string category() const { return "General";}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
// Overridden Algorithm methods
void init();
void exec();
......
......@@ -57,6 +57,8 @@ namespace Mantid
virtual int version() const { return 1;}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
// Overridden BinaryOperation methods
void performBinaryOperation(const MantidVec& lhsX, const MantidVec& lhsY, const MantidVec& lhsE,
const MantidVec& rhsY, const MantidVec& rhsE, MantidVec& YOut, MantidVec& EOut);
......
......@@ -53,8 +53,7 @@ public:
virtual ~MultipleScatteringAbsorption() {};
/// Algorithm's name for identification overriding a virtual method
virtual const std::string name() const {
return "MultipleScatteringCylinderAbsorption";}
virtual const std::string name() const { return "MultipleScatteringCylinderAbsorption";}
/// Algorithm's version for identification overriding a virtual method
virtual int version() const { return 1;}
......
......@@ -57,6 +57,8 @@ namespace Mantid
virtual int version() const { return 1;}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
// Overridden BinaryOperation methods
void performBinaryOperation(const MantidVec& lhsX, const MantidVec& lhsY, const MantidVec& lhsE,
const MantidVec& rhsY, const MantidVec& rhsE, MantidVec& YOut, MantidVec& EOut);
......
......@@ -57,6 +57,8 @@ public:
virtual const std::string category() const { return "CorrectionFunctions";}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
///Initialisation code
void init();
///Execution code
......
......@@ -60,6 +60,8 @@ namespace Mantid
virtual const std::string category() const { return "Muon";}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
// Overridden Algorithm methods
void init();
void exec();
......
......@@ -57,6 +57,8 @@ public:
virtual const std::string category() const { return "General";}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
// Overridden Algorithm methods
void init();
void exec();
......
Supports Markdown
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