From de1d1463c02d270c8f4f870f3c9f8ed00cb689b7 Mon Sep 17 00:00:00 2001
From: Christoph Lehmann <christoph.lehmann@ufz.de>
Date: Sun, 24 Jan 2016 17:24:59 +0100
Subject: [PATCH] [BL] configTreeNew docu added
---
BaseLib/ConfigTreeNew.h | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/BaseLib/ConfigTreeNew.h b/BaseLib/ConfigTreeNew.h
index 04d0d136af2..98edbcba98e 100644
--- a/BaseLib/ConfigTreeNew.h
+++ b/BaseLib/ConfigTreeNew.h
@@ -200,6 +200,7 @@ public:
* Creates a new instance wrapping the given Boost Property Tree.
*
* \param tree the Boost Property Tree to be wrapped
+ * \param filename the file from which the \c tree has been read
* \param error_cb callback function to be called on error.
* \param warning_cb callback function to be called on warning.
*
@@ -278,8 +279,12 @@ public:
/*! \name Methods for accessing parameters that have attributes
*
* The <tt>getConfParam...()</tt> methods in this group---note: they do not have template
- * parameters---check that the queried parameters do not have any children (apart from XML attributes).
- * If they do, error() is called.
+ * parameters---check that the queried parameters do not have any children (apart from XML
+ * attributes); if they do, error() is called.
+ *
+ * The support for parameters with attributes is limited in the sense that there are no
+ * <tt>get...List()</tt> methods in this group and that it is not possible to explicitly
+ * ignore attibutes. However, such functionality can easily be added on demand.
*/
//!\{
--
GitLab