refs #8789. Improve documentation.

mantidproject · Jan 31, 2014 · 2d6f6c0 · 2d6f6c0
1 parent 8095434
commit 2d6f6c0
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 6 deletions.
diff --git a/Code/Mantid/Framework/Algorithms/src/CreateTransmissionWorkspace.cpp b/Code/Mantid/Framework/Algorithms/src/CreateTransmissionWorkspace.cpp
@@ -64,9 +64,9 @@ namespace Mantid
     /// Sets documentation strings for this algorithm
     void CreateTransmissionWorkspace::initDocs()
     {
+      this->setOptionalMessage("Creates a transmission run workspace in Wavelength from input TOF workspaces.");
       this->setWikiSummary(
-          "Creates a transmission run workspace in Wavelength from input TOF workspaces.");
-      this->setOptionalMessage(this->getWikiSummary());
+          "Creates a transmission run workspace in Wavelength from input TOF workspaces. See [[Reflectometry_Guide]]");
     }
 
     //----------------------------------------------------------------------------------------------

diff --git a/Code/Mantid/Framework/Algorithms/src/ReflectometryReductionOne.cpp b/Code/Mantid/Framework/Algorithms/src/ReflectometryReductionOne.cpp
@@ -124,9 +124,8 @@ namespace Mantid
     /// Sets documentation strings for this algorithm
     void ReflectometryReductionOne::initDocs()
     {
-      this->setWikiSummary(
-          "Reduces a single TOF reflectometry run into a mod Q vs I/I0 workspace. Performs transmission corrections.");
-      this->setOptionalMessage(this->getWikiSummary());
+      this->setOptionalMessage("Reduces a single TOF reflectometry run into a mod Q vs I/I0 workspace. Performs transmission corrections.");
+      this->setWikiSummary("Reduces a single TOF reflectometry run into a mod Q vs I/I0 workspace. Performs transmission corrections. See [[Reflectometry_Guide]]");
     }
 
     //----------------------------------------------------------------------------------------------

diff --git a/Code/Mantid/Framework/PythonInterface/plugins/algorithms/CreateTransmissionWorkspaceAuto.py b/Code/Mantid/Framework/PythonInterface/plugins/algorithms/CreateTransmissionWorkspaceAuto.py
@@ -22,6 +22,9 @@ def name(self):
         return "CreateTransmissionWorkspaceAuto"
 
     def PyInit(self):
+
+        self.setOptionalMessage("Creates a transmission run workspace in Wavelength from input TOF workspaces.")
+        self.setWikiSummary("Creates a transmission run workspace in Wavelength from input TOF workspaces. See [[Reflectometry_Guide]]")
 
         analysis_modes = ["PointDetectorAnalysis", "MultiDetectorAnalysis"]
         analysis_mode_validator = StringListValidator(analysis_modes)

diff --git a/Code/Mantid/Framework/PythonInterface/plugins/algorithms/ReflectometryReductionOneAuto.py b/Code/Mantid/Framework/PythonInterface/plugins/algorithms/ReflectometryReductionOneAuto.py
@@ -22,7 +22,10 @@ def name(self):
         return "ReflectometryReductionOneAuto"
 
     def PyInit(self):
-
+
+        self.setOptionalMessage("Reduces a single TOF reflectometry run into a mod Q vs I/I0 workspace. Performs transmission corrections.")
+        self.setWikiSummary("Reduces a single TOF reflectometry run into a mod Q vs I/I0 workspace. Performs transmission corrections. See [[Reflectometry_Guide]]")
+
         input_validator = WorkspaceUnitValidator("TOF")
         self.declareProperty(MatrixWorkspaceProperty(name="InputWorkspace", defaultValue="", direction=Direction.Input, optional=PropertyMode.Mandatory), "Input run in TOF")