Refs #3867. Fixing doxygen warnings.

mantidproject · Dec 28, 2011 · 8f47fd8 · 8f47fd8
1 parent 86fb4c3
commit 8f47fd8
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 4 deletions.
diff --git a/Code/Mantid/Framework/API/inc/MantidAPI/Column.h b/Code/Mantid/Framework/API/inc/MantidAPI/Column.h
@@ -89,7 +89,7 @@ class Column_DllExport Column
 
     /// Returns typeid for the pointer type to the data element in the column
     virtual const std::type_info& get_pointer_type_info()const = 0;
-    /// Is the column to be read-only? @retur true by default.
+    /// Is the column to be read-only? @return true by default.
     virtual bool getReadOnly() const
     { return true; }
 

diff --git a/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/SmoothNeighbours.h b/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/SmoothNeighbours.h
@@ -24,7 +24,7 @@ namespace Mantid
     public:
       /**
       Constructor
-      @cutoff : radius cutoff for filtering
+      @param cutoff : radius cutoff for filtering
       */
       RadiusFilter(double cutoff) : m_cutoff(cutoff)
       {

diff --git a/Code/Mantid/Framework/Algorithms/src/CalculateTransmission.cpp b/Code/Mantid/Framework/Algorithms/src/CalculateTransmission.cpp
@@ -214,6 +214,7 @@ API::MatrixWorkspace_sptr CalculateTransmission::extractSpectrum(API::MatrixWork
 }
 /** Calculate a workspace that contains the result of the fit to the transmission fraction that was calculated
 *  @param raw [in] the workspace with the unfitted transmission ratio data
+*  @param rebinParams [in] the parameters for rebinning
 *  @param fitMethod [in] string can either be Log or Linear
 *  @return a workspace that contains the evaluation of the fit
 *  @throw runtime_error if the Linear or ExtractSpectrum algorithm fails during execution

diff --git a/Code/Mantid/Framework/Algorithms/src/MedianDetectorTest.cpp b/Code/Mantid/Framework/Algorithms/src/MedianDetectorTest.cpp
@@ -221,6 +221,7 @@ namespace Mantid
      * Takes a single valued histogram workspace and assesses which histograms are within the limits. 
      * Those that are not are masked on the input workspace.
      * @param countWorkspace :: Input/Output Integrated workspace to diagnose
+     * @param maskWS :: A mask workspace to apply
      * @param average :: The expected number of counts, spectra within defined threshold won't fail
      * @param badIndices :: If an index is in this list then it will not be included in the tests
      * @return The number of detectors that failed the tests, not including those skipped

diff --git a/Code/Mantid/Framework/Algorithms/src/SmoothNeighbours.cpp b/Code/Mantid/Framework/Algorithms/src/SmoothNeighbours.cpp
@@ -492,7 +492,7 @@ Instrument_const_sptr SmoothNeighbours::fetchInstrument() const
 /**
 Translate the radius into meters.
 @param radiusUnits : The name of the radius units
-@param enteredUnits : The numerical value of the radius in whatever units have been specified
+@param enteredRadius : The numerical value of the radius in whatever units have been specified
 */
 double SmoothNeighbours::translateToMeters(const std::string radiusUnits, const double& enteredRadius)
 {

diff --git a/Code/Mantid/Framework/Algorithms/src/WeightingStrategy.cpp b/Code/Mantid/Framework/Algorithms/src/WeightingStrategy.cpp
@@ -60,7 +60,7 @@ namespace Mantid
 
     /**
     Calculate the weight at distance from epicenter. Always returns 1
-    @param distance : 
+    @param distance : unused argument
     @return 1
     */
     double FlatWeighting::weightAt(const Mantid::Kernel::V3D&)