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
......@@ -68,6 +68,8 @@ public:
virtual const std::string category() const { return "CorrectionFunctions";}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
// Overridden Algorithm methods
void init();
void exec();
......
......@@ -58,6 +58,8 @@ public:
virtual const std::string category() const { return "General"; }
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// used for the progress bar: the, approximate, fraction of processing time that taken up with loading the file
static const double LOAD_TIME;
/// Initialisation code
......
......@@ -68,6 +68,8 @@ public:
virtual const std::string category() const { return "Diffraction"; }
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Calibration entries map
typedef std::map<int,std::pair<int,int> > instrcalmap;
/// Initialisation code
......
......@@ -68,6 +68,8 @@ public:
virtual const std::string category() const { return "Diffraction"; }
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Calibration entries map
typedef std::map<int,std::pair<int,int> > instrcalmap;
/// Initialisation code
......
......@@ -53,6 +53,8 @@ namespace Mantid
virtual const std::string name() const { return "CreatePSDBleedMask";}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
// Overridden Algorithm methods
void init();
void exec();
......
......@@ -60,6 +60,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
......
......@@ -54,6 +54,8 @@ public:
virtual int version() const { return (1); } ///< @return version number of algorithm
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Initialise the Algorithm (declare properties)
void init();
/// Execute the Algorithm
......
......@@ -73,6 +73,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
......
......@@ -64,6 +64,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
......
......@@ -52,6 +52,8 @@ public:
virtual int version() const { return (1); }
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
std::string sampleXML();
void initialiseCachedDistances();
};
......
......@@ -78,6 +78,8 @@ public:
virtual int version() const { return (1); }
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
void defineProperties();
void retrieveProperties();
std::string sampleXML();
......
......@@ -48,6 +48,8 @@ namespace Mantid
virtual int version() const { return 1; }
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Overridden init
void init();
/// Overridden exec
......
......@@ -94,6 +94,8 @@ class DLLExport DetectorEfficiencyCor : public API::Algorithm
virtual const std::string category() const{return "CorrectionFunctions";}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Retrieve algorithm properties
void retrieveProperties();
/// Correct the given spectra index for efficiency
......
......@@ -81,6 +81,8 @@ namespace Mantid
static const int LINESIZE = 10;
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// when this is set to false reading and writing to the detector map is disabled,
/// this is done if there is no map in the workspace
bool m_usableMaskMap;
......
......@@ -58,6 +58,8 @@ public:
void movedetector(double x, double y, double z, double rotx, double roty, double rotz, std::string detname, API::MatrixWorkspace_sptr inputW);
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
// Overridden Algorithm methods
void init();
void exec();
......
......@@ -56,6 +56,8 @@ public:
/// Function to optimize
void center(double x, double y, double z, std::string detname, std::string inname);
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
// Overridden Algorithm methods
void init();
void exec();
......
......@@ -74,6 +74,8 @@ namespace Mantid
virtual const std::string category() const { return "Diffraction";}
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
// Overridden Algorithm methods
void init();
void exec();
......
......@@ -91,6 +91,8 @@ public:
virtual const std::string category() const { return "Diffraction"; }
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);
......
......@@ -68,6 +68,8 @@ public:
const std::map<int,double> &offsets, const std::map<int,bool> &selects, std::map<int,int> &groups);
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
// Implement abstract 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