From 4e6e8246aea1460af91c13bab0111208ab51ff7f Mon Sep 17 00:00:00 2001
From: Dmitri Naumov <github@naumov.de>
Date: Thu, 20 Sep 2018 20:55:04 +0200
Subject: [PATCH] [BL] ConfigTree; Improve default return descr.
---
BaseLib/ConfigTree.h | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/BaseLib/ConfigTree.h b/BaseLib/ConfigTree.h
index 654a9a3c858..8853533affa 100644
--- a/BaseLib/ConfigTree.h
+++ b/BaseLib/ConfigTree.h
@@ -283,10 +283,12 @@ public:
template<typename T> T
getConfigParameter(std::string const& param) const;
- /*! Get parameter \c param of type \c T from the configuration tree or the \c default_value.
+ /*! Get parameter \c param of type \c T from the configuration tree or the
+ * \c default_value.
*
- * This method has a similar behaviour as getConfigParameter(std::string const&) except in case
- * of errors the \c default_value is returned.
+ * This method has a similar behaviour as getConfigParameter(std::string
+ * const&) except the \c default_value is returned if the attribute has not
+ * been found.
*
* \pre \c param must not have been read before from this ConfigTree.
*/
@@ -375,7 +377,8 @@ public:
* \c default_value.
*
* This method has a similar behaviour as getConfigAttribute(std::string
- * const&) except in case of errors the \c default_value is returned.
+ * const&) except the \c default_value is returned if the attribute has not
+ * been found.
*
* \return the requested attribute's value.
*
--
GitLab