From 680ecdae0c204045d64816a1694fe7481dc382c1 Mon Sep 17 00:00:00 2001 From: Peter Powell Date: Mon, 1 Oct 2018 16:09:45 +0100 Subject: Document ServerConfig::Conf{Tags,Value} better. --- include/configreader.h | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'include') 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 > 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. */ -- cgit v1.2.3