Remove the Kiwi links from the readme.

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

diff --git a/include/isupportmanager.h b/include/isupportmanager.h
index 3915b8b1b580961a1aac311e6fb0e648b47d291c..75b83d6c16c10d931d1e7c0a76add03c8ab75206 100644 (file)
--- a/include/isupportmanager.h
+++ b/include/isupportmanager.h
@@ -1,7 +1,8 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
- *   Copyright (C) 2013 Peter Powell <petpow@saberuk.com>
+ *   Copyright (C) 2017 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2014, 2016 Attila Molnar <attilamolnar@hush.com>
  *
  * This file is part of InspIRCd.  InspIRCd is free software: you can
  * redistribute it and/or modify it under the terms of the GNU General Public
@@ -24,15 +25,28 @@ class CoreExport ISupportManager
 {
  private:
        /** The generated lines which are sent to clients. */
-       std::vector<std::string> cachedlines;
+       std::vector<Numeric::Numeric> cachedlines;
+
+       /** Escapes an ISUPPORT token value and appends it to the buffer.
+        * @param buffer The buffer to append to.
+        * @param value An ISUPPORT token value.
+        */
+       void AppendValue(std::string& buffer, const std::string& value);
 
  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() const { return cachedlines; }
+       /** 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);
 };