Fixed ICAT doxygen warnings. Refs #8321.

mantidproject · Nov 6, 2013 · a260d68 · a260d68
1 parent 1fca2b0
commit a260d68
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/Code/Mantid/Framework/ICat/inc/MantidICat/ICat3/ICat3Helper.h b/Code/Mantid/Framework/ICat/inc/MantidICat/ICat3/ICat3Helper.h
@@ -53,10 +53,10 @@ namespace Mantid
       int doSearch(ICat3::ICATPortBindingProxy& icat,boost::shared_ptr<ICat3::ns1__searchByAdvanced>& request,ICat3::ns1__searchByAdvancedResponse& response);
 
       /// calls getInvestigationIncludes api's
-      int getDataFiles(long long invId,ICat3::ns1__investigationInclude inclide,API::ITableWorkspace_sptr& responsews_sptr);
+      int getDataFiles(long long invId,ICat3::ns1__investigationInclude include,API::ITableWorkspace_sptr& responsews_sptr);
 
       /// this method calls Icat api getInvestigationIncludes and returns datasets for the given investigation id.
-      int doDataSetsSearch(long long invId,ICat3::ns1__investigationInclude inclide,API::ITableWorkspace_sptr& responsews_sptr);
+      int doDataSetsSearch(long long invId,ICat3::ns1__investigationInclude include,API::ITableWorkspace_sptr& responsews_sptr);
 
       /// This method lists the isntruments
       void  listInstruments(std::vector<std::string>& instruments);

diff --git a/Code/Mantid/Framework/ICat/src/ICat4/ICat4Catalog.cpp b/Code/Mantid/Framework/ICat/src/ICat4/ICat4Catalog.cpp
@@ -487,8 +487,8 @@ namespace Mantid
 
     /**
      * Saves result from "getDataFiles" to workspace.
-     * @param investigationId :: unique identifier of the investigation
-     * @param outputws        :: shared pointer to datasets
+     * @param response :: result response from the catalog.
+     * @param outputws :: shared pointer to datasets
      */
     void ICat4Catalog::saveDataFiles(std::vector<xsd__anyType*> response, API::ITableWorkspace_sptr& outputws)
     {
@@ -744,8 +744,7 @@ namespace Mantid
 
     /**
      * Convert a file size to human readable file format.
-     * @param size    :: The size in bytes of the file.
-     * @return string :: A human readable file format (e.g. 5MB).
+     * @param fileSize :: The size in bytes of the file.
      */
     std::string ICat4Catalog::bytesToString(int64_t &fileSize)
     {

diff --git a/Code/Mantid/Framework/Kernel/src/CatalogInfo.cpp b/Code/Mantid/Framework/Kernel/src/CatalogInfo.cpp
@@ -151,7 +151,8 @@ namespace Mantid
 
     /**
      * Obtain the attribute from a given element tag and attribute name.
-     * @param tagName :: The name of the tag to search for.
+     * @param element       :: The name of the element in the XML file.
+     * @param tagName       :: The name of the tag to search for.
      * @param attributeName :: The name of the attribute for the given tag.
      * @return The contents of the attribute from an XML element.
      */

diff --git a/Code/Mantid/MantidQt/MantidWidgets/inc/MantidQtMantidWidgets/ICatSearch2.h b/Code/Mantid/MantidQt/MantidWidgets/inc/MantidQtMantidWidgets/ICatSearch2.h
@@ -74,7 +74,7 @@ namespace MantidQt
       void loadSettings();
 
       ///////////////////////////////////////////////////////////////////////////////
-      /// Methods for: "Catalog Search"
+      // Methods for: "Catalog Search"
       ///////////////////////////////////////////////////////////////////////////////
 
       /// Ensures the correct text box is updated when the date is selected on the calendar.
@@ -131,7 +131,7 @@ namespace MantidQt
       void showDataFileInfo();
 
       ///////////////////////////////////////////////////////////////////////////////
-      /// SLOTS for: "Catalog Search"
+      // SLOTS for: "Catalog Search"
       ///////////////////////////////////////////////////////////////////////////////
 
       /// Open the DateTime Calendar to select date.