From 8baf2486085fd4da972e69fd806848d406633456 Mon Sep 17 00:00:00 2001
From: Nina Dzugasova <dzugasova.nina@gmail.com>
Date: Fri, 30 Nov 2018 16:01:42 +0100
Subject: [PATCH] Modified the ParameterContainer documentation.
---
src/TNL/Config/ParameterContainer.h | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/src/TNL/Config/ParameterContainer.h b/src/TNL/Config/ParameterContainer.h
index f524d29176..b475c53ec1 100644
--- a/src/TNL/Config/ParameterContainer.h
+++ b/src/TNL/Config/ParameterContainer.h
@@ -82,6 +82,17 @@ class ParameterContainer
bool setParameter( const String& name,
const String& value );
+ /**
+ * \brief Checks whether the parameter \e name is given the \e value.
+ *
+ * Returns \e true if the parameter \e name is given the \e value.
+ * If the parameter does not have any value or has different value then the given
+ * \e value the method returns \e false and shows message when \e verbose is \e true.
+ *
+ * @param name Name of parameter.
+ * @param value Value of type T we want to check whether is assigned to the parameter.
+ * @param verbose Boolean value defining whether to show error message (when true) or not (when false).
+ */
template< class T > bool getParameter( const String& name,
T& value,
bool verbose = true ) const
--
GitLab