From: w00t <w00t@e03df62e-2008-0410-955e-edbf42e46eb7>
Date: Sat, 25 Oct 2008 12:59:13 +0000 (+0000)
Subject: Document SendTopic.
X-Git-Tag: v2.0.23~2401
X-Git-Url: https://git.netwichtig.de/gitweb/?a=commitdiff_plain;h=b76777dfb4d2eea9d7b223d0eb6acdd560cc1858;p=user%2Fhenk%2Fcode%2Finspircd.git

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 f78d52928..4d87f8a2c 100644
--- 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) { }