refs #9581 First changes to SofQ code (format of properties)

mantidproject · Jun 5, 2014 · a6829aa · a6829aa
1 parent e744125
commit a6829aa
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/SofQW.h b/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/SofQW.h
@@ -55,7 +55,7 @@ class DLLExport SofQW : public API::Algorithm
   /// Algorithm's name
   virtual const std::string name() const { return "SofQW"; }
     ///Summary of algorithms purpose
-    virtual const std::string summary() const {return "Converts a 2D workspace that has axes of <math>\\Delta E</math> against spectrum number to one that gives intensity as a function of momentum transfer against energy: <math>\\rm{S}\\left( q, \\omega \\right)</math>.";}
+    virtual const std::string summary() const {return "Converts a 2D workspace that has axes of :math:`\\Delta E` against spectrum number to one that gives intensity as a function of momentum transfer against energy: :math:`\\rm{S}\\left( q, \\omega \\right)`.";}
 
   /// Algorithm's version
   virtual int version() const { return (1); }

diff --git a/Code/Mantid/Framework/Algorithms/src/SofQW.cpp b/Code/Mantid/Framework/Algorithms/src/SofQW.cpp
@@ -58,7 +58,7 @@ void SofQW::createInputProperties(API::Algorithm & alg)
   alg.declareProperty(new WorkspaceProperty<>("OutputWorkspace","",Direction::Output),
                       "The name to use for the q-omega workspace.");
   alg.declareProperty(new ArrayProperty<double>("QAxisBinning", boost::make_shared<RebinParamsValidator>()),
-                      "The bin parameters to use for the q axis (in the format used by the [[Rebin]] algorithm).");
+                      "The bin parameters to use for the q axis (in the format used by the :ref:`algm-Rebin` algorithm).");
 
   std::vector<std::string> propOptions;
   propOptions.push_back("Direct");
@@ -68,7 +68,7 @@ void SofQW::createInputProperties(API::Algorithm & alg)
   auto mustBePositive = boost::make_shared<BoundedValidator<double> >();
   mustBePositive->setLower(0.0);
   alg.declareProperty("EFixed",0.0,mustBePositive,
-      "The value of fixed energy: <math>E_i</math> (EMode=Direct) or <math>E_f</math> (EMode=Indirect) (meV).\nMust be set here if not available in the instrument definition.");
+      "The value of fixed energy: :math:`E_i` (EMode=Direct) or :math:`E_f` (EMode=Indirect) (meV).\nMust be set here if not available in the instrument definition.");
 
 }