Added comments

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2465 e03df62e-2008-0410-955e-edbf42e46eb7

diff --git a/include/cull_list.h b/include/cull_list.h
index 113a0cd619c63e4fd561cea43d675639ca939856..67ffcaf967254614af8b6dbfdee223ca37b4b953 100644 (file)
--- a/include/cull_list.h
+++ b/include/cull_list.h
@@ -28,26 +28,83 @@
 #include "users.h"
 #include "channels.h"
 
+/** The CullItem class holds a user and their quitmessage,
+ * and is used internally by the CullList class to compile
+ * a list of users which are to be culled when a long
+ * operation (such as a netsplit) has completed.
+ */
 class CullItem
 {
  private:
+       /** Holds a pointer to the user,
+        * must be valid and can be a local or remote user.
+        */
         userrec* user;
+       /** Holds the quit reason to use for this user.
+        */
         std::string reason;
  public:
+       /** Constrcutor.
+        * Initializes the CullItem with a user pointer
+        * and their quit reason
+        * @param u The user to add
+        * @param r The quit reason of the added user
+        */
         CullItem(userrec* u, std::string r);
+       /** Returns a pointer to the user
+        */
         userrec* GetUser();
+       /** Returns the user's quit reason
+        */
         std::string GetReason();
 };
 
-
+/** The CullList class can be used by modules, and is used
+ * by the core, to compile large lists of users in preperation
+ * to quitting them all at once. This is faster than quitting
+ * them within the loop, as the loops become tighter with
+ * little or no comparisons within them. The CullList class
+ * operates by allowing the programmer to push users onto
+ * the list, each with a seperate quit reason, and then, once
+ * the list is complete, call a method to flush the list,
+ * quitting all the users upon it. A CullList may hold local
+ * or remote users, but it may only hold each user once. If
+ * you attempt to add the same user twice, then the second
+ * attempt will be ignored.
+ */
 class CullList
 {
  private:
+        /** Holds a list of users being quit.
+         * See the information for CullItem for
+         * more information.
+         */
          std::vector<CullItem> list;
+        /** A list of users who have already been
+         * placed on the list, as a map for fast
+         * reference.
+         */
         std::map<userrec*,int> exempt;
  public:
+        /** Constructor.
+         * Clears the CullList::list and CullList::exempt
+         * items.
+         */
          CullList();
+        /** Adds a user to the cull list for later
+         * removal via QUIT.
+         * @param user The user to add
+         * @param reason The quit reason of the user being added
+         */
          void AddItem(userrec* user, std::string reason);
+        /** Applies the cull list, quitting all the users
+         * on the list with their quit reasons all at once.
+         * This is a very fast operation compared to
+         * iterating the user list and comparing each one,
+         * especially if there are multiple comparisons
+         * to be done, or recursion.
+         * @returns The number of users removed from IRC.
+         */
          int Apply();
 };