refs #6449 Doxygen warnings

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

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/Code/Mantid/Framework/API/inc/MantidAPI/IMDNode.h b/Code/Mantid/Framework/API/inc/MantidAPI/IMDNode.h
@@ -156,7 +156,7 @@ class IMDNode
      */
     //virtual void centerpointBin(MDBin<MDE,nd> & bin, bool * fullyContained) const = 0;
 
-    /// General binning method for any shape.
+    // General binning method for any shape.
     //virtual void generalBin(MDBin<MDE,nd> & bin, Mantid::Geometry::MDImplicitFunction & function) const = 0;
 
    /** Sphere (peak) integration

diff --git a/Code/Mantid/Framework/Kernel/inc/MantidKernel/ISaveable.h b/Code/Mantid/Framework/Kernel/inc/MantidKernel/ISaveable.h
@@ -72,7 +72,9 @@ namespace Kernel
     { return m_isLoaded;}
 
     // protected?
-   /**@sets the value of the isLoad parameter -- usually only load functiomn should set it to true */
+   /**sets the value of the isLoad parameter, indicating that data from HDD have its image in memory
+    *@param Yes -- boolean true or false --usually only load functiomn should set it to true 
+   */
    void setLoaded(bool Yes)
     { m_isLoaded = Yes;}
 

diff --git a/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/MDBoxFlatTree.h b/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/MDBoxFlatTree.h
@@ -40,9 +40,7 @@ namespace MDEvents
   class DLLExport MDBoxFlatTree
   {
   public:
-    /**The constructor of the flat box tree
-     *@param -- fileName -- the name of the file to load/save the box strucure to. 
-    */
+    /**The constructor of the flat box tree    */
     MDBoxFlatTree();
 
 

diff --git a/Code/Mantid/Framework/MDEvents/src/BoxControllerNeXusIO.cpp b/Code/Mantid/Framework/MDEvents/src/BoxControllerNeXusIO.cpp
@@ -57,10 +57,10 @@ namespace MDEvents
    *  As save/load operations use void data type, these function allow set up/get  the type name provided for the IO operations
    *  and the size of the data type in bytes (e.g. the  class dependant physical  meaning of the blockSize and blockPosition used 
    *  by save/load operations     
-   * @param CoordSize -- size (in bytes) of the blockPosition and blockSize used in save/load operations. 4 and 8 are supported only
-   * @paramtypeName  -- the name of the event used in the operations. The name itself defines the size and the format of the event
-                       The events described in the class header are supported only
- */
+   * @param blockSize -- size (in bytes) of the blockPosition and blockSize used in save/load operations. 4 and 8 are supported only
+                         e.g. float and double
+   * @param typeName  -- the name of the event used in the operations. The name itself defines the size and the format of the event
+                         The events described in the class header are supported only  */
   void BoxControllerNeXusIO::setDataType(const size_t blockSize, const std::string &typeName)
   {
       if(blockSize==4 || blockSize==8)
@@ -101,7 +101,7 @@ 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. 
-   *@more  opening mode (read or read/write)
+   *@mode  opening mode (read or read/write)
    *
    *
   */