From 4d10e1c3d1716e0330a4bcbd74ac0476a8f4b67a Mon Sep 17 00:00:00 2001
From: Christoph Lehmann <christoph.lehmann@ufz.de>
Date: Sun, 24 Jan 2016 14:14:25 +0100
Subject: [PATCH] [BL] added ConfigTree doc groups
---
BaseLib/ConfigTreeNew.h | 36 ++++++++++++++++++++++++++++++++++++
1 file changed, 36 insertions(+)
diff --git a/BaseLib/ConfigTreeNew.h b/BaseLib/ConfigTreeNew.h
index aaf6d7f8d05..36426c669ba 100644
--- a/BaseLib/ConfigTreeNew.h
+++ b/BaseLib/ConfigTreeNew.h
@@ -213,6 +213,11 @@ public:
//! used anymore!
ConfigTreeNew& operator=(ConfigTreeNew &&);
+ /*! \name Methods for directly accessing parameter values
+ *
+ */
+ //!\{
+
/*! Get parameter \c param of type \c T from the configuration tree.
*
* \return the value looked for or a default constructed value \c T() in the case of
@@ -254,6 +259,13 @@ public:
template<typename T> Range<ValueIterator<T> >
getConfParamList(std::string const& param) const;
+ //!\}
+
+ /*! \name Methods for accessing parameters that have attributes
+ *
+ */
+ //!\{
+
//! TODO doc
ConfigTreeNew
getConfParam(std::string const& param) const;
@@ -274,6 +286,14 @@ public:
template<typename T> T
getConfAttribute(std::string const& attr) const;
+ //!\}
+
+ /*! \name Methods for peeking and checking parameters
+ *
+ * To be used in builder/factory functions
+ */
+ //!\{
+
/*! Peek at a parameter \c param of type \c T from the configuration tree.
*
* This method is an exception to the single-read rule. It is meant to be used to
@@ -295,6 +315,13 @@ public:
template<typename Ch> void
checkConfParam(std::string const& param, Ch const* value) const;
+ //!\}
+
+ /*! \name Methods for accessing subtrees
+ *
+ */
+ //!\{
+
/*! Get the subtree rooted at \c root
*
* If \c root is not found error() is called.
@@ -320,6 +347,13 @@ public:
Range<SubtreeIterator>
getConfSubtreeList(std::string const& root) const;
+ //!\}
+
+ /*! \name Methods for ignoring parameters
+ *
+ */
+ //!\{
+
/*! Tell this instance to ignore parameter \c param.
*
* This method is used to avoid warning messages.
@@ -336,6 +370,8 @@ public:
*/
void ignoreConfParamAll(std::string const& param) const;
+ //!\}
+
//! The destructor performs the check if all nodes at the current level of the tree
//! have been read.
~ConfigTreeNew();
--
GitLab