Merge the latest changes from insp20 into master.

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

diff --git a/include/isupportmanager.h b/include/isupportmanager.h
index c62cd1ae30db1ca5b23ad8cfa09a5314967f47e2..3a0df78f940f698c8bd58c799465831e2464aa10 100644 (file)
--- a/include/isupportmanager.h
+++ b/include/isupportmanager.h
@@ -24,18 +24,22 @@ class CoreExport ISupportManager
 {
  private:
        /** The generated lines which are sent to clients. */
-       std::vector<std::string> Lines;
+       std::vector<Numeric::Numeric> 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. */
-       const std::vector<std::string>& GetLines()
-       {
-               return this->Lines;
-       }
+       /** Returns the cached std::vector of ISUPPORT lines.
+        * @return A list of Numeric::Numeric objects prepared for sending to users
+        */
+       const std::vector<Numeric::Numeric>& 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);
 };