ouch/inspircd
2
0
Fork 0
mirror of https://github.com/inspircd/inspircd.git synced 2025-03-10 02:59:01 -04:00
Code Issues Packages Projects Releases Wiki Activity

Document ServerConfig::Conf{Tags,Value} better.

Browse Source
This commit is contained in:
Peter Powell 2018-10-01 16:09:45 +01:00
parent 84ed051be7
commit 680ecdae0c
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
include/configreader.h
View 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. */