From bbdfdeeb82dd1ddefc632eab890572c659e4a702 Mon Sep 17 00:00:00 2001
From: Michael Reuter <reuterma@ornl.gov>
Date: Fri, 20 Aug 2010 21:25:16 +0000
Subject: [PATCH] Fixing more doxygen errors. This refs #100.
---
Code/Mantid/Kernel/inc/MantidKernel/BinaryFile.h | 5 +++--
Code/Mantid/Kernel/src/ConfigService.cpp | 2 +-
2 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/Code/Mantid/Kernel/inc/MantidKernel/BinaryFile.h b/Code/Mantid/Kernel/inc/MantidKernel/BinaryFile.h
index b59746d4624..1e8be8c58ca 100644
--- a/Code/Mantid/Kernel/inc/MantidKernel/BinaryFile.h
+++ b/Code/Mantid/Kernel/inc/MantidKernel/BinaryFile.h
@@ -189,6 +189,7 @@ public:
/**
* Loads the entire contents of the file into a std::vector.
* The file is closed once done.
+ * @param data The contents to load into the file
*/
void loadAllInto(std::vector<T> &data)
{
@@ -225,7 +226,7 @@ public:
* @param block_size: how many elements to load in the block. If there are not enough elements,
* the vector returned is smaller than block_size
* @param buffer: array of block_size[] of T; must have been allocated before.
- * @retrun loaded_size, actually how many elements were loaded.
+ * @return loaded_size, actually how many elements were loaded.
*/
size_t loadBlock(T * buffer, size_t block_size)
{
@@ -244,7 +245,7 @@ public:
private:
/// File stream
std::ifstream * handle;
- //Size of each object.
+ /// Size of each object.
size_t obj_size;
/// Number of elements of size T in the file
size_t num_elements;
diff --git a/Code/Mantid/Kernel/src/ConfigService.cpp b/Code/Mantid/Kernel/src/ConfigService.cpp
index 9d53b2c7c94..0803a368538 100644
--- a/Code/Mantid/Kernel/src/ConfigService.cpp
+++ b/Code/Mantid/Kernel/src/ConfigService.cpp
@@ -879,7 +879,7 @@ const std::vector<std::string>& ConfigServiceImpl::getInstrumentPrefixes(const s
/**
* Return the filename of the instrument geometry definition file.
- * @param instrument A string giving the instrument name
+ * @param instrumentName A string giving the instrument name
* @returns A string containing the full qualified filename of the instrument file.
*/
const std::string ConfigServiceImpl::getInstrumentFilename(const std::string& instrumentName) const
--
GitLab