Refs #3867. Fixing doxygen warnings.

Code/Mantid/Framework/Kernel/inc/MantidKernel/MagneticIon.h

@@ -28,7 +28,7 @@ namespace PhysicalConstants
     /// The charge of the ion, or 0 for neutral atom. Note thet all charges are not negative
     uint16_t charge;
 
-    /// A vector containing A, a, B, b, C, c D, e for each <j0>, <j2>, <j4>, and <j6> 
+    /// A vector containing A, a, B, b, C, c D, e for each \<j0\>, \<j2\>, \<j4\>, and \<j6\>
     std::vector <double> j0;
     std::vector <double> j2;
     std::vector <double> j4;

Code/Mantid/Framework/PythonInterface/mantid/api/src/AlgorithmWrapper.cpp

@@ -99,7 +99,7 @@ namespace Mantid
 
     /**
      * Private exec for this algorithm. Expected to be
-     * overridden in the subclass by a function named PyExec"
+     * overridden in the subclass by a function named PyExec
      */
     void AlgorithmWrapper::exec()
     {

Code/Mantid/MantidQt/API/src/UserSubWindow.cpp

@@ -215,7 +215,7 @@ QLabel* UserSubWindow::newValidator(QWidget *parent)
 /**
 * Re-emits the signal to change the plot style
 *
-* @params plotDetails :: This includes all details of the plot including type, 
+* @param plotDetails :: This includes all details of the plot including type,
 * curve number, workspace and color
 */
 void UserSubWindow::changePlotType(const QStringList& plotDetails)

Code/Mantid/MantidQt/CustomDialogs/src/MantidGLWidget.cpp

@@ -183,7 +183,7 @@ void MantidGLWidget::resizeGL(int width, int height)
 
 /**
  * Handle an event when a mouse button is pressed.
- * @prarm event A pointer to the QMouseEvent
+ * @param event A pointer to the QMouseEvent
  */
 void MantidGLWidget::mousePressEvent(QMouseEvent *event)
 {
@@ -192,7 +192,7 @@ void MantidGLWidget::mousePressEvent(QMouseEvent *event)
 
 /**
  * Handle an event where the cursor is moved with the mouse
- * @prarm event A pointer to the QMouseEvent
+ * @param event A pointer to the QMouseEvent
  */
 void MantidGLWidget::mouseMoveEvent(QMouseEvent *event)
 {

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

@@ -1183,7 +1183,6 @@ namespace MantidQt
 
     /**Execute sumrowcolumn algorithm 
     * @param values a vector containing the values for hvmin,hvmax
-    * @param periodNum - number of the  period to load
     * @param ipws - name of the i/p workspace
     * @param opws - name of the o/p workspace
     * @param orientation - orientation of the detector

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

@@ -595,7 +595,7 @@ void SANSRunWindow::trimPyMarkers(QString & txt)
 }
 /** Issues a Python command to load the user file and returns any output if
 *  there are warnings or errors
-*  @param[out] errors the output produced by the string
+*  @param errors[out] the output produced by the string
 *  @return the output printed by the Python commands
 */
 bool SANSRunWindow::loadUserFile()
@@ -1059,8 +1059,7 @@ void SANSRunWindow::componentLOQDistances(Mantid::API::MatrixWorkspace_sptr work
 
 /**
  * Set the state of processing.
- * @param running :: If we are processing then some interaction is disabled
- * @param type :: The reduction type, 0 = 1D and 1 = 2D
+ * @param action :: can be loading, 1D or 2D reduction
  */
 void SANSRunWindow::setProcessingState(const States action)
 {
@@ -1620,7 +1619,7 @@ void SANSRunWindow::forceDataReload(bool force)
 /**
  * Browse for a file and set the text of the given edit box
  * @param box_title :: The title field for the display box
- * @param A :: QLineEdit box to use for the file path
+ * @param file_field :: QLineEdit box to use for the file path
  * @param file_filter :: An optional file filter
  */
 bool SANSRunWindow::browseForFile(const QString & box_title, QLineEdit* file_field, QString file_filter)
@@ -1910,7 +1909,7 @@ QString SANSRunWindow::readSampleObjectGUIChanges()
 }
 /**
  * Run the analysis script
- * @param type :: The data reduction type, 1D or 2D
+ * @param typeStr :: The data reduction type, 1D or 2D
  */
 void SANSRunWindow::handleReduceButtonClick(const QString & typeStr)
 {
@@ -2666,7 +2665,7 @@ void SANSRunWindow::resetDefaultOutput(const QString & wsName)
 /** Passes information about the selected transmission runs to the Python objects
 *  @param trans run widget box with the selected transmission (run with a sample present) file
 *  @param direct run widget box with the selected direct (run with no sample present) file
-*  @para assignFn this is different for can or sample
+*  @param assignFn this is different for can or sample
 */
 bool SANSRunWindow::assignMonitorRun(MantidWidgets::MWRunFiles & trans, MantidWidgets::MWRunFiles & direct, const QString & assignFn)
 {
@@ -2772,7 +2771,7 @@ bool SANSRunWindow::assignDetBankRun(MantidWidgets::MWRunFiles & runFile, const
 }
 /** Gets the detectors that the instrument has and fills the
 *  combination box with these, there must exactly two detectors
-*  @parma output[out] this combination box will be cleared and filled with the new names
+*  @param output[out] this combination box will be cleared and filled with the new names
 *  @throw runtime_error if there aren't exactly two detectors 
 */
 void SANSRunWindow::fillDetectNames(QComboBox *output)
@@ -2798,8 +2797,8 @@ void SANSRunWindow::fillDetectNames(QComboBox *output)
 }
 /** Checks if the workspace is a group and returns the first member of group, throws
 *  if nothing can be retrived
-*  @param[in] workspace the group to examine
-*  @param[in] member entry or period number of the requested workspace, these start at 1
+*  @param workspace[in] the group to examine
+*  @param member[in] entry or period number of the requested workspace, these start at 1
 *  @return the first member of the passed group
 *  @throw NotFoundError if a workspace can't be returned
 */

Code/Mantid/MantidQt/MantidWidgets/src/RenameParDialog.cpp

@@ -6,7 +6,8 @@ using namespace MantidQt::MantidWidgets;
 
 /**
  * Constructor.
- * @params Parameter names to rename
+ * @param old_params Parameter names to rename
+ * @param new_params Renamed parameters
  */
 RenameParDialog::RenameParDialog(
         const std::vector<std::string>& old_params,

Code/Mantid/Vates/VatesAPI/src/IgnoreZerosThresholdRange.cpp

@@ -73,7 +73,7 @@ namespace Mantid
 
     /**
     Determine whether the signal is withing range.
-    @parameter signal value
+    @param signal value
     @return true if the signal is in the range defined by this object.
     */
     bool IgnoreZerosThresholdRange::inRange(const signal_t& signal)
@@ -86,4 +86,4 @@ namespace Mantid
       return signal != 0;
     }
   }
-}
+}

Code/Mantid/Vates/VatesAPI/src/MDEWRebinningPresenter.cpp

@@ -232,6 +232,7 @@ namespace Mantid
     /**
     Mantid properties for rebinning algorithm require formatted information.
     @param basis : basis vector.
+    @param length : length of vector?
     @param dimension : dimension to extract property value for.
     @return true available, false otherwise.
     */

Code/Mantid/Vates/VatesAPI/src/MedianAndBelowThresholdRange.cpp

@@ -97,7 +97,7 @@ namespace Mantid
 
     /**
     Setter for IMDWorkspace.
-    @parameter: workspace : The workspace to extract ranges from.
+    @param workspace : The workspace to extract ranges from.
     */
     void MedianAndBelowThresholdRange::setWorkspace(Mantid::API::Workspace_sptr workspace)
     {
@@ -111,7 +111,7 @@ namespace Mantid
 
     /**
     Determine whether the signal is withing range.
-    @parameter signal value
+    @param signal value
     @return true if the signal is in the range defined by this object.
     */
     bool MedianAndBelowThresholdRange::inRange(const signal_t& signal)

Code/Mantid/Vates/VatesAPI/src/NoThresholdRange.cpp

@@ -73,7 +73,7 @@ namespace Mantid
 
     /**
     Determine whether the signal is withing range.
-    @parameter signal value
+    @param signal value
     @return true if the signal is in the range defined by this object.
     */
     bool NoThresholdRange::inRange(const signal_t& signal)
@@ -83,4 +83,4 @@ namespace Mantid
       return true;
     }
   }
-}
+}

Code/Mantid/Vates/VatesAPI/src/SynchronisingGeometryPresenter.cpp

@@ -94,7 +94,7 @@ namespace Mantid
 
     /**
     Handles dimension realignment. When a dimension presenter is handling a realignment, its is necessary for this to be synchronsied with other non-integrated dimensions.
-    @parameter pDimensionPresenter : dimension presenter on which realignement has been requested.
+    @param pDimensionPresenter : dimension presenter on which realignement has been requested.
     */
     void SynchronisingGeometryPresenter::dimensionRealigned(DimensionPresenter* pDimensionPresenter)
     {
@@ -128,7 +128,7 @@ namespace Mantid
 
     /**
     Ensure that for the collaped mapeed dimension, it's mapped placeholder is erased (marked as empty).
-    @parameter expiredMappedDimension : mapped dimension presenter which has been collapsed, and may currently occupy a x, y, z, t mapping.
+    @param expiredMappedDimension : mapped dimension presenter which has been collapsed, and may currently occupy a x, y, z, t mapping.
     */
     void SynchronisingGeometryPresenter::eraseMappedPresenter(DimPresenter_sptr expiredMappedDimension)
     {
@@ -140,7 +140,7 @@ namespace Mantid
 
     /**
     With the priority mapping of x before y, y before z, and z before t. Ensure that a candidate mapped dimension presenter is set to occupy a vacent mapping.
-    @parameter candidateMappedDimension : Dimension presenter to which a mapping is requested.
+    @param candidateMappedDimension : Dimension presenter to which a mapping is requested.
     */
     void SynchronisingGeometryPresenter::insertMappedPresenter(DimPresenter_sptr candidateMappedDimension)
     {
@@ -168,7 +168,7 @@ namespace Mantid
 
     /**
     Handles the change of a managed dimension presenter to be expanded (from collapsed). 
-    @parameter pDimensionPresenter : dimension which is now expanded.
+    @param pDimensionPresenter : dimension which is now expanded.
     */
     void SynchronisingGeometryPresenter::dimensionExpanded(DimensionPresenter* pDimensionPresenter)
     {
@@ -183,7 +183,7 @@ namespace Mantid
 
     /**
     Handles the change of a managed dimension presenter to be collapsed (from expanded). 
-    @parameter pDimensionPresenter : dimension which is now collapsed.
+    @param pDimensionPresenter : dimension which is now collapsed.
     */
     void SynchronisingGeometryPresenter::dimensionCollapsed(DimensionPresenter* pDimensionPresenter)
     { 
@@ -203,7 +203,7 @@ namespace Mantid
 
     /**
     Handles dimension resize request. Can either be collapsed or expanded. This is worked out internally.
-    @parameter pDimensionPresenter : dimension which is now collapsed/expanded.
+    @param pDimensionPresenter : dimension which is now collapsed/expanded.
     */
     void SynchronisingGeometryPresenter::dimensionResized(DimensionPresenter* pDimensionPresenter)
     {
@@ -316,7 +316,7 @@ namespace Mantid
     ii) Creates a DimensionPresenter for each of those views and binds the pair together. (although DimensionPresenters are owned by this and DimensionViews are owned by GeometryViews)
     iv) Replicates the mappings on the original source input. These are read/writable at a later point.
 
-    @parameter view : the GeoemtryView to direct.
+    @param view : the GeoemtryView to direct.
     */
     void SynchronisingGeometryPresenter::acceptView(GeometryView* view)
     {
@@ -412,7 +412,7 @@ namespace Mantid
 
     /**
     Determine if dimension presenter is mapped to x axis.
-    @parameter pDimensionPresenter : The dimension presenter to which the comparison should be made.
+    @param pDimensionPresenter : The dimension presenter to which the comparison should be made.
     @return true if dimesion presenter matches exising mapping.
     */
     bool SynchronisingGeometryPresenter::isXDimensionPresenter(DimPresenter_sptr dimensionPresenter) const
@@ -422,7 +422,7 @@ namespace Mantid
 
     /**
     Determine if dimension presenter is mapped to y axis.
-    @parameter pDimensionPresenter : The dimension presenter to which the comparison should be made.
+    @param pDimensionPresenter : The dimension presenter to which the comparison should be made.
     @return true if dimesion presenter matches exising mapping.
     */
     bool SynchronisingGeometryPresenter::isYDimensionPresenter(DimPresenter_sptr dimensionPresenter) const
@@ -432,7 +432,7 @@ namespace Mantid
 
     /**
     Determine if dimension presenter is mapped to z axis.
-    @parameter pDimensionPresenter : The dimension presenter to which the comparison should be made.
+    @param pDimensionPresenter : The dimension presenter to which the comparison should be made.
     @return true if dimesion presenter matches exising mapping.
     */
     bool SynchronisingGeometryPresenter::isZDimensionPresenter(DimPresenter_sptr dimensionPresenter) const
@@ -442,7 +442,7 @@ namespace Mantid
 
     /**
     Determine if dimension presenter is mapped to t axis.
-    @parameter pDimensionPresenter : The dimension presenter to which the comparison should be made.
+    @param pDimensionPresenter : The dimension presenter to which the comparison should be made.
     @return true if dimesion presenter matches exising mapping.
     */
     bool SynchronisingGeometryPresenter::isTDimensionPresenter(DimPresenter_sptr dimensionPresenter) const

Code/Mantid/Vates/VatesAPI/src/UserDefinedThresholdRange.cpp

@@ -72,12 +72,12 @@ namespace Mantid
 
     /**
     Determine whether the signal is withing range.
-    @parameter signal value
+    @param signal value
     @return true if the signal is in the range defined by this object.
     */
     bool UserDefinedThresholdRange::inRange(const signal_t& signal)
     {
       return signal >= m_min && signal <= m_max;
     }
   }
-}
+}

Code/Mantid/Vates/VatesAPI/src/vtkDataSetToWsLocation.cpp

@@ -13,7 +13,7 @@ namespace Mantid
   {
     /**
     Static creational method to run functionality in one method call.
-    @param dataSet : input dataset containing field data.
+    @param dataset : input dataset containing field data.
     @return location string.
     */
     std::string vtkDataSetToWsLocation::exec(vtkDataSet* dataset)
@@ -61,4 +61,4 @@ namespace Mantid
     }
 
   }
-}
+}

Code/Mantid/Vates/VatesAPI/src/vtkDataSetToWsName.cpp

@@ -13,7 +13,7 @@ namespace Mantid
   {
     /**
     Static creational method to run functionality in one method call.
-    @param dataSet : input dataset containing field data.
+    @param dataset : input dataset containing field data.
     @return extracted workspace name.
     */
     std::string vtkDataSetToWsName::exec(vtkDataSet* dataset)
@@ -60,4 +60,4 @@ namespace Mantid
     {
     }
   }
-}
+}

Code/Mantid/Vates/VatesAPI/src/vtkThresholdingHexahedronFactory.cpp

@@ -94,6 +94,7 @@ namespace VATES
    *
    * @param timestep :: index of the time step (4th dimension) in the workspace.
    *        Set to 0 for a 3D workspace.
+   * @param do4D :: if true, create a 4D dataset, else to 3D
    * @return the vtkDataSet created
    */
   vtkDataSet* vtkThresholdingHexahedronFactory::create3Dor4D(size_t timestep, bool do4D) const

Code/Mantid/Vates/VatesSimpleGui/QtWidgets/inc/MantidVatesSimpleGuiQtWidgets/AxisInteractor.h

@@ -140,6 +140,7 @@ class EXPORT_OPT_MANTIDVATES_SIMPLEGUI_QTWIDGETS AxisInteractor : public QWidget
    */
   /// Set the flag for showing the SliceViewer
   void setShowSliceView(double state);
+  /// Update the indicator to the value requested
   void updateIndicator(double value);
   /// Update the requested indicator to the given position.
   void updateRequestedIndicator(const QString &name, double value);

Code/Mantid/Vates/VatesSimpleGui/QtWidgets/inc/MantidVatesSimpleGuiQtWidgets/ScalePicker.h

@@ -106,6 +106,7 @@ public slots:
    * position.
    * @param scale the associated QwtScaleWidget
    * @param pos the x,y coordinates of the mouse click event
+   * @param createIndicator if true, create an indicator, else do nothing
    */
   void mouseClicked(const QwtScaleWidget *scale, const QPoint &pos,
                     bool createIndicator = true);

Code/Mantid/Vates/VatesSimpleGui/QtWidgets/src/AxisInteractor.cpp

@@ -252,6 +252,11 @@ void AxisInteractor::clearSelections()
   }
 }
 
+/**
+ * This function uses the requested axis coordinate to find the graphical
+ * point on the axis scale. The indicator is then updated to that point.
+ * @param value the axis coordinate to update the indicator to
+ */
 void AxisInteractor::updateIndicator(double value)
 {
   QPoint *pos = this->scalePicker->getLocation(value);