refs #6449 Doxygen warnings

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

@@ -60,7 +60,7 @@ class IMDNode
     virtual void setFileBacked()=0;
    /** if node was fileBacked, the method clears file-backed information 
     *@param loadFileData -- if true, the data on HDD and not yet in memory are loaded into memory before deleting fileBacked information, 
-                            if false, all on HDD contents is discarded, which can break the data integrity (used by destructor)  */
+                            if false, all on HDD contents are discarded, which can break the data integrity (used by destructor)  */
     virtual void clearFileBacked(bool loadFileData)=0;
 
     /**Save the box at specific disk position using the class, respoinsible for the file IO. */
@@ -152,14 +152,6 @@ class IMDNode
 
 
     // -------------------------------------------------------------------------------------------
-    /** Perform centerpoint binning of events
-     * @param bin :: MDBin object giving the limits of events to accept.
-     * @param fullyContained :: optional bool array sized [nd] of which dimensions are known to be fully contained (for MDSplitBox)
-     */
-    //virtual void centerpointBin(MDBin<MDE,nd> & bin, bool * fullyContained) const = 0;
-
-    // General binning method for any shape.
-    //virtual void generalBin(MDBin<MDE,nd> & bin, Mantid::Geometry::MDImplicitFunction & function) const = 0;
 
    /** Sphere (peak) integration
    * The CoordTransform object could be used for more complex shapes, e.g. "lentil" integration, as long

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

@@ -100,8 +100,8 @@ namespace MDEvents
 
   /**Open the file to use in IO operations with events 
    *
-   *@param fileName the name of the file to open. Search for file perfomed within the Mantid search path. 
-   *@mode  opening mode (read or read/write)
+   *@param fileName -- the name of the file to open. Search for file perfomed within the Mantid search path. 
+   *@param mode  -- opening mode (read or read/write)
    *
    *
   */ 

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

@@ -81,8 +81,7 @@ namespace MDEvents
    * @param splitter :: BoxController that controls how boxes split
    * @param depth :: splitting depth of the new box.
    * @param extentsVector :: vector defining the extents
-   * @param boxSize :: size of reserve for data
-   * @param nBoxEvents :: if defined, we expect box to have such number of events so will allocate memory for it. 
+   * @param nBoxEvents :: Initial number of events to reserve memory for. If left undefined, the memory will be alocated on request.                        
    * @param boxID :: id for the given box
    */
   TMDE(MDBox)::MDBox(BoxController *const splitter, const uint32_t depth, const std::vector<Mantid::Geometry::MDDimensionExtents<coord_t> > & extentsVector,
@@ -704,8 +703,8 @@ namespace MDEvents
    * @param Signal  :: events signal
    * @param errorSq :: events Error squared
    * @param point :: reference to the  vector of MDEvent coordinates
-   * @param index   run  index of the event
-   * @param index   detector's ID of the event
+   * @param runIndex  ::  run  index of the experiment the event come from
+   * @param detectorId :: the ID of the  detector recoded the event
    * */
    TMDE(
    void MDBox)::buildAndAddEvent(const signal_t Signal,const  signal_t errorSq,const std::vector<coord_t> &point, uint16_t runIndex,uint32_t detectorId)
@@ -721,8 +720,9 @@ namespace MDEvents
    * @param Signal  :: events signal
    * @param errorSq :: events Error squared
    * @param point :: reference to the  vector of MDEvent coordinates
-   * @param index   run  index of the event
-   * @param index   detector's ID of the event
+   * @param runIndex  ::  run  index of the experiment the event come from
+   * @param detectorId :: the ID of the  detector recoded the event
+   * @param index  :: the index of this cell within the hosting grid box.
    */
    TMDE(
    void MDBox)::buildAndTraceEvent(const signal_t Signal,const signal_t errorSq,const std::vector<coord_t> &point, uint16_t runIndex,uint32_t detectorId,size_t index)
@@ -735,7 +735,11 @@ namespace MDEvents
    * No lock is performed. This is only safe if no 2 threads will
    * try to add to the same box at the same time.
    *
-   * @param Evnt :: reference to a MDEvent to add.
+   * @param Signal  :: events signal
+   * @param errorSq :: events Error squared
+   * @param point :: reference to the  vector of MDEvent coordinates
+   * @param runIndex  ::  run  index of the experiment the event come from
+   * @param detectorId :: the ID of the  detector recoded the event
    * */
   TMDE(
   void MDBox)::buildAndAddEventUnsafe(const signal_t Signal,const  signal_t errorSq,const std::vector<coord_t> &point, uint16_t runIndex,uint32_t detectorId)

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

@@ -383,7 +383,8 @@ namespace Mantid
   //----------------------------------------------------------------------------------------------
   /** Load the ExperimentInfo blocks, if any, in the NXS file
   *
-  * @param ws :: MDEventWorkspace/MDHisto to load
+  * @param file :: the pointer to the properly opened nexus data file where the experiment info groups can be found. 
+  * @param ws :: MDEventWorkspace/MDHisto to load experiment infos to
   */
   void MDBoxFlatTree::loadExperimentInfos(::NeXus::File * const file,boost::shared_ptr<Mantid::API::MultipleExperimentInfos> ws)
   {

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

@@ -1413,10 +1413,10 @@ namespace MDEvents
 
   /** Create and Add several (N) events into correspondent boxes; If the event is out/at of bounds it may be placed in very peculiar place!
    *
-   * @param sigErrSq  :: vector of N-signals and errors where errror follows signal 
-   * @param Coord :: vector of MD event coordinates, nd(number of dimensions)  coordinates for each event
-   * @param index :: vector of run  indexes for N events.
-   * @param index :: vector of detector's ID for N events.
+   * @param sigErrSq   :: vector of N-signals and errors where errror follows signal 
+   * @param Coord      :: vector of MD event coordinates, nd(number of dimensions)  coordinates for each event
+   * @param runIndex   :: vector of run  indexes for N events.
+   * @param detectorId :: vector of detector's ID for N events.
 
    *@return number of events rejected (0 as nothing is rejected here)
    */

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

@@ -27,7 +27,7 @@ namespace Mantid
     }
     /** method returns number of matrix dimensions calculated by this class
     *   as function of the energy analysis (conversion) mode  
-       @param dEmode -- energy conversion mode requested by the user for the transfromation
+       @param mode   -- energy conversion mode requested by the user for the transfromation
        @param inWS   -- imput matrix workspace, the subject of transformation.
     */
     unsigned int MDTransfModQ::getNMatrixDimensions(Kernel::DeltaEMode::Type mode,API::MatrixWorkspace_const_sptr inWS)const
@@ -43,12 +43,17 @@ namespace Mantid
     }
 
 
-    /**Convert single point of matrix workspacd into reciprocal space and (optionally) modify signal and error 
+    /**Convert single point of matrix workspace into reciprocal space and (optionally) modify signal and error 
        as function of reciprocal space (e.g. Lorents corrections)
        @param x      -- the x-coordinate of matix workspace. Often can be a time of flight though the unit conversion is availible
-       @return Coord -- converted MD coordinates of the point x calculated for particular workspace position (detector)
+       @param Coord -- converted MD coordinates of the point x calculated for particular workspace position (detector)
 
+       @param signal -- the signal in the point
+       @param error -- the signal in the point
        no signal or error transformation is performed by this particular method. 
+
+       @return Coord -- the calculated coordinate of the point in the reciprocal space. 
+
     */
     bool MDTransfModQ::calcMatrixCoord(const double& x,std::vector<coord_t> &Coord, double & /*signal*/,double &/*ErrSq*/)const
     {