Document SendTopic.

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

diff --git a/include/protocol.h b/include/protocol.h
index f78d52928299067d6280ae775b513aefac78e8e3..4d87f8a2cd382315a936ac9730d3806b4427d795 100644 (file)
--- a/include/protocol.h
+++ b/include/protocol.h
@@ -58,6 +58,10 @@ 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) { }
 
        virtual void SendMode(const std::string &target, parameterlist &modedata) { }