Refs #3867. Fixing doxygen warnings.

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

@@ -53,9 +53,9 @@ struct COORD_TRANSFORMER
      *
      * In addition it caluclates the property-dependant coordinates 
      *
+     * @param Coord        -- subalgorithm specific number of variables, calculated from properties and placed into specific place of the Coord vector;
      * @param n_ws_variabes -- subalgorithm specific number of variables, calculated from the workspace data
      *
-     * @return Coord        -- subalgorithm specific number of variables, calculated from properties and placed into specific place of the Coord vector;
      * @return true         -- if all Coord are within the range requested by algorithm. false otherwise
      *
      * has to be specialized
@@ -66,9 +66,9 @@ struct COORD_TRANSFORMER
 
 
     /** template generalizes the code to calculate Y-variables within the detector's loop of processQND workspace
+     * @param Coord  -- current Y coordinate, placed in the position of the Coordinate vector, specific for particular subalgorithm.
      * @param i    -- index of external loop, identifying current y-coordinate
      * 
-     * @return Coord  -- current Y coordinate, placed in the position of the Coordinate vector, specific for particular subalgorithm.    
      * @return true   -- if all Coord are within the range requested by algorithm. false otherwise   
      * 
      *  some default implementations possible (e.g mode Q3D,ragged  Any_Mode( Direct, indirect,elastic), 
@@ -81,7 +81,7 @@ struct COORD_TRANSFORMER
      * @param i    -- index of external loop, identifying generic y-coordinate
      * @param j    -- index of internal loop, identifying generic x-coordinate
      * 
-     * @return Coord --Subalgorithm specific number of coordinates, placed in the proper position of the Coordinate vector   
+     * @param Coord --Subalgorithm specific number of coordinates, placed in the proper position of the Coordinate vector
      * @return true  -- if all Coord are within the range requested by algorithm. false otherwise   
      *
      * has to be specialized
@@ -452,4 +452,4 @@ struct COORD_TRANSFORMER<Q3D,Elastic,CONV>
 } // End MDAlgorighms namespace
 } // End Mantid namespace
 
-#endif
+#endif

Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/MDEvent.h

@@ -152,7 +152,7 @@ namespace MDEvents
     { return detectorId;  }
 
     /** Sets the detectorId of this event
-     * @param index :: new runIndex value. */
+     * @param id :: new runIndex value. */
     void setDetectorId(int32_t id)
     { detectorId = id; }
 

Code/Mantid/Framework/MDEvents/src/MDBox.cpp

@@ -23,42 +23,42 @@ namespace MDEvents
 
   //-----------------------------------------------------------------------------------------------
   /** Constructor
-   * @param controller :: BoxController that controls how boxes split
+   * @param splitter :: BoxController that controls how boxes split
    * @param depth :: splitting depth of the new box.
    */
-  TMDE(MDBox)::MDBox(BoxController_sptr controller, const size_t depth)
+  TMDE(MDBox)::MDBox(BoxController_sptr splitter, const size_t depth)
     : IMDBox<MDE, nd>(),
       m_dataBusy(false), m_dataModified(false), m_dataAdded(false),
       m_fileIndexStart(0), m_fileNumEvents(0),
       m_onDisk(false), m_inMemory(true)
 
   {
-    if (controller->getNDims() != nd)
+    if (splitter->getNDims() != nd)
       throw std::invalid_argument("MDBox::ctor(): controller passed has the wrong number of dimensions.");
-    this->m_BoxController = controller;
+    this->m_BoxController = splitter;
     this->m_depth = depth;
     // Give it a fresh ID from the controller.
-    this->setId( controller->getNextId() );
+    this->setId( splitter->getNextId() );
   }
 
   //-----------------------------------------------------------------------------------------------
   /** Constructor
-   * @param controller :: BoxController that controls how boxes split
+   * @param splitter :: BoxController that controls how boxes split
    * @param depth :: splitting depth of the new box.
-   * @param extents :: vector defining the extents
+   * @param extentsVector :: vector defining the extents
    */
-  TMDE(MDBox)::MDBox(BoxController_sptr controller, const size_t depth, const std::vector<Mantid::Geometry::MDDimensionExtents> & extentsVector)
+  TMDE(MDBox)::MDBox(BoxController_sptr splitter, const size_t depth, const std::vector<Mantid::Geometry::MDDimensionExtents> & extentsVector)
       : IMDBox<MDE, nd>(extentsVector),
         m_dataBusy(false), m_dataModified(false), m_dataAdded(false),
         m_fileIndexStart(0), m_fileNumEvents(0),
         m_onDisk(false), m_inMemory(true)
   {
-    if (controller->getNDims() != nd)
+    if (splitter->getNDims() != nd)
       throw std::invalid_argument("MDBox::ctor(): controller passed has the wrong number of dimensions.");
-    this->m_BoxController = controller;
+    this->m_BoxController = splitter;
     this->m_depth = depth;
     // Give it a fresh ID from the controller.
-    this->setId( controller->getNextId() );
+    this->setId( splitter->getNextId() );
   }
 
 
@@ -403,7 +403,8 @@ namespace MDEvents
 
   //-----------------------------------------------------------------------------------------------
   /** Calculate the centroid of this box.
-   * @param centroid[out] :: nd-sized array that will be set to the centroid. */
+   * @param centroid [out] :: nd-sized array that will be set to the centroid.
+   */
   TMDE(
   void MDBox)::calculateCentroid(coord_t * centroid) const
   {

Code/Mantid/Framework/MDEvents/src/MDGridBox.cpp

@@ -42,6 +42,7 @@ namespace MDEvents
   //-----------------------------------------------------------------------------------------------
   /** Constructor with a box controller.
    * @param bc :: BoxController
+   * @param depth :: recursive split depth
    * @param extentsVector :: size of the box
    */
   TMDE(MDGridBox)::MDGridBox(BoxController_sptr bc, const size_t depth, const std::vector<Mantid::Geometry::MDDimensionExtents> & extentsVector)
@@ -777,14 +778,9 @@ namespace MDEvents
    *
    * @param ts :: optional ThreadScheduler * that will be used to parallelize
    *        recursive splitting. Set to NULL to do it serially.
-   * @param newBoxes :: optional pointer to a vector that will be filled with the
-   *        newly created boxes.
-   * @param newBoxesMutex :: must specify this mutex for parallel splitting of boxes.
-   *        The mutex protects the newBoxes vector.
    */
   TMDE(
-  void MDGridBox)::splitAllIfNeeded(ThreadScheduler * ts
-      /*,std::vector<IMDBox<MDE,nd>*> * newBoxes, Mantid::Kernel::Mutex * newBoxesMutex */ )
+  void MDGridBox)::splitAllIfNeeded(ThreadScheduler * ts)
   {
     DiskMRU & mru = this->m_BoxController->getDiskMRU();
     mru.setNumberOfObjects( this->m_BoxController->getMaxId() );
@@ -1004,15 +1000,6 @@ namespace MDEvents
 
 
 
-//  //-----------------------------------------------------------------------------------------------
-//  /** General (non-axis-aligned) centerpoint binning method.
-//   * TODO: TEST THIS!
-//   *
-//   * @param bin :: a MDBin object giving the limits, aligned with the axes of the workspace,
-//   *        of where the non-aligned bin MIGHT be present.
-//   * @param function :: a ImplicitFunction that will evaluate true for any coordinate that is
-//   *        contained within the (non-axis-aligned) bin.
-//   */
 //  TMDE(
 //  void MDGridBox)::generalBin(MDBin<MDE,nd> & bin, Mantid::API::ImplicitFunction & function) const
 //  {
@@ -1208,8 +1195,8 @@ namespace MDEvents
    * @param radiusTransform :: nd-to-1 coordinate transformation that converts from these
    *        dimensions to the distance (squared) from the center of the sphere.
    * @param radiusSquared :: radius^2 below which to integrate
-   * @param[out] signal :: set to the integrated signal
-   * @param[out] errorSquared :: set to the integrated squared error.
+   * @param signal [out] :: set to the integrated signal
+   * @param errorSquared [out] :: set to the integrated squared error.
    */
   TMDE(
   void MDGridBox)::integrateSphere(CoordTransform & radiusTransform, const coord_t radiusSquared, signal_t & signal, signal_t & errorSquared) const

Code/Mantid/Framework/MDEvents/src/MergeMD.cpp

@@ -429,6 +429,8 @@ namespace MDEvents
      * @param alg :: MergeMD Algorithm - used to pass parameters etc. around
      * @param blockNum :: Which block to load?
      * @param outWS :: Output workspace
+     * @param boxesById :: list of boxes with IDs
+     * @param parallelSplit :: if true, split the boxes via parallel mechanism
      */
     MergeMDLoadToBoxTask(MergeMD * alg, size_t blockNum, typename MDEventWorkspace<MDE, nd>::sptr outWS,
         typename std::vector<IMDBox<MDE,nd> *> & boxesById, bool parallelSplit)

Code/Mantid/Framework/MDEvents/src/SliceMD.cpp

@@ -123,9 +123,11 @@ namespace MDEvents
    * @param newEvent :: the destination event
    */
   template<size_t nd, size_t ond>
-  inline void copyEvent(const MDLeanEvent<nd> & /*srcEvent*/, MDLeanEvent<ond> & /*newEvent*/)
+  inline void copyEvent(const MDLeanEvent<nd> &srcEvent, MDLeanEvent<ond> & newEvent)
   {
     // Nothing extra copy - this is no-op
+    UNUSED_ARG(srcEvent);
+    UNUSED_ARG(newEvent);
   }
 
   //----------------------------------------------------------------------------------------------

Code/Mantid/Framework/Nexus/src/NexusFileIO.cpp

@@ -526,7 +526,13 @@ using namespace DataObjects;
   /** Write out a combined chunk of event data
    *
    * @param ws :: an EventWorkspace
-   *  */
+   * @param indices :: array of event list indexes
+   * @param tofs :: array of TOFs
+   * @param weights :: array of event weights
+   * @param errorSquareds :: array of event squared errors
+   * @param pulsetimes :: array of pulsetimes
+   * @param compress :: if true, compress the entry
+   */
   int NexusFileIO::writeNexusProcessedDataEventCombined( const DataObjects::EventWorkspace_const_sptr& ws,
       std::vector<int64_t> & indices,
       double * tofs, float * weights, float * errorSquareds, int64_t * pulsetimes,
@@ -626,6 +632,10 @@ using namespace DataObjects;
   //-------------------------------------------------------------------------------------
   /** Write out the event list data, no matter what the underlying event type is
    * @param events :: vector of TofEvent or WeightedEvent, etc.
+   * @param writeTOF :: if true, write the TOF values
+   * @param writePulsetime :: if true, write the pulse time values
+   * @param writeWeight :: if true, write the event weights
+   * @param writeError :: if true, write the errors
    */
   template<class T>
   void NexusFileIO::writeEventListData( std::vector<T> events, bool writeTOF, bool writePulsetime, bool writeWeight, bool writeError) const

Code/Mantid/Framework/PythonAPI/inc/MantidPythonAPI/PyAlgorithmWrapper.h

@@ -70,6 +70,7 @@ class PyAlgorithmBase : public Mantid::API::CloneableAlgorithm
    * Expose createSubAlgorithm to python so that a python algorithm can
    * create a sub-algorithm that will not log itself.
    * @param algo_name :: Name of the algorithm to create
+   * @param version :: Version number, -1 is default
    */
   /// Creates and instance of an algorithm
   boost::shared_ptr<Mantid::API::IAlgorithm> _createSubAlgorithm(const std::string& algo_name, const int version=-1)

Code/Mantid/Framework/PythonAPI/inc/MantidPythonAPI/kernel_exports.h

@@ -103,7 +103,7 @@ namespace Mantid
 
       /**
        * Replace the current list of data search paths with the given ones
-       * @param value :: A semi-colon separated list of paths
+       * @param values :: A semi-colon separated list of paths
        */
       void setDataSearchDirs(const boost::python::list &values)
       {

Code/Mantid/Framework/PythonAPI/src/WorkspaceProxies.cpp

@@ -143,9 +143,10 @@ namespace Mantid
     * Generic to MDWorkspaces.
     * Called by python overloads for _binary_op (see api_exports.cpp)
     *
-    * @param lhs :: The input workspace
-    * @param rhs :: The input value
+    * @param inputWS :: The input workspace
+    * @param value :: The input value
     * @param op :: The operation
+    * @param name :: The output name
     * @param inplace :: If true, then the lhs argument is replaced by the result of the operation.
     * @param reverse :: If true then the double is the lhs argument
     * @return A shared pointer to the result workspace

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

@@ -116,9 +116,10 @@ namespace Mantid
     * Generic to MDWorkspaces.
     * Called by python overloads for _binary_op (see api_exports.cpp)
     *
-    * @param lhs :: The input workspace
-    * @param rhs :: The input value
+    * @param inputWS :: The input workspace
+    * @param value :: The input value
     * @param op :: The operation
+    * @param name :: The output name
     * @param inplace :: If true, then the lhs argument is replaced by the result of the operation.
     * @param reverse :: If true then the double is the lhs argument
     * @return A shared pointer to the result workspace

Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/MDEventsTestHelper.h

@@ -54,6 +54,7 @@ namespace MDEventsTestHelper
    * @param max :: extent of each dimension (max)
    * @param numEventsPerBox :: will create one MDLeanEvent in the center of each sub-box.
    *        0 = don't split box, don't add events
+   * @param dimSplit :: ?????
    * @return
    */
   template<typename MDE, size_t nd>
@@ -136,8 +137,11 @@ namespace MDEventsTestHelper
   /** Generate an empty MDBox with 2 dimensions, splitting in (default) 10x10 boxes.
    * Box size is 10x10.
    *
-   * @param split0, split1 :: for uneven splitting
-   * */
+   * @param split0 :: for uneven splitting
+   * @param split1 :: for uneven splitting
+   * @param dimensionMin :: minimum dimesion extent
+   * @param dimensionMax :: maximum dimesion extent
+   */
   template <size_t nd>
   static MDGridBox<MDLeanEvent<nd>,nd> * makeMDGridBox(size_t split0=10, size_t split1=10, coord_t dimensionMin=0.0, coord_t dimensionMax=10.0)
   {

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

@@ -197,10 +197,11 @@ namespace MDEventsTestHelper
 
   /** Creates a fake MDHistoWorkspace
    *
-   * @param signal :: signal and error squared in every point
+   * @param signal :: signal in every point
    * @param numDims :: number of dimensions to create. They will range from 0 to max
    * @param numBins :: bins in each dimensions
    * @param max :: max position in each dimension
+   * @param errorSquared :: error squared in every point
    * @return the MDHisto
    */
   Mantid::MDEvents::MDHistoWorkspace_sptr makeFakeMDHistoWorkspace(double signal, size_t numDims, size_t numBins,

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

@@ -14,7 +14,11 @@ using namespace Mantid::API;
 const QString deltaECalc::tempWS = "mono_sample_temporyWS";
 
 /** Read the data the user supplied to create Python code to do their calculation
+* @param interface :: handle to the widget for the interface
 * @param userSettings :: the form that the user filled in
+* @param removalBg :: if true, remove background
+* @param TOFWinSt :: start of TOF range for background
+* @param TOFWinEnd :: end of TOF range for background
 * @throw invalid_argument where problems with user data prevent the calculation from proceeding
 */
 deltaECalc::deltaECalc(QWidget * const interface, const Ui::ConvertToEnergy &userSettings, 
@@ -24,8 +28,11 @@ deltaECalc::deltaECalc(QWidget * const interface, const Ui::ConvertToEnergy &use
 }
 
 /** Adds user values from the GUI into the Python script
-* @param inputFiles :: a coma separated list of data file names
-* @param whiteB :: The filename of the white beam run
+* @param runFiles :: a comma separated list of data file names
+* @param whiteBeam :: The filename of the white beam run
+* @param absRunFiles :: run files for absolute normalization
+* @param absWhiteBeam :: run file for absolute white beam normalization
+* @param saveName :: filename for output saving
 */
 void deltaECalc::createProcessingScript(const QStringList &runFiles, const QString &whiteBeam,
 					const QStringList &absRunFiles, const QString &absWhiteBeam,

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

@@ -128,7 +128,10 @@ namespace MantidQt
 
     }
     /**This method is called when an investigation is selected  from investigations list
+     *@param tablewidget :: pointer to the current table widget
      *@param item ::  table widget item
+     *@param parent :: the parent widget for item
+     *@param ws_sptr :: pointer to a table workspace
      */
     void ICatUtils::investigationSelected(QTableWidget* tablewidget,QTableWidgetItem* item,
         QWidget* parent,Mantid::API::ITableWorkspace_sptr ws_sptr )