Merge pull request #591 from SaberUK/master+config-tweaks

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

diff --git a/include/listmode.h b/include/listmode.h
index ee2b4118dec5f0855d62c8d9e95ba7387cca0202..e27071eacbb75d30fd2d89de54f9b4da2d00719b 100644 (file)
--- a/include/listmode.h
+++ b/include/listmode.h
@@ -16,11 +16,12 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+
 #pragma once
 
 /** The base class for list modes, should be inherited.
  */
-class ListModeBase : public ModeHandler
+class CoreExport ListModeBase : public ModeHandler
 {
  public:
        /** An item in a listmode's list
@@ -105,7 +106,8 @@ class ListModeBase : public ModeHandler
 
  public:
        /** Constructor.
-        * @param Instance The creator of this class
+        * @param Creator The creator of this class
+        * @param Name Mode name
         * @param modechar Mode character
         * @param eolstr End of list string
         * @param lnum List numeric
@@ -143,14 +145,13 @@ class ListModeBase : public ModeHandler
        virtual void DisplayEmptyList(User* user, Channel* channel);
 
        /** Remove all instances of the mode from a channel.
-        * See mode.h
+        * Populates the given modestack with modes that remove every instance of
+        * this mode from the channel.
+        * See mode.h for more details.
         * @param channel The channel to remove all instances of the mode from
+        * @param stack The mode stack to add the mode change to
         */
-       virtual void RemoveMode(Channel* channel, irc::modestacker* stack);
-
-       /** Listmodes don't get set on users, no-op
-       */
-       virtual void RemoveMode(User*, irc::modestacker* stack);
+       virtual void RemoveMode(Channel* channel, irc::modestacker& stack);
 
        /** Perform a rehash of this mode's configuration data
         */
@@ -175,7 +176,7 @@ class ListModeBase : public ModeHandler
 
        /** Validate parameters.
         * Overridden by implementing module.
-        * @param source Source user adding the parameter
+        * @param user Source user adding the parameter
         * @param channel Channel the parameter is being added to
         * @param parameter The actual parameter being added
         * @return true if the parameter is valid