Refs #3867. Fixing doxygen warnings.

Code/Mantid/Framework/Geometry/inc/MantidGeometry/Instrument/InstrumentDefinitionParser.h

@@ -138,9 +138,9 @@ namespace Geometry
     /// If appropriate, creates a second instrument containing neutronic detector positions
     void createNeutronicInstrument();
 
-    /// Takes as input a <type> element containing a <combine-components-into-one-shape>, and
-    /// adjust the <type> element by replacing its containing <component> elements with <cuboid>'s
-    /// (note for now this will only work for <cuboid>'s and when necessary this can be extended).
+    /// Takes as input a \<type\> element containing a <combine-components-into-one-shape>, and
+    /// adjust the \<type\> element by replacing its containing \<component\> elements with \<cuboid\>'s
+    /// (note for now this will only work for \<cuboid\>'s and when necessary this can be extended).
     void adjust(Poco::XML::Element* pElem, std::map<std::string,bool>& isTypeAssembly,
                 std::map<std::string,Poco::XML::Element*>& getTypeElement);
 
@@ -155,7 +155,7 @@ namespace Geometry
       Poco::XML::Element* pLocElem, std::map<std::string,Poco::XML::Element*>& getTypeElement,
       Geometry::ICompAssembly*& endAssembly);
 
-    /// Returns a translated and rotated <cuboid> element
+    /// Returns a translated and rotated \<cuboid\> element
     std::string translateRotateXMLcuboid(Geometry::ICompAssembly* comp, Poco::XML::Element* cuboidEle,
                                   std::string& cuboidName);
 

Code/Mantid/Framework/Geometry/src/Instrument.cpp

@@ -795,8 +795,6 @@ namespace Mantid
      * @param samplePos: position of the sample
      * @param det: Geometry object representing the detector (position of the pixel)
      * @param offset: value (close to zero) that changes the factor := factor * (1+offset).
-     * @param vulcancorrection:  boolean to use l2 from Rectangular Detector parent
-     * @return conversion factor for pixel
      */
     double Instrument::calcConversion(const double l1,
                           const Kernel::V3D &beamline,
@@ -866,7 +864,6 @@ namespace Mantid
     //------------------------------------------------------------------------------------------------
     /** Get several instrument parameters used in tof to D-space conversion
      *
-     * @param instrument
      * @param l1 :: primary flight path (source-sample distance)
      * @param beamline :: vector of the direction and length of the beam (source to samepl)
      * @param beamline_norm :: 2 * the length of beamline

Code/Mantid/Framework/Geometry/src/Instrument/Goniometer.cpp

@@ -95,7 +95,9 @@ std::string Goniometer::axesInfo()
 
 /**Add an additional axis to the goniometer, closer to the sample
   @param name :: GoniometerAxis name
-  @param axisx, axisy axisz :: the x, y, z components of the rotation axis
+  @param axisx :: the x component of the rotation axis
+  @param axisy :: the y component of the rotation axis
+  @param axisz :: the z component of the rotation axis
   @param angle :: rotation angle, 0 by default
   @param sense :: rotation sense (CW or CCW), CCW by default
   @param angUnit :: units for angle of type#AngleUnit, angDegrees by default 

Code/Mantid/Framework/Geometry/src/Instrument/InstrumentDefinitionParser.cpp

@@ -367,6 +367,8 @@ namespace Geometry
    *
    *  @param comp :: To set position/location off
    *  @param pElem ::  Poco::XML element that points a location element in the XML doc
+   *  @param angleConvertConst :: constant for converting deg to rad
+   *  @param deltaOffsets :: radial position offsets
    *
    *  @throw logic_error Thrown if second argument is not a pointer to a 'location' XML element
    */
@@ -474,6 +476,8 @@ namespace Geometry
   *
   *  @param comp :: To set position/location off
   *  @param pElem ::  Poco::XML element that points a location element in the XML doc
+  *  @param angleConvertConst :: constant for converting deg to rad
+  *  @param deltaOffsets :: radial position offsets
   *
   *  @return  Thrown if second argument is not a pointer to a 'location' XML element
   */
@@ -1813,13 +1817,13 @@ namespace Geometry
 
 
 
-  /** Takes as input a <type> element containing a <combine-components-into-one-shape>, and
-  *   adjust the <type> element by replacing its containing <component> elements with <cuboid>'s
-  *   (note for now this will only work for <cuboid>'s and when necessary this can be extended).
+  /** Takes as input a \<type\> element containing a <combine-components-into-one-shape>, and
+  *   adjust the \<type\> element by replacing its containing \<component\> elements with \<cuboid\>'s
+  *   (note for now this will only work for \<cuboid\>'s and when necessary this can be extended).
   *
-  *  @param pElem ::  Poco::XML <type> element that we want to adjust
-  *  @param isTypeAssembly[in] :: tell whether any other type, but the special one treated here, is assembly or not
-  *  @param getTypeElement[in] :: contain pointers to all types but the onces treated here
+  *  @param pElem ::  Poco::XML \<type\> element that we want to adjust
+  *  @param isTypeAssembly [in] :: tell whether any other type, but the special one treated here, is assembly or not
+  *  @param getTypeElement [in] :: contain pointers to all types but the onces treated here
   *
   *  @throw InstrumentDefinitionError Thrown if issues with the content of XML instrument file
   */
@@ -1941,9 +1945,10 @@ namespace Geometry
   }
 
 
-  /// Returns a translated and rotated <cuboid> element
+  /// Returns a translated and rotated \<cuboid\> element
   /// @param comp coordinate system to translate and rotate cuboid to
-  /// @param cuboidEle containing one <cuboid> element
+  /// @param cuboidEle containing one \<cuboid\> element
+  /// @param cuboidName name of the \<cuboid\> element
   /// @return XML string of translated and rotated cuboid
   std::string InstrumentDefinitionParser::translateRotateXMLcuboid(ICompAssembly* comp, Poco::XML::Element* cuboidEle,
                                                                   std::string& cuboidName)
@@ -2069,12 +2074,13 @@ namespace Geometry
 
 
   //-----------------------------------------------------------------------------------------------------------------------
-  /** The input <location> element may contain other nested <location> elements. This method returns the parent appended
+  /** The input \<location\> element may contain other nested \<location\> elements. This method returns the parent appended
       which its child components and also name of type of the last child component.
   *
   *  @param parent :: CompAssembly to append to
   *  @param pLocElem ::  Poco::XML element that points to a location element
   *  @param getTypeElement :: contain pointers to all types
+  *  @param endAssembly :: pointer to last child assembly
   *  @return Returns shape type name
   *  @throw InstrumentDefinitionError Thrown if issues with the content of XML instrument file
   */

Code/Mantid/Framework/Geometry/src/MDGeometry/IMDDimensionFactory.cpp

@@ -76,7 +76,7 @@ Mantid::Geometry::IMDDimension* IMDDimensionFactory::create() const
 /**Creation method of factory using xml with overrides.
  @param nBins : overrriden number of bins
  @param min : overriden minimum
- @parm max : overriden maximum
+ @param max : overriden maximum
  @return IMDDimension generated.
 */
 Mantid::Geometry::IMDDimension* IMDDimensionFactory::create(int nBins, double min, double max) const

Code/Mantid/Framework/Geometry/src/MDGeometry/MDGeometryXMLBuilder.cpp

@@ -116,7 +116,7 @@ void MDGeometryBuilderXML<CheckDimensionPolicy>::applyPolicyChecking(IMDDimensio
 
 /**
  Add an x dimension.
- @param dimensionToAdd :: The dimension to add to the geometry.
+ @param dimension :: The dimension to add to the geometry.
  @return true if addition was successful.
  */
 template <typename CheckDimensionPolicy>
@@ -137,7 +137,7 @@ bool MDGeometryBuilderXML<CheckDimensionPolicy>::addXDimension(IMDDimension_cons
 
 /**
  Add an y dimension.
- @param dimensionToAdd :: The dimension to add to the geometry.
+ @param dimension :: The dimension to add to the geometry.
  @return true if addition was successful.
  */
 template <typename CheckDimensionPolicy>
@@ -158,7 +158,7 @@ bool MDGeometryBuilderXML<CheckDimensionPolicy>::addYDimension(IMDDimension_cons
 
 /**
  Add an z dimension.
- @param dimensionToAdd :: The dimension to add to the geometry.
+ @param dimension :: The dimension to add to the geometry.
  @return true if addition was successful.
  */
 template <typename CheckDimensionPolicy>
@@ -178,7 +178,7 @@ bool MDGeometryBuilderXML<CheckDimensionPolicy>::addZDimension(IMDDimension_cons
 
 /**
  Add an t dimension.
- @param dimensionToAdd :: The dimension to add to the geometry.
+ @param dimension :: The dimension to add to the geometry.
  @return true if addition was successful.
  */
 template <typename CheckDimensionPolicy>

Code/Mantid/Framework/Geometry/src/MDGeometry/MDGeometryXMLParser.cpp

@@ -155,7 +155,7 @@ namespace Mantid
 
      /**
      Constructor
-     @param dataSet : vtkDataSet to process
+     @param xmlToProcess : vtkDataSet to process
      */
       MDGeometryXMLParser::MDGeometryXMLParser(const std::string& xmlToProcess) : m_executed(false), m_xmlToProcess(xmlToProcess)
       {
@@ -302,7 +302,7 @@ namespace Mantid
 
       /**
       Setter for the root element.
-      @parameter elementName : name of the element containing xml dimensions. Usually "Dimensions" unless xml snippet passed in directly, in which case do not set.
+      @param elementName : name of the element containing xml dimensions. Usually "Dimensions" unless xml snippet passed in directly, in which case do not set.
      */
       void MDGeometryXMLParser::SetRootNodeCheck(std::string elementName)
       {
@@ -311,7 +311,7 @@ namespace Mantid
 
        /**
       Assignement operator
-      @parameter other : existing MDGeometryXMLParser to assign from.
+      @param other : existing MDGeometryXMLParser to assign from.
       */
       MDGeometryXMLParser& MDGeometryXMLParser::operator=(const MDGeometryXMLParser& other)
       {
@@ -331,7 +331,7 @@ namespace Mantid
 
       /**
       Copy constructor
-      @parameter other : existing MDGeometryXMLParser to assign from.
+      @param other : existing MDGeometryXMLParser to assign from.
       */
       MDGeometryXMLParser::MDGeometryXMLParser(const MDGeometryXMLParser& other) :
           m_executed(other.m_executed),
@@ -347,7 +347,7 @@ namespace Mantid
 
       /**
       Determines whether query dimension is the x dimension.
-      @parameter candiate : query dimension.
+      @param candidate : query dimension.
       @return true if matches.
       */
       bool MDGeometryXMLParser::isXDimension(Mantid::Geometry::IMDDimension_sptr candidate) const
@@ -366,7 +366,7 @@ namespace Mantid
 
       /**
       Determines whether query dimension is the y dimension.
-      @parameter candiate : query dimension.
+      @param candidate : query dimension.
       @return true if matches.
       */
       bool MDGeometryXMLParser::isYDimension(Mantid::Geometry::IMDDimension_sptr candidate) const
@@ -385,7 +385,7 @@ namespace Mantid
 
       /**
       Determines whether query dimension is the z dimension.
-      @parameter candiate : query dimension.
+      @param candidate : query dimension.
       @return true if matches.
       */
       bool MDGeometryXMLParser::isZDimension(Mantid::Geometry::IMDDimension_sptr candidate) const
@@ -404,7 +404,7 @@ namespace Mantid
 
       /**
       Determines whether query dimension is the t dimension.
-      @parameter candiate : query dimension.
+      @param candidate : query dimension.
       @return true if matches.
       */
       bool MDGeometryXMLParser::isTDimension(Mantid::Geometry::IMDDimension_sptr candidate) const

Code/Mantid/Framework/Geometry/src/MDGeometry/MDPlane.cpp

@@ -228,7 +228,8 @@ namespace Geometry
   //----------------------------------------------------------------------------------------------
   /** Copy constructor
    *
-   * @param other :: MDPlane to copy */
+   * @param other :: MDPlane to copy
+   */
   MDPlane::MDPlane(const MDPlane & other)
   : m_nd(other.m_nd), m_inequality(other.m_inequality)
   {
@@ -241,7 +242,8 @@ namespace Geometry
   //----------------------------------------------------------------------------------------------
   /** Assignment operator
    *
-   * @param other :: MDPlane to copy */
+   * @param other :: MDPlane to copy
+   */
   MDPlane & MDPlane::operator=(const MDPlane & other)
   {
     if (this != &other) // protect against invalid self-assignment

Code/Mantid/Framework/Geometry/src/Objects/InstrumentRayTracer.cpp

@@ -48,7 +48,7 @@ namespace Mantid
     /**
      * Trace a given track from the instrument source in the given direction. For performance reasons the 
      * results are accumulated within the object and can be returned using getResults.
-     * @param dir :: A directional vector. The starting point is defined by the instrument source.
+     * @param direction :: A directional vector. The starting point is defined by the instrument source.
      */
     void InstrumentRayTracer::trace(const V3D & dir) const
     {
@@ -62,7 +62,7 @@ namespace Mantid
     /**
      * Trace a given track from the sample position in the given direction. For performance reasons the
      * results are accumulated within the object and can be returned using getResults.
-     * @param dir :: A directional vector. The starting point is defined by the instrument source.
+     * @param direction :: A directional vector. The starting point is defined by the instrument source.
      */
     void InstrumentRayTracer::traceFromSample(const V3D & dir) const
     {

Code/Mantid/Framework/Geometry/src/Objects/ShapeFactory.cpp

@@ -46,7 +46,7 @@ ShapeFactory::ShapeFactory()
 /** Creates a geometric object directly from a XML shape string
  *
  *  @param shapeXML :: XML shape string
- *  @param addTypeTag :: true to wrap a <type> tag around the XML supplied (default)
+ *  @param addTypeTag :: true to wrap a \<type\> tag around the XML supplied (default)
  *  @return A shared pointer to a geometric shape (defaults to an 'empty' shape if XML tags contain no geo. info.) 
  */
 boost::shared_ptr<Object> ShapeFactory::createShape(std::string shapeXML, bool addTypeTag)

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

@@ -68,7 +68,7 @@ namespace Kernel
   public:
     /** Typedef defines that we will keep the objects with these 2 orderings:
      * 1. sequenced = the order they were added.
-     * 2. a hashed, unique index = the "id" number".
+     * 2. a hashed, unique index = the "id" number.
      */
     typedef boost::multi_index::multi_index_container<
       const ISaveable *,

Code/Mantid/Framework/Kernel/src/ArrayLengthValidator.cpp

@@ -54,7 +54,7 @@ namespace Kernel
 
   /**
     Function to set the length
-    @params  value:: size_t type
+    @param  value:: size_t type
    */
   template <typename TYPE>
   void ArrayLengthValidator<TYPE>::setLength(const size_t &value)

Code/Mantid/Framework/Kernel/src/CPUTimer.cpp

@@ -58,7 +58,7 @@ namespace Kernel
   /** Return the fraction of the CPU used (CPUTime/wall-clock time).
    * This can be > 1 on multi-CPU systems.
    *
-   * @param reset :: true to reset both timers
+   * @param doReset :: true to reset both timers
    * @return
    */
   float CPUTimer::CPUfraction(bool doReset)

Code/Mantid/Framework/Kernel/src/ConfigService.cpp

@@ -988,7 +988,7 @@ std::vector<std::string> ConfigServiceImpl::getKeys(const std::string& keyName)
  *  changed key list so that when the program calls saveConfig the properties file will
  *  be the same and not contain the key no more
  *
- *  @param keyName :: The key that is to be deleted
+ *  @param rootName :: The key that is to be deleted
  */
 void ConfigServiceImpl::remove(const std::string& rootName) const
 {
@@ -1007,7 +1007,7 @@ void ConfigServiceImpl::remove(const std::string& rootName) const
 
 /** Checks to see whether the given key exists.
  *
- *  @param keyName :: The case sensitive key that you are looking to see if exists.
+ *  @param rootName :: The case sensitive key that you are looking to see if exists.
  *  @returns Boolean value denoting whether the exists or not.
  */
 bool ConfigServiceImpl::hasProperty(const std::string& rootName) const
@@ -1556,7 +1556,7 @@ void ConfigServiceImpl::updateFacilities(const std::string& fName)
 
 /**
  * Returns instruments with given name
- * @param  iName Instrument name
+ * @param  instrumentName Instrument name
  * @return the instrument information object
  * @throw NotFoundError if iName was not found
  */
@@ -1614,7 +1614,7 @@ const FacilityInfo& ConfigServiceImpl::getFacility() const
 
 /**
  * Get a facility
- * @param fName :: Facility name
+ * @param faciliyName :: Facility name
  * @return the facility information object
  * @throw NotFoundException if the facility is not found
  */

Code/Mantid/Framework/Kernel/src/DiskMRU.cpp

@@ -75,7 +75,6 @@ namespace Kernel
   /** Tell the MRU that we are loading the given item.
    *
    * @param item :: item that is
-   * @param memory :: memory that the object will use.
    */
   void DiskMRU::loading(const ISaveable * item)
   {

Code/Mantid/Framework/MDAlgorithms/inc/MantidMDAlgorithms/ConvertToQ3DdE.h

@@ -17,10 +17,9 @@ namespace Mantid
 namespace MDAlgorithms
 {
 
-/** ConvertToDiffractionMDWorkspace :
+/**
    *  Transfrom processed inelastic workspace into MD(Event)Workspace with 3 components of momentum transfer plus energy transfer for Indirect?(should be expanded) geometry instrument
    * 
-   * @modyfier Alex Buts, ISIS; copypasted with minimal variatuions from ConvertToDiffractionMDWorkspace;  @author Janik Zikovsky, SNS  @date 2011-03-01 
    * @date 07-09-2011
 
     Copyright © 2010 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

Code/Mantid/Framework/TestHelpers/src/WorkspaceCreationHelper.cpp

@@ -341,6 +341,7 @@ namespace WorkspaceCreationHelper
    *
    * @param numBanks :: number of rectangular banks
    * @param numPixels :: each bank will be numPixels*numPixels
+   * @param clearEvents :: if true, erase the events from list
    * @return The EventWorkspace
    */
   Mantid::DataObjects::EventWorkspace_sptr createEventWorkspaceWithFullInstrument(int numBanks, int numPixels, bool clearEvents)
@@ -515,6 +516,7 @@ namespace WorkspaceCreationHelper
    *
    * @param numbins :: # of bins to set. This is also = # of events per EventList
    * @param numpixels :: number of pixels
+   * @param bin_delta :: a constant offset to shift the bin bounds by
    * @return EventWorkspace
    */
   EventWorkspace_sptr CreateRandomEventWorkspace(size_t numbins, size_t numpixels, double bin_delta)
@@ -714,8 +716,9 @@ namespace WorkspaceCreationHelper
   }
 
   /// Create a workspace with all components needed for inelastic analysis and 3 detectors in specific places
-  /// @param numPixels --- numbed of detectors
-  /// @param numBins   -- number of energy bins;
+  /// @param L2        -- the sample to detector flight path
+  /// @param polar     -- the detector polar angle
+  /// @param azimutal  -- the detector azimuthal
   /// @param Emin      -- minimal energy transfer
   /// @param Emax      -- maxinal energy transfer
   /// @param Ei        -- input beam energy

Code/Mantid/Framework/WorkflowAlgorithms/src/HFIRDarkCurrentSubtraction.cpp

@@ -163,7 +163,7 @@ double HFIRDarkCurrentSubtraction::getCountingTime(MatrixWorkspace_sptr inputWS)
 
 /// Zero out the timer and monitor channels from the dark current workspace
 /// so that we can keep them in the data workspace after subtraction
-/// @param inputWS :: dark current workspace to clean up
+/// @param scaleDarkWS :: dark current workspace to clean up
 void HFIRDarkCurrentSubtraction::cleanupDarkCurrent(MatrixWorkspace_sptr scaledDarkWS)
 {
   // Set time and monitor channels to zero, so that we subtract only detectors