Refs #3867. Fixing doxygen warnings.

Code/Mantid/Framework/API/inc/MantidAPI/IFunction.h

@@ -243,7 +243,7 @@ class MANTID_API_DLL IFunction
   virtual const std::string category() const { return "General";}
 
   /// Function you want to fit to. 
-  /// @param out :: The buffer for writing the calculated values. Must be big enough to accept dataSize() values
+  /// @param domain :: The buffer for writing the calculated values. Must be big enough to accept dataSize() values
   virtual void function(FunctionDomain& domain)const = 0;
   /// Derivatives of function with respect to active parameters
   virtual void functionDeriv(FunctionDomain& domain, Jacobian& jacobian);

Code/Mantid/Framework/API/src/IFitFunction.cpp

@@ -31,11 +31,6 @@ void IFitFunction::functionDeriv(Jacobian* out)
   throw ("No derivative IFitFunction provided");
 }
 
-
-
-///** Update active parameters. Ties are applied.
-// *  @param in :: Pointer to an array with active parameters values. Must be at least nActive() doubles long.
-// */
 //void IFitFunction::updateActive(const double* in)
 //{
 //  if (in)
@@ -46,11 +41,6 @@ void IFitFunction::functionDeriv(Jacobian* out)
 //  applyTies();
 //}
 //
-///**
-// * Sets active parameter i to value. Ties are not applied.
-// * @param i :: The index of active parameter to set
-// * @param value :: The new value for the parameter
-// */
 //void IFitFunction::setActiveParameter(size_t i,double value)
 //{
 //  size_t j = indexOfActive(i);
@@ -62,22 +52,11 @@ void IFitFunction::functionDeriv(Jacobian* out)
 //  size_t j = indexOfActive(i);
 //  return getParameter(j);
 //}
-
-///** Create a new tie. IFitFunctions can have their own types of ties.
-// * @param parName :: The parameter name for this tie
-// * @return a new parameter tie
-// */
 //ParameterTie* IFitFunction::createTie(const std::string& parName)
 //{
 //  return new ParameterTie(this,parName);
 //}
 //
-///**
-// * Ties a parameter to other parameters
-// * @param parName :: The name of the parameter to tie.
-// * @param expr ::    A math expression 
-// * @return newly ties parameters
-// */
 //ParameterTie* IFitFunction::tie(const std::string& parName,const std::string& expr)
 //{
 //  ParameterTie* tie = this->createTie(parName);
@@ -94,10 +73,6 @@ void IFitFunction::functionDeriv(Jacobian* out)
 //  return tie;
 //}
 //
-///** Removes the tie off a parameter. The parameter becomes active
-// * This method can be used when constructing and editing the IFitFunction in a GUI
-// * @param parName :: The name of the parameter which ties will be removed.
-// */
 //void IFitFunction::removeTie(const std::string& parName)
 //{
 //  size_t i = parameterIndex(parName);
@@ -168,87 +143,6 @@ void IFitFunction::addPenaltyDeriv(Jacobian *out)const
 
 }
 
-///**
-// * Writes a string that can be used in Fit.IFitFunction to create a copy of this IFitFunction
-// * @return string representation of the function
-// */
-//std::string IFitFunction::asString()const
-//{
-//  std::ostringstream ostr;
-//  ostr << "name="<<this->name();
-//  std::vector<std::string> attr = this->getAttributeNames();
-//  for(size_t i=0;i<attr.size();i++)
-//  {
-//    std::string attName = attr[i];
-//    std::string attValue = this->getAttribute(attr[i]).value();
-//    if (!attValue.empty())
-//    {
-//      ostr<<','<<attName<<'='<<attValue;
-//    }
-//  }
-//  for(size_t i=0;i<nParams();i++)
-//  {
-//    ostr<<','<<parameterName(i)<<'='<<getParameter(i);
-//  }
-//  std::string constraints;
-//  for(size_t i=0;i<nParams();i++)
-//  {
-//    const IConstraint* c = getConstraint(i);
-//    if (c)
-//    {
-//      std::string tmp = c->asString();
-//      if (!tmp.empty())
-//      {
-//        if (!constraints.empty())
-//        {
-//          constraints += ",";
-//        }
-//        constraints += tmp;
-//      }
-//    }
-//  }
-//  if (!constraints.empty())
-//  {
-//    ostr << ",constraints=(" << constraints << ")";
-//  }
-//
-//  std::string ties;
-//  for(size_t i=0;i<nParams();i++)
-//  {
-//    const ParameterTie* tie = getTie(i);
-//    if (tie)
-//    {
-//      std::string tmp = tie->asString(this);
-//      if (!tmp.empty())
-//      {
-//        if (!ties.empty())
-//        {
-//          ties += ",";
-//        }
-//        ties += tmp;
-//      }
-//    }
-//  }
-//  if (!ties.empty())
-//  {
-//    ostr << ",ties=(" << ties << ")";
-//  }
-//  return ostr.str();
-//}
-//
-///** Set a function handler
-// * @param handler :: A new handler
-// */
-//void IFitFunction::setHandler(FitFunctionHandler* handler)
-//{
-//  m_handler = handler;
-//  if (handler && handler->function() != this)
-//  {
-//    throw std::runtime_error("Function handler points to a different function");
-//  }
-//  m_handler->init();
-//}
-//
 /**
  * Operator \<\<
  * @param ostr :: The output stream

Code/Mantid/Framework/API/src/IFunctionMD.cpp

@@ -30,8 +30,9 @@ namespace API
   Kernel::Logger& IFunctionMD::g_log = Kernel::Logger::get("IFunctionMD");
 
   /** Set the workspace
-    * @param ws :: A shared pointer to a workspace.
-  */
+   * @param ws :: A shared pointer to a workspace.
+   * @param copyData :: If true, copy the data to WS
+   */
   void IFunctionMD::setWorkspace(boost::shared_ptr<const Workspace> ws,bool copyData)
   {
     try

Code/Mantid/Framework/API/src/IFunctionMW.cpp

@@ -185,8 +185,8 @@ void IFunctionMW::functionDerivMW(Jacobian* out, const double* xValues, const si
 /** Initialize the function providing it the workspace
  * @param workspace :: The workspace to set
  * @param wi :: The workspace index
- * @param xMin :: The lower bin index
- * @param xMax :: The upper bin index
+ * @param startX :: The lower bin index
+ * @param endX :: The upper bin index
  */
 void IFunctionMW::setMatrixWorkspace(boost::shared_ptr<const API::MatrixWorkspace> workspace,size_t wi,double startX, double endX)
 {

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/FindDetectorsPar.h

@@ -5,7 +5,8 @@
 //----------------------------------------------------------------------
 #include "MantidAPI/Algorithm.h"
 #include <fstream>
-/** An algorithm to calculate the angular coordinates of the workspace's detectors, as they can be viewed from a sample (par or phx data)
+/**
+    An algorithm to calculate the angular coordinates of the workspace's detectors, as they can be viewed from a sample (par or phx data)
 
     Properties:
     <UL>
@@ -24,11 +25,9 @@
     <UL><LI> azimuthal_width       - A column  containing the detectors azimuthal angular width</LI></UL>
     <UL><LI> polar_width           - A column  containing the detectors polar angular width</LI></UL>
 
-  When OutputTable workspace name is empty, the tabled workspace is not defined. To get access to the resulting arrays, 
-  the algorithm user has to deploy accessors (getAzimuthal(), getPolar() etc.), defined below, which allows avoiding the
-  transformation of these arrays into strings. 
-
-
+    When OutputTable workspace name is empty, the tabled workspace is not defined. To get access to the resulting arrays,
+    the algorithm user has to deploy accessors (getAzimuthal(), getPolar() etc.), defined below, which allows avoiding the
+    transformation of these arrays into strings.
 
     @author Alex Buts ISIS; initially extracted from Stuart Campbell's SaveNXSPE algorithm,
     @date 17/05/2012
@@ -69,12 +68,12 @@ namespace DataHandling
 *     par(5,ndet)         contents of array
 *
 *         1st column      sample-detector distance
-*         2nd  "          scattering angle (deg)
-*         3rd  "          azimuthal angle (deg)
+*         2nd  &quot;          scattering angle (deg)
+*         3rd  &quot;          azimuthal angle (deg)
 *                     (west bank = 0 deg, north bank = -90 deg etc.)
 *                     (Note the reversed sign convention cf .phx files)
-*         4th  "          width (m)
-*         5th  "          height (m)
+*         4th  &quot;          width (m)
+*         5th  &quot;          height (m)
 *-----------------------------------------------------------------------
 *2) load an ASCII phx file
 *
@@ -84,10 +83,10 @@ namespace DataHandling
 *     Recall that only the 3,4,5,6 columns in the file (rows in the
 *     output of this routine) contain useful information
 *         3rd column      scattering angle (deg)
-*         4th  "          azimuthal angle (deg)
+*         4th  &quot;          azimuthal angle (deg)
 *                     (west bank = 0 deg, north bank = 90 deg etc.)
-*         5th  "          angular width (deg)
-*         6th  "          angular height (deg)
+*         5th  &quot;          angular width (deg)
+*         6th  &quot;          angular height (deg)
 *-----------------------------------------------------------------------
 */
 enum fileTypes{

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/SavePAR.h

@@ -45,14 +45,14 @@ namespace DataHandling
 *
 *     par(6,ndet)         contents of array
 *
-*         1st column      sample-detector distance
-*         2nd  "          scattering angle (deg)
-*         3rd  "          azimuthal angle (deg)
+*         1st column      sample-detector distance \n
+*         2nd  "          scattering angle (deg) \n
+*         3rd  "          azimuthal angle (deg) \n
 *                     (west bank = 0 deg, north bank = -90 deg etc.)
-*                     (Note the reversed sign convention cf .phx files)
-*         4th  "          width (m)
-*         5th  "          height (m)
-*         6th  "          DetID (m)
+*                     (Note the reversed sign convention cf .phx files) \n
+*         4th  "          width (m) \n
+*         5th  "          height (m) \n
+*         6th  "          DetID (m) \n
 *-----------------------------------------------------------------------
 */
 class DLLExport SavePAR : public Mantid::API::Algorithm

Code/Mantid/Framework/DataHandling/src/LoadRKH.cpp

@@ -446,7 +446,6 @@ void LoadRKH::binCenter(const MantidVec oldBoundaries, MantidVec & toCenter) con
   VectorHelper::convertToBinCentre(oldBoundaries, toCenter);
 }
 /**This method does a quick file check by checking the no.of bytes read nread params and header buffer
- *  @param filePath- path of the file including name.
  *  @param nread :: no.of bytes read
  *  @param header :: The first 100 bytes of the file as a union
  *  @return true if the given file is of type which can be loaded by this algorithm

Code/Mantid/Framework/DataHandling/src/SaveGSS.cpp

@@ -303,6 +303,7 @@ namespace Mantid
 
     /**
      * Write the header information for the given workspace
+     * @param format :: The string containing the header formatting
      * @param os :: The stream to use to write the information
      * @param workspace :: A shared pointer to MatrixWorkspace
      * @param primaryflightpath :: Value for the moderator to sample distance

Code/Mantid/Framework/DataObjects/src/EventWorkspace.cpp

@@ -525,10 +525,6 @@ namespace DataObjects
    * This requires that a non-empty spectra-detector map
    * Can do it in parallel, though my time tests show it takes MORE time in parallel :(
    * This calls doneAddingEventLists() to finalize after the end.
-   *
-   * @param parallel: set to true to perform this padding in parallel, which
-   *        may increase speed, though my tests show it slows it down.
-   *
    */
   void EventWorkspace::padSpectra()
   {

Code/Mantid/Framework/DataObjects/src/MementoTableWorkspace.cpp

@@ -13,9 +13,8 @@ namespace Mantid
 
     /**
     Determines whether the provided column has the same name and type as expected.
-    @param expectedName : expected column name
-    @param expectedType : expected column type
-    @param col : ref to column to check
+    @param expected : expected column name
+    @param candidate : ref to column to check
     @return true if all expectations are met.
     */
     bool MementoTableWorkspace::expectedColumn(Mantid::API::Column_const_sptr expected, Mantid::API::Column_const_sptr candidate)
@@ -85,4 +84,4 @@ namespace Mantid
 
 
   }
-}
+}

Code/Mantid/Framework/DataObjects/src/PeakColumn.cpp

@@ -13,6 +13,7 @@ namespace DataObjects
   //----------------------------------------------------------------------------------------------
   /** Constructor
    * @param peaks :: vector of peaks
+   * @param name :: name for the column
    */
   PeakColumn::PeakColumn(std::vector<Peak> & peaks, std::string name) :
       peaks(peaks)

Code/Mantid/MantidQt/API/inc/MantidQtAPI/AlgorithmDialog.h

@@ -248,13 +248,13 @@ protected slots:
      @param pProp -- the pointer to the property
      @param row   -- the vertical position of the property widget within the initated dialog box
      Should be pure virtual but as current custom vidgets do not use it, made empty unless overloaded */
-    virtual void createSpecificPropertyWidget(Mantid::Kernel::Property *, int ){};
+  virtual void createSpecificPropertyWidget(Mantid::Kernel::Property *pProp, int row){UNUSED_ARG(pProp); UNUSED_ARG(row);};
  /** The function deletes widgets, associated with property;
      It used in dynamic propeties, which change as property contents, validators or settings change
      @param pProp -- the pointer to the property
      @return-- the vertical position of the composite widget within the widget window;
      Should be pure virtual but as current custom vidgets do not use it, made empty unless overloaded */
-    virtual int deletePropertyWidgets(Mantid::Kernel::Property *){return -1;}
+    virtual int deletePropertyWidgets(Mantid::Kernel::Property *pProp){UNUSED_ARG(pProp); return -1;}
 
   /** @name Member variables. */
   //@{