Doxygen fix, RST doc update

Refs #10802

Code/Mantid/MantidQt/CustomInterfaces/inc/MantidQtCustomInterfaces/DataComparison.h

@@ -84,9 +84,9 @@ namespace CustomInterfaces
 
   private:
     // Handlers for ADS events
-    void preDeleteHandle(const std::string& wsName,const boost::shared_ptr<Mantid::API::Workspace> ws);
+    void preDeleteHandle(const std::string& wsName, const boost::shared_ptr<Mantid::API::Workspace> ws);
     void renameHandle(const std::string &oldName, const std::string &newName);
-    void afterReplaceHandle(const std::string& wsName,const boost::shared_ptr<Mantid::API::Workspace> ws);
+    void afterReplaceHandle(const std::string& wsName, const boost::shared_ptr<Mantid::API::Workspace> ws);
 
     // The form generated by Qt Designer
     Ui::DataComparison m_uiForm;

Code/Mantid/MantidQt/CustomInterfaces/src/DataComparison.cpp

@@ -135,7 +135,7 @@ void DataComparison::addData()
 /**
  * Adds a MatrixWorkspace by name to the data table.
  *
- * @param wsName Name of workspace to add.
+ * @param ws Pointer to workspace to add.
  */
 void DataComparison::addDataItem(Workspace_const_sptr ws)
 {
@@ -668,7 +668,7 @@ void DataComparison::resetView()
  * @param wsName Name of the workspace being deleted
  * @param ws Pointer to the workspace
  */
-void DataComparison::preDeleteHandle(const std::string& wsName,const boost::shared_ptr<Mantid::API::Workspace> ws)
+void DataComparison::preDeleteHandle(const std::string& wsName, const boost::shared_ptr<Mantid::API::Workspace> ws)
 {
   UNUSED_ARG(ws);
   QString oldWsName = QString::fromStdString(wsName);
@@ -731,9 +731,9 @@ void DataComparison::renameHandle(const std::string &oldName, const std::string
  * Handle replotting after a workspace has been changed.
  *
  * @param wsName Name of changed workspace
- * @ws Pointer to changed workspace
+ * @param ws Pointer to changed workspace
  */
-void DataComparison::afterReplaceHandle(const std::string& wsName,const boost::shared_ptr<Mantid::API::Workspace> ws)
+void DataComparison::afterReplaceHandle(const std::string& wsName, const boost::shared_ptr<Mantid::API::Workspace> ws)
 {
   UNUSED_ARG(wsName);
   UNUSED_ARG(ws);

Code/Mantid/docs/source/interfaces/DataComparison.rst

@@ -15,7 +15,9 @@ multiple :ref:`MatrixWorkspace <MatrixWorkspace>` (either pre loaded into
 Mantid or loaded via the interface its self) using a preview plot.
 
 Note that data in this plot is not normalised to bin width as it is by default
-in Mantid plot windows.
+in Mantid plot windows, to reduce plotting artefacts you may want to consider
+running :ref:`ConvertToDistribution <algm-ConvertToDistribution>` prior to
+loading the data into the UI.
 
 Add Data
 --------
@@ -28,6 +30,9 @@ This allows new data to be added to the comparison, this can be added by either
 selecting a :ref:`MatrixWorkspace <MatrixWorkspace>` alrady loaded into Mantid
 or by selecting a file to load.
 
+Alternatively you can select a :ref:`WorkspaceGroup <WorkspaceGroup>` to load
+it's contents into the UI.
+
 Once the data has been selected the *Add Data* button can be used to add it to
 the comparison, this will add a curve to the preview plot and assign it the next
 unused colour for the curve (if all are in use then black will be used).
@@ -96,7 +101,13 @@ shown, however the diff will continue to function once both workspaces can be
 displayed again.
 
 The diff workspace is created by running :ref:`ExtractSignleSpectrum
-<algm-ExtractSingleSpectrum>` on the two data workspaces and then using
-:ref:`Minus <algm-Minus>` to calculate the difference.
+<algm-ExtractSingleSpectrum>` on the two data workspaces, the second of which is
+then rebinned to match the binning of the first using :ref:`RebinToWorkspace
+<algm-RebinToWorkspace>` and then using :ref:`Minus <algm-Minus>` to calculate
+the difference.
+
+Note that if the two diffed workspaces have different binning, then the second
+one selected will be rebinned to match the first before the diff is created.
+This will not modify the data in the otiginal workspace.
 
 .. categories:: Interfaces General