]> git.netwichtig.de Git - user/henk/code/inspircd.git/commitdiff
Document ServerConfig::Conf{Tags,Value} better.
authorPeter Powell <petpow@saberuk.com>
Mon, 1 Oct 2018 15:09:45 +0000 (16:09 +0100)
committerPeter Powell <petpow@saberuk.com>
Mon, 1 Oct 2018 16:26:21 +0000 (17:26 +0100)
include/configreader.h

index 4cb051efff3d1e9f27928627306f55e19e713ec0..afe05ccf33cf6003153ae8c5ffd5cf36bf737bcb 100644 (file)
@@ -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. */