summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Powell <petpow@saberuk.com>2018-10-01 16:09:45 +0100
committerPeter Powell <petpow@saberuk.com>2018-10-01 17:26:21 +0100
commit680ecdae0c204045d64816a1694fe7481dc382c1 (patch)
treecb4ceff17e047689235894f386b2a7998b526477
parent84ed051be7344e97784b94018622c7d7d4d44023 (diff)
Document ServerConfig::Conf{Tags,Value} better.
-rw-r--r--include/configreader.h9
1 files changed, 7 insertions, 2 deletions
diff --git a/include/configreader.h b/include/configreader.h
index 4cb051eff..afe05ccf3 100644
--- a/include/configreader.h
+++ b/include/configreader.h
@@ -256,11 +256,16 @@ class CoreExport ServerConfig
*/
typedef insp::flat_map<std::string, reference<OperInfo> > OperIndex;
- /** Get a configuration tag
- * @param tag The name of the tag to get
+ /** Get a configuration tag by name. If one or more tags are present then the first is returned.
+ * @param tag The name of the tag to get.
+ * @returns Either a tag from the config or EmptyTag.
*/
ConfigTag* ConfValue(const std::string& tag);
+ /** Get a list of configuration tags by name.
+ * @param tag The name of the tags to get.
+ * @returns Either a list of tags from the config or an empty ConfigTagList.
+ */
ConfigTagList ConfTags(const std::string& tag);
/** An empty configuration tag. */