From 1f81bc0083ebbfdf795cfb910ae087d6da49b6d5 Mon Sep 17 00:00:00 2001
From: David Fairbrother <DavidFair@users.noreply.github.com>
Date: Mon, 6 Mar 2017 17:30:15 +0000
Subject: [PATCH] Re #19062 Added doxygen comment to function
---
Framework/DataHandling/src/LoadNexusLogs.cpp | 14 +++++++++++++-
1 file changed, 13 insertions(+), 1 deletion(-)
diff --git a/Framework/DataHandling/src/LoadNexusLogs.cpp b/Framework/DataHandling/src/LoadNexusLogs.cpp
index 56dd1188b4b..44d8e1a1bdf 100644
--- a/Framework/DataHandling/src/LoadNexusLogs.cpp
+++ b/Framework/DataHandling/src/LoadNexusLogs.cpp
@@ -656,9 +656,21 @@ LoadNexusLogs::createTimeSeries(::NeXus::File &file,
}
}
+/**
+ * Checks whether the specified character is invalid or a control
+ * character. If it is invalid (i.e. negative) or a control character
+ * the method returns true. If it is valid and not a control character
+ * it returns false. Additionally if the character is invalid is
+ * logs a warning with the property name so users are aware.
+ *
+ * @param c :: Character to check
+ * @param propName :: The name of the property currently being checked for
+ *logging
+ * @param log :: Reference to logger to print out to
+ * @return :: True if control character OR invalid. Else False
+ */
bool LoadNexusLogs::isControlValue(const char &c, const std::string &propName,
Kernel::Logger &log) {
-
// Have to check it falls within range accepted by c style check
if (c <= -1) {
log.warning("Found an invalid character in property " + propName);
--
GitLab