From 99e2975737cdd9d976202880f3b32e41f1cb0388 Mon Sep 17 00:00:00 2001
From: Michael Reuter <reuterma@ornl.gov>
Date: Tue, 16 Nov 2010 16:27:40 +0000
Subject: [PATCH] Fixing doxygen errors. This refs #100.
---
.../Mantid/Kernel/inc/MantidKernel/BinaryFile.h | 3 +++
.../Kernel/inc/MantidKernel/DataService.h | 3 +--
.../Kernel/inc/MantidKernel/FacilityInfo.h | 4 ++--
Code/Mantid/Kernel/inc/MantidKernel/Logger.h | 3 +--
Code/Mantid/Kernel/src/ConfigService.cpp | 2 ++
Code/Mantid/Kernel/src/DirectoryValidator.cpp | 2 +-
Code/Mantid/Kernel/src/FacilityInfo.cpp | 2 ++
Code/Mantid/Kernel/src/FileValidator.cpp | 9 ++++++---
Code/Mantid/Kernel/src/LogParser.cpp | 7 ++++---
Code/Mantid/Kernel/src/Property.cpp | 17 +++++++++++++----
Code/Mantid/Kernel/src/TimeSplitter.cpp | 3 +++
11 files changed, 38 insertions(+), 17 deletions(-)
diff --git a/Code/Mantid/Kernel/inc/MantidKernel/BinaryFile.h b/Code/Mantid/Kernel/inc/MantidKernel/BinaryFile.h
index a4c720f04c4..5946529bca4 100644
--- a/Code/Mantid/Kernel/inc/MantidKernel/BinaryFile.h
+++ b/Code/Mantid/Kernel/inc/MantidKernel/BinaryFile.h
@@ -103,6 +103,7 @@ public:
//-----------------------------------------------------------------------------
/** Get the size of a file as a multiple of a particular data type
+ * @return the size of the file normalized to the data type
* @throw runtime_error if the file size is not compatible
* @throw runtime_error if the handle is not open.
* */
@@ -148,6 +149,7 @@ public:
//-----------------------------------------------------------------------------
/** Get a buffer size for loading blocks of data.
* @param num_items
+ * @return the buffer size
*/
size_t getBufferSize(const size_t num_items)
{
@@ -161,6 +163,7 @@ public:
/**
* Loads the entire contents of the file into a pointer to a std::vector.
* The file is closed once done.
+ * @return file contents in a vector
*/
std::vector<T> * loadAll()
{
diff --git a/Code/Mantid/Kernel/inc/MantidKernel/DataService.h b/Code/Mantid/Kernel/inc/MantidKernel/DataService.h
index 87d6ed86d87..299ef4f10bf 100644
--- a/Code/Mantid/Kernel/inc/MantidKernel/DataService.h
+++ b/Code/Mantid/Kernel/inc/MantidKernel/DataService.h
@@ -277,8 +277,7 @@ private:
/// Private, unimplemented copy assignment operator
DataService& operator=(const DataService&);
- /// DataService name. This is set only at construction.
- /// DataService name should be provided when construction of derived classes
+ /// DataService name. This is set only at construction. DataService name should be provided when construction of derived classes
std::string svc_name;
/// functor for the less binary function that compares strings alphabetically without taking account of case
diff --git a/Code/Mantid/Kernel/inc/MantidKernel/FacilityInfo.h b/Code/Mantid/Kernel/inc/MantidKernel/FacilityInfo.h
index cc3804327e8..5169dfc1157 100644
--- a/Code/Mantid/Kernel/inc/MantidKernel/FacilityInfo.h
+++ b/Code/Mantid/Kernel/inc/MantidKernel/FacilityInfo.h
@@ -85,8 +85,8 @@ private:
int m_zeroPadding; ///< default zero padding for this facility
std::vector<std::string> m_extensions; ///< file extensions in order of preference
std::set<std::string> m_archiveSearch; ///< names of the archive search interface
- std::vector<InstrumentInfo> m_instruments; ///< list of istruments of thsi facility
- std::string m_catalogName;
+ std::vector<InstrumentInfo> m_instruments; ///< list of instruments of this facility
+ std::string m_catalogName; ///< name of the catalog system of this facilty
static Logger& g_log; ///< logger
};
diff --git a/Code/Mantid/Kernel/inc/MantidKernel/Logger.h b/Code/Mantid/Kernel/inc/MantidKernel/Logger.h
index f3d3def9e00..d10efb970bb 100755
--- a/Code/Mantid/Kernel/inc/MantidKernel/Logger.h
+++ b/Code/Mantid/Kernel/inc/MantidKernel/Logger.h
@@ -156,8 +156,7 @@ class ThreadSafeLogStream;
/// Internal handle to third party logging objects
Poco::Logger* m_log;
- /// A Log stream to allow streaming operations. This pointer is owned by this class, initialized
- /// in the constructor and deleted in the destructor
+ /// A Log stream to allow streaming operations. This pointer is owned by this class, initialized in the constructor and deleted in the destructor
ThreadSafeLogStream* m_logStream;
/// Name of this logging object
std::string m_name;
diff --git a/Code/Mantid/Kernel/src/ConfigService.cpp b/Code/Mantid/Kernel/src/ConfigService.cpp
index f45e899ff61..f7a0c0be8ac 100644
--- a/Code/Mantid/Kernel/src/ConfigService.cpp
+++ b/Code/Mantid/Kernel/src/ConfigService.cpp
@@ -922,6 +922,7 @@ void ConfigServiceImpl::updateFacilities(const std::string& fName)
}
/** Get the default `
+ * @return the facility information object
*/
const FacilityInfo& ConfigServiceImpl::Facility() const
{
@@ -953,6 +954,7 @@ void ConfigServiceImpl::removeObserver(const Poco::AbstractObserver& observer)co
/**
* Get a facility
* @param fName Facility name
+ * @return the facility information object
* @throws NotFoundException if the facility is not found
*/
const FacilityInfo& ConfigServiceImpl::Facility(const std::string& fName) const
diff --git a/Code/Mantid/Kernel/src/DirectoryValidator.cpp b/Code/Mantid/Kernel/src/DirectoryValidator.cpp
index c3304f9a3f2..bae787114fa 100644
--- a/Code/Mantid/Kernel/src/DirectoryValidator.cpp
+++ b/Code/Mantid/Kernel/src/DirectoryValidator.cpp
@@ -22,7 +22,7 @@ namespace Mantid
namespace Kernel
{
-/// Initialize the logger
+// Initialize the logger
Logger& DirectoryValidator::g_log = Logger::get("DirectoryValidator");
/** Constructor
diff --git a/Code/Mantid/Kernel/src/FacilityInfo.cpp b/Code/Mantid/Kernel/src/FacilityInfo.cpp
index 0ffecf4d6e5..fde67918a37 100644
--- a/Code/Mantid/Kernel/src/FacilityInfo.cpp
+++ b/Code/Mantid/Kernel/src/FacilityInfo.cpp
@@ -139,6 +139,7 @@ void FacilityInfo::addExtension(const std::string& ext)
/**
* Returns instruments with given name
* @param iName Instrument name
+ * @return the instrument information object
* @throws NotFoundError if iName was not found
*/
const InstrumentInfo & FacilityInfo::Instrument(const std::string& iName)const
@@ -180,6 +181,7 @@ const InstrumentInfo & FacilityInfo::Instrument(const std::string& iName)const
/**
* Returns a list of instruments of given technique
* @param tech Technique name
+ * @return a list of instrument information objects
*/
std::vector<InstrumentInfo> FacilityInfo::Instruments(const std::string& tech)const
{
diff --git a/Code/Mantid/Kernel/src/FileValidator.cpp b/Code/Mantid/Kernel/src/FileValidator.cpp
index 436db8b541e..ee33c91b4a1 100644
--- a/Code/Mantid/Kernel/src/FileValidator.cpp
+++ b/Code/Mantid/Kernel/src/FileValidator.cpp
@@ -22,7 +22,7 @@ namespace Mantid
namespace Kernel
{
-/// Initialize the logger
+// Initialize the logger
Logger& FileValidator::g_log = Logger::get("FileValidator");
/// Default constructor.
@@ -112,8 +112,11 @@ bool has_ending(const std::string &value, const std::string & ending)
return (result == 0); // only care if it matches
}
-///Checks the extension of a filename
-///@param value the filename to check
+/**
+ * Checks the extension of a filename
+ * @param value the filename to check
+ * @return flag that true if the extension matches in the filename
+ */
bool FileValidator::endswith(const std::string &value) const
{
if (m_extensions.empty()) // automatically match a lack of extensions
diff --git a/Code/Mantid/Kernel/src/LogParser.cpp b/Code/Mantid/Kernel/src/LogParser.cpp
index f2d1d19e06f..8da906276a3 100644
--- a/Code/Mantid/Kernel/src/LogParser.cpp
+++ b/Code/Mantid/Kernel/src/LogParser.cpp
@@ -256,9 +256,10 @@ namespace Mantid
return 0;
}
- /** Ctreates a TimeSeriesProperty<bool> showing times when a particular period was active.
- * @param period The data period
- */
+ /** Creates a TimeSeriesProperty<bool> showing times when a particular period was active.
+ * @param period The data period
+ * @return times requested period was active
+ */
Kernel::Property* LogParser::createPeriodLog(int period)const
{
Kernel::TimeSeriesProperty<int>* periods = dynamic_cast< Kernel::TimeSeriesProperty<int>* >(m_periods.get());
diff --git a/Code/Mantid/Kernel/src/Property.cpp b/Code/Mantid/Kernel/src/Property.cpp
index 5dfd506c528..53ba9e3e98d 100644
--- a/Code/Mantid/Kernel/src/Property.cpp
+++ b/Code/Mantid/Kernel/src/Property.cpp
@@ -128,6 +128,7 @@ const PropertyHistory Property::createHistory() const
/** Return the size of this property.
* Single-Value properties return 1.
* TimeSeriesProperties return the # of entries.
+ * @return the size of the property
*/
int Property::size() const
{
@@ -135,9 +136,10 @@ int Property::size() const
}
//-------------------------------------------------------------------------------------------------
-/* Returns the units of the property, if any, as a string.
+/** Returns the units of the property, if any, as a string.
* Units are optional, and will return empty string if they have
* not been set before.
+ * @return the property's units
*/
std::string Property::units() const
{
@@ -145,7 +147,7 @@ std::string Property::units() const
}
//-------------------------------------------------------------------------------------------------
-/* Sets the units of the property, as a string. This is optional.
+/** Sets the units of the property, as a string. This is optional.
*
* @param unit string to set for the units.
*/
@@ -159,6 +161,8 @@ void Property::setUnits(std::string unit)
//-------------------------------------------------------------------------------------------------
/** Add to the property.
+ * @param rhs the property to get more information
+ * @return the augmented property
* @throw NotImplementedError always, since this should have been overridden
*/
Property& Property::operator+=( Property * rhs )
@@ -171,7 +175,10 @@ Property& Property::operator+=( Property * rhs )
//-------------------------------------------------------------------------------------------------
-/** Filter out a property by time. Will be overridden by TimeSeriesProperty (only) */
+/** Filter out a property by time. Will be overridden by TimeSeriesProperty (only)
+ * @param start the beginning time to filter from
+ * @param stop the ending time to filter to
+ * */
void Property::filterByTime(const Kernel::dateAndTime start, const Kernel::dateAndTime stop)
{
(void) start; //Avoid compiler warning
@@ -184,7 +191,9 @@ void Property::filterByTime(const Kernel::dateAndTime start, const Kernel::dateA
//-----------------------------------------------------------------------------------------------
/** Split a property by time. Will be overridden by TimeSeriesProperty (only)
* For any other property type, this does nothing.
- * */
+ * @param splitter time splitter
+ * @param outputs holder for splitter output
+ */
void Property::splitByTime(TimeSplitterType& splitter, std::vector< Property * > outputs) const
{
(void) splitter; //Avoid compiler warning
diff --git a/Code/Mantid/Kernel/src/TimeSplitter.cpp b/Code/Mantid/Kernel/src/TimeSplitter.cpp
index 212e8000348..a7905cce860 100644
--- a/Code/Mantid/Kernel/src/TimeSplitter.cpp
+++ b/Code/Mantid/Kernel/src/TimeSplitter.cpp
@@ -91,6 +91,7 @@ SplittingInterval SplittingInterval::operator &(const SplittingInterval& b) cons
return out;
}
+/// Or operator. Return the largest time interval.
SplittingInterval SplittingInterval::operator |(const SplittingInterval& b) const
{
SplittingInterval out(*this);
@@ -171,6 +172,7 @@ TimeSplitterType operator +(const TimeSplitterType& a, const TimeSplitterType& b
*
* @param a TimeSplitterType filter or Splitter.
* @param b TimeSplitterType filter.
+ * @return the ANDed filter
*/
TimeSplitterType operator &(const TimeSplitterType& a, const TimeSplitterType& b)
{
@@ -239,6 +241,7 @@ TimeSplitterType removeFilterOverlap(const TimeSplitterType &a)
*
* @param a TimeSplitterType filter.
* @param b TimeSplitterType filter.
+ * @return the ORed filter
*/
TimeSplitterType operator |(const TimeSplitterType& a, const TimeSplitterType& b)
{
--
GitLab