Refs #8632. Fixing MantidPlot and MantidQt doxygen errors.

Code/Mantid/MantidPlot/src/Mantid/InstrumentWidget/InstrumentActor.cpp

@@ -156,6 +156,7 @@ InstrumentActor::~InstrumentActor()
  * When selecting a component in the InstrumentTreeWidget
  *
  * @param visitor
+ * @param rule
  * @return
  */
 bool InstrumentActor::accept(GLActorVisitor& visitor, VisitorAcceptRule rule)

Code/Mantid/MantidPlot/src/Mantid/InstrumentWidget/InstrumentWindowRenderTab.cpp

@@ -573,7 +573,7 @@ void InstrumentWindowRenderTab::setSurfaceType(int index)
 
 /**
   * Respond to surface change from script.
-  * @param typeIndex :: Index selected in the surface type combo box.
+  * @param index :: Index selected in the surface type combo box.
   */
 void InstrumentWindowRenderTab::surfaceTypeChanged(int index)
 {

Code/Mantid/MantidPlot/src/Mantid/InstrumentWidget/PanelsSurface.cpp

@@ -278,7 +278,7 @@ void PanelsSurface::addFlatBank(ComponentID bankId, const Mantid::Kernel::V3D &n
   * Add a flat bank from an assembly of detectors.
   * @param bankId :: Component ID of the bank.
   * @param normal :: Normal vector to the bank's plane.
-  * @param objCompAssemblies :: List of component IDs. Each component must cast to Detector.
+  * @param detectors :: List of component IDs. Each component must cast to Detector.
   */
 void PanelsSurface::addFlatBankOfDetectors(ComponentID bankId, const Mantid::Kernel::V3D &normal, QList<ComponentID> detectors)
 {

Code/Mantid/MantidPlot/src/Mantid/InstrumentWidget/ProjectionSurface.cpp

@@ -26,8 +26,6 @@ using Mantid::Kernel::V3D;
 /**
   * The constructor.
   * @param rootActor :: The instrument actor containning all info about the instrument
-  * @param origin :: Defines the origin of the projection reference system (if applicable)
-  * @param axis :: 
   */
 ProjectionSurface::ProjectionSurface(const InstrumentActor* rootActor):
     m_instrActor(rootActor),

Code/Mantid/MantidPlot/src/Mantid/InstrumentWidget/RectangularDetectorActor.cpp

@@ -131,6 +131,7 @@ void RectangularDetectorActor::draw(bool picking)const
  * detector, and sets the visibility of the whole panel to true if so.
  *
  * @param visitor :: A visitor.
+ * @param rule :: A rule.
  *
  */
 bool RectangularDetectorActor::accept(GLActorVisitor& visitor, VisitorAcceptRule)

Code/Mantid/MantidPlot/src/Mantid/InstrumentWidget/UnwrappedSurface.cpp

@@ -730,8 +730,6 @@ void UnwrappedSurface::calcUV(UnwrappedDetector& udet, Mantid::Kernel::V3D & pos
 /** Calculate the size of the detector in U/V
  *
  * @param udet
- * @param X
- * @param Y
  */
 void UnwrappedSurface::calcSize(UnwrappedDetector& udet)
 {

Code/Mantid/MantidPlot/src/Mantid/MantidDock.cpp

@@ -408,7 +408,7 @@ void MantidDockWidget::setTreeUpdating(const bool state)
 /**
  * Clears the tree and re-populates it with the given top level items
  * @param topLevelItems The map of names to workspaces
- * @param expandedItems Names of items who should expanded after being populated
+ * @param expanded Names of items who should expanded after being populated
  */
 void MantidDockWidget::populateTopLevel(const std::map<std::string,Mantid::API::Workspace_sptr> & topLevelItems,
                                         const QStringList & expanded)

Code/Mantid/MantidPlot/src/Mantid/MantidUI.cpp

@@ -2365,7 +2365,7 @@ void MantidUI::importString(const QString &logName, const QString &data)
 *  @param logName :: the title of the table is based on this
 *  @param data :: the string to display
 *  @param sep :: the seperator character
-*  @param caption :: the caption to appear on the table window title bar, defualts to logname if left blank
+*  @param wsName :: the caption to appear on the table window title bar, defaults to logname if left blank
 */
 void MantidUI::importString(const QString &logName, const QString &data, const QString &sep, const QString &wsName)
 {
@@ -2400,7 +2400,7 @@ void MantidUI::importString(const QString &logName, const QString &data, const Q
 /** Displays a string in a Qtiplot table
 *  @param logName :: the title of the table is based on this
 *  @param data :: a formated string with the time series data to display
-*  @param caption :: the caption to appear on the table window title bar, defualts to logname if left blank
+*  @param wsName :: the caption to appear on the table window title bar, defualts to logname if left blank
 */
 void MantidUI::importStrSeriesLog(const QString &logName, const QString &data, const QString &wsName)
 {
@@ -2451,7 +2451,6 @@ void MantidUI::importStrSeriesLog(const QString &logName, const QString &data, c
 * - 1 filter by running status
 * - 2 filter by period
 * - 3 filter by status & period
-* @param caption :: the caption to appear on the table window title bar, defualts to logname if left blank
 */
 void MantidUI::importNumSeriesLog(const QString &wsName, const QString &logName, int filter)
 {
@@ -3003,7 +3002,7 @@ void MantidUI::setUpBinGraph(MultiLayer* ml, const QString& Name, Mantid::API::M
 
 /**
 Plots the spectra from the given workspaces
-@param ws_name :: List of ws names to plot
+@param ws_names :: List of ws names to plot
 @param spec_list :: List of spectra indices to plot for each workspace
 @param errs :: If true include the errors on the graph
 @param style :: Curve style for plot

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

@@ -27,7 +27,7 @@ const string WIKI_BASE_URL("http://mantidproject.org/");
 const string WIKI_DEFAULT_URL(WIKI_BASE_URL + "MantidPlot");
 
 /**
- * Default constructor shows the \link MantidQt::API::DEFAULT_URL.
+ * Default constructor shows the @link MantidQt::API::DEFAULT_URL @endlink.
  */
 HelpWindowImpl::HelpWindowImpl() :
     m_collectionFile(""),
@@ -69,7 +69,7 @@ void HelpWindowImpl::openWebpage(const string &url)
  * Have the help window show a specific url. If the url doesn't exist
  * this just pops up the default view for the help.
  *
- * \param url The url to open. This should start with \link MantidQt::API::BASE_URL.
+ * @param url The url to open. This should start with @link MantidQt::API::BASE_URL @endlink.
  * If it is empty show the default page.
  */
 void HelpWindowImpl::showURL(const string &url)
@@ -139,7 +139,7 @@ void HelpWindowImpl::showAlgorithm(const string &name, const int version)
 }
 
 /**
- * Convenience method for \link HelpWindowImpl::showAlgorithm(string, int).
+ * Convenience method for @link HelpWindowImpl::showAlgorithm(const string &, const int) @endlink.
  *
  * @param name The name of the algorithm to show. If this is empty show
  * the algorithm index.

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

@@ -46,7 +46,7 @@ UserSubWindow * UserSubWindowFactoryImpl::createUnwrapped(const std::string & na
 /**
  * Return the set of categories that the interface with the given name belongs to.
  *
- * @param name :: The name of the interface.
+ * @param interfaceName :: The name of the interface.
  * @returns the set of category names if an interface with the given name has been registered,
  *          else an empty set.
  */

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

@@ -353,7 +353,7 @@ namespace IDA
    *          +-- Lorentzian 1 (yes/no)
    *          +-- Lorentzian 2 (yes/no)
    *
-   * @param tie :: whether to tie centres of the two lorentzians.
+   * @param tieCentres :: whether to tie centres of the two lorentzians.
    *
    * @returns the composite fitting function.
    */

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

@@ -136,7 +136,7 @@ namespace IDA
    * @param plot      :: the QwtPlot object
    * @param curve     :: the QwtPlotCurve object
    * @param workspace :: A pointer to the workspace to use
-   * @param wsIndex   :: the workspace index
+   * @param index   :: the workspace index
    *
    * @returns the resulting QwtPlotCurve object
    */

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

@@ -78,7 +78,7 @@ namespace MantidQt
      * a specturm index.
      * 
      * @param workspace :: Pointer to the workspace
-     * @param index :: The spectrum index of the workspace
+     * @param wsIndex :: The spectrum index of the workspace
      */
     void IndirectBayesTab::plotMiniPlot(const Mantid::API::MatrixWorkspace_const_sptr & workspace, size_t wsIndex)
     {
@@ -131,7 +131,7 @@ namespace MantidQt
      * Checks the workspace's intrument for a resolution parameter to use as 
      * a default for the energy range on the mini plot
      *
-     * @param workspace :: Pointer to the workspace to use
+     * @param ws :: Pointer to the workspace to use
      * @param res :: The retrieved values for the resolution parameter (if one was found)
      */
     bool IndirectBayesTab::getInstrumentResolution(Mantid::API::MatrixWorkspace_const_sptr ws, std::pair<double,double>& res)
@@ -158,7 +158,7 @@ namespace MantidQt
     /**
      * Gets the range of the curve plotted in the mini plot
      *
-     * @param A pair containing the maximum and minimum points of the curve
+     * @return A pair containing the maximum and minimum points of the curve
      */
     std::pair<double,double> IndirectBayesTab::getCurveRange()
     {
@@ -245,7 +245,7 @@ namespace MantidQt
      * Checks if a file is present in the ADS and if not attempts to load it.
      * 
      * @param filename :: name of the file that should be loaded
-     * @param errorMsg :: error message to display if the file couldn't be found.
+     * @param filepath :: path to the file
      */
     bool IndirectBayesTab::checkFileLoaded(const QString& filename, const QString& filepath)
     {

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

@@ -237,7 +237,7 @@ namespace MantidQt
 		 * Set the instrument selected in the combobox based on
 		 * the file name of the run is possible.
 		 *
-		 * Assumes that names have the form <instrument>_<run-number>.<ext>
+     * Assumes that names have the form \<instrument\>_\<run-number\>.\<ext\>
 		 */
     void IndirectNeutron::handleFilesFound()
     {

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

@@ -99,7 +99,7 @@ namespace MantidQt
 		 * Set the data selectors to use the default save directory
 		 * when browsing for input files.
 		 *  
-		 * @param filename :: The name of the workspace to plot
+     * @param settings :: current settings
 		 */
 		void JumpFit::loadSettings(const QSettings& settings)
 		{

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

@@ -138,12 +138,15 @@ bool MantidEVWorker::isEventWorkspace( const std::string & event_ws_name )
  *  @param file_name        Name of the NeXus file to load
  *  @param ev_ws_name       Name of the event workspace to create
  *  @param md_ws_name       Name of the MD workspace to create
+ *  @param minQ             The smallest absolute value of any component
+ *                          of Q to include. When ConvertToMD is called,
  *  @param maxQ             The largest absolute value of any component
  *                          of Q to include. When ConvertToMD is called,
  *                          MinValues = -maxQ,-maxQ,-maxQ   and 
  *                          MaxValues =  maxQ, maxQ, maxQ 
  *  @param do_lorentz_corr  Set true to do the Lorentz correction when
  *                          converting to reciprocal space. 
+ *  @param load_data        Set true to load data.
  *  @param load_det_cal     Set true to call LoadIsawDetCal after loading
  *                          the event file.
  *  @param det_cal_file     Fully qualified name of the .DetCal file.
@@ -377,6 +380,7 @@ bool MantidEVWorker::findUBUsingFFT( const std::string & peaks_ws_name,
  *  peaks workspace.
  * 
  *  @param peaks_ws_name   The name of the peaks workspace.
+ *  @param tolerance       Tolerance for the peak finding.
  *
  *  @return true if FindUBusingIndexedPeaks completed successfully.
  */
@@ -661,6 +665,11 @@ bool MantidEVWorker::changeHKL(  const std::string & peaks_ws_name,
  *                         region.
  *  @param integrate_edge  If true, integrate peaks for which the sphere
  *                         goes off the edge of the detector.
+ *  @param use_cylinder_integration  Set true to use cylinder integration
+ *  @param cylinder_length Set the cylinder length
+ *  @param cylinder_percent_bkg      Percentage background to use in the
+ *                                   cylinder
+ *  @param cylinder_profile_fit      String to some use.
  *
  *  @return true if the unweighted workspace was successfully created and
  *          integrated using IntegratePeaksMD.

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

@@ -2049,7 +2049,7 @@ void MuonAnalysis::updateFrontAndCombo()
 
 /**
  * Updates widgets related to period algebra
- * @param newNumPeriods Number of periods available
+ * @param numPeriods Number of periods available
  */
 void MuonAnalysis::updatePeriodWidgets(int numPeriods)
 {
@@ -2177,6 +2177,7 @@ QStringList MuonAnalysis::getPeriodLabels() const
  * plots specific WS spectrum (used by plotPair and plotGroup)
  * @param wsName workspace name
  * @param wsIndex workspace index
+ * @param ylogscale use log scaling on y
  */
 void MuonAnalysis::plotSpectrum(const QString& wsName, const int wsIndex, const bool ylogscale)
 {
@@ -3172,7 +3173,7 @@ void MuonAnalysis::getFullCode(int originalSize, QString & run)
 /**
  * Is called every time when tab gets changed
  *
- * @param tabNumber The index value of the current tab
+ * @param newTabNumber The index value of the current tab
  */
 void MuonAnalysis::changeTab(int newTabNumber)
 {

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

@@ -496,8 +496,6 @@ void MuonAnalysisOptionTab::storeCustomTimeValue()
  *   - ShowErrors: True of False
  *   - YAxisAuto: True or False
  *   - YAxisMin/YAxisMax: Double values
- *
- * @param workspace :: The workspace name of the plot to be created.
  */
 QMap<QString, QString> MuonAnalysisOptionTab::parsePlotStyleParams() const
 {

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

@@ -48,7 +48,7 @@ namespace MantidQt
 		 * Set the data selectors to use the default save directory
 		 * when browsing for input files.
 		 *  
-		 * @param filename :: The name of the workspace to plot
+     * @param settings :: current settings
 		 */
 		void Quasi::loadSettings(const QSettings& settings)
 		{

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

@@ -94,7 +94,7 @@ namespace MantidQt
 		 * Set the data selectors to use the default save directory
 		 * when browsing for input files.
 		 *  
-		 * @param filename :: The name of the workspace to plot
+     * @param settings :: The current settings
 		 */
 		void ResNorm::loadSettings(const QSettings& settings)
 		{

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

@@ -121,7 +121,7 @@ namespace MantidQt
 		 * Set the data selectors to use the default save directory
 		 * when browsing for input files.
 		 *  
-		 * @param filename :: The name of the workspace to plot
+     * @param settings :: The current settings
 		 */
 		void Stretch::loadSettings(const QSettings& settings)
 		{

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

@@ -2253,6 +2253,7 @@ void FitPropertyBrowser::clearAllPlots()
 
 /** Create a double property and set some settings
  * @param name :: The name of the new property
+ * @param manager :: The property manager
  * @return Pointer to the created property
  */
 QtProperty* FitPropertyBrowser::addDoubleProperty(const QString& name, QtDoublePropertyManager *manager)const

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

@@ -1264,6 +1264,7 @@ void FunctionBrowser::addFunction()
 /**
  * Return the function 
  * @param prop :: Function property 
+ * @param attributesOnly :: Get only attributes
  */
 Mantid::API::IFunction_sptr FunctionBrowser::getFunction(QtProperty* prop, bool attributesOnly)
 {

Code/Mantid/MantidQt/SliceViewer/src/LineViewer.cpp

@@ -947,8 +947,8 @@ int LineViewer::getPlotAxis() const
 
 /**
  * Helper method to get the positive min value.
- * @param curveDat : CurveData to look through the data of.
- * @param to : Start value
+ * @param curveData : CurveData to look through the data of.
+ * @param from : Start value
  * @return : Positive min value.
  */
 double getPositiveMin(const MantidQwtWorkspaceData& curveData, const double from)

Code/Mantid/MantidQt/SliceViewer/src/PeaksWorkspaceWidget.cpp

@@ -167,7 +167,6 @@ namespace MantidQt
 
     /**
     Handler to hide/show the widget on request.
-    @param hidden: flag indicating what to do.
     */
     void PeaksWorkspaceWidget::onToggleHideInPlot()
     {

Code/Mantid/MantidQt/SpectrumViewer/src/SpectrumView.cpp

@@ -25,7 +25,7 @@ namespace SpectrumView
  *  parts of the SpectrumView are constructed here and are deleted when the
  *  SpectrumView destructor is called.
  *
- *  @param data_source  The source of the data that will be displayed. 
+ *  @param parent :: The parent widget.
  */
 SpectrumView::SpectrumView(QWidget *parent) :
   QMainWindow(parent, 0),