]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/protocol.h
Document SendMode.
[user/henk/code/inspircd.git] / include / protocol.h
index f78d52928299067d6280ae775b513aefac78e8e3..b6568e313aa17e98d96c3f6b10b32af8eada4208 100644 (file)
@@ -58,13 +58,22 @@ class ProtocolInterface : public Extensible
         */
        virtual void SendMetaData(void* target, int type, const std::string &key, const std::string &data) { }
 
+       /** Send a topic change for a channel
+        * @param channel The channel to change the topic for.
+        * @param topic The new topic to use for the channel.
+        */
        virtual void SendTopic(Channel* channel, std::string &topic) { }
 
+       /** Send mode changes for an object.
+        * @param target The channel name or user to send mode changes for.
+        * @param The mode changes to send.
+        */
        virtual void SendMode(const std::string &target, parameterlist &modedata) { }
 
+       /** Convenience function, string wrapper around the above.
+         */
        virtual void SendModeStr(const std::string &target, const std::string &modeline)
        {
-               /* Convenience function */
                irc::spacesepstream x(modeline);
                parameterlist n;
                std::string v;