Document SendMode.

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

diff --git a/include/protocol.h b/include/protocol.h
index 4d87f8a2cd382315a936ac9730d3806b4427d795..b6568e313aa17e98d96c3f6b10b32af8eada4208 100644 (file)
--- a/include/protocol.h
+++ b/include/protocol.h
@@ -64,11 +64,16 @@ class ProtocolInterface : public Extensible
         */
        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;