From 22f7d47c2cbb3cf3f6cd6fa69cf061b80158b398 Mon Sep 17 00:00:00 2001
From: Jens Georg <jens.georg@desy.de>
Date: Tue, 26 Feb 2019 17:00:06 +0100
Subject: [PATCH] Minor doxygen fixes for ConfigReader
---
Modules/include/ConfigReader.h | 16 +++++++++++-----
1 file changed, 11 insertions(+), 5 deletions(-)
diff --git a/Modules/include/ConfigReader.h b/Modules/include/ConfigReader.h
index c32961fe..05f8038c 100644
--- a/Modules/include/ConfigReader.h
+++ b/Modules/include/ConfigReader.h
@@ -14,14 +14,20 @@ namespace ChimeraTK {
struct FunctorSetValues;
struct FunctorSetValuesArray;
- /**
- * Generic module to read an XML config file and provide the defined values as
- constant variables. The config file
- * should look like this:
+ /** Generic module to read an XML config file and provide the defined values as
+ * constant variables. The config file should look like this:
* \code{.xml}
<configuration>
<variable name="variableName" type="int32" value="42"/>
<variable name="anotherVariable" type="string" value="Hello world!"/>
+ <variable name="someArray" type="string">
+ <value i="0" v="StringEntry1" />
+ <value i="1" v="StringEntry2" />
+ <value i="2" v="StringEntry3" />
+ <value i="3" v="StringEntry4" />
+ <value i="4" v="StringEntry5" />
+ <value i="5" v="StringEntry6" />
+ </variable>
</configuration>
\endcode
*
@@ -32,7 +38,7 @@ namespace ChimeraTK {
* blocking read operation on the receivers will block forever.
*
* Configuration values can already be accessed during the
- Application::defineConnection() function by using the
+ Application::defineConnections() function by using the
* ConfigReader::get() function.
*/
struct ConfigReader : ApplicationModule {
--
GitLab