summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorAttila Molnar <attilamolnar@hush.com>2014-07-14 16:47:42 +0200
committerAttila Molnar <attilamolnar@hush.com>2014-07-14 16:47:42 +0200
commit6f5f399257df7ebe9745321e2218b2510ccee057 (patch)
treefb70de349489d157cf73ca448c0e3b1a0687401a /include
parente7bdcd71dce911f64d8f0c85f4935dfa83a81dd3 (diff)
Expand ISupportManager documentation
Diffstat (limited to 'include')
-rw-r--r--include/isupportmanager.h13
1 files changed, 10 insertions, 3 deletions
diff --git a/include/isupportmanager.h b/include/isupportmanager.h
index 3915b8b1b..1f41de5d2 100644
--- a/include/isupportmanager.h
+++ b/include/isupportmanager.h
@@ -27,12 +27,19 @@ class CoreExport ISupportManager
std::vector<std::string> cachedlines;
public:
- /** (Re)build the ISUPPORT vector. */
+ /** (Re)build the ISUPPORT vector.
+ * Called by the core on boot after all modules have been loaded, and every time when a module is loaded
+ * or unloaded. Calls the On005Numeric hook, letting modules manipulate the ISUPPORT tokens.
+ */
void Build();
- /** Returns the std::vector of ISUPPORT lines. */
+ /** Returns the cached std::vector of ISUPPORT lines.
+ * @return A list of strings prepared for sending to users
+ */
const std::vector<std::string>& GetLines() const { return cachedlines; }
- /** Send the 005 numerics (ISUPPORT) to a user. */
+ /** Send the 005 numerics (ISUPPORT) to a user.
+ * @param user The user to send the ISUPPORT numerics to
+ */
void SendTo(LocalUser* user);
};