Merge pull request #1142 from SaberUK/master+fixes

[user/henk/code/inspircd.git] / include / isupportmanager.h

diff --git a/include/isupportmanager.h b/include/isupportmanager.h
index 3915b8b1b580961a1aac311e6fb0e648b47d291c..1f41de5d2ed64581f3f84ff49fb0b6e1504488b9 100644 (file)
--- 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);
 };