refs #6449 Doxygen warnings

mantidproject · Apr 9, 2013 · 394a455 · 394a455
1 parent 88d4574
commit 394a455
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/MDTransfQ3D.h b/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/MDTransfQ3D.h
@@ -50,7 +50,7 @@ class DLLExport MDTransfQ3D: public MDTransfModQ
 public:
     /// the name, this ChildAlgorithm is known to users (will appear in selection list)
     const std::string transfID()const; // {return "Q3D"; }
-    bool calcYDepCoordinates(std::vector<coord_t> &Coord,size_t i);
+    bool calcYDepCoordinates(std::vector<coord_t> &Coord,size_t i);   
     bool calcMatrixCoord(const double& X,std::vector<coord_t> &Coord, double &s, double &err)const;
     // constructor;
     MDTransfQ3D();

diff --git a/Code/Mantid/Framework/MDEvents/src/MDTransfQ3D.cpp b/Code/Mantid/Framework/MDEvents/src/MDTransfQ3D.cpp
@@ -22,7 +22,17 @@ namespace Mantid
       }
     }
 
-
+    /** Calculates 3D transformation of the variable coordinates and (if applicable) signal and error depending on 3D coordinates 
+      * (e.g. Lorents corrections) 
+      *@param x -- the transformed values
+      *@param s -- the signal
+      *@param err --the error
+      *
+      *@return converted 3D coordinates corresponding to given detector and X-vale
+      Optionally:
+      @return s  -- corrected signal
+      @return err  -- corrected error
+    */
     bool MDTransfQ3D::calcMatrixCoord(const double& x,std::vector<coord_t> &Coord,double &s, double &err)const
     {
       if(m_Emode == Kernel::DeltaEMode::Elastic)