From 4d03a38661cb7fa6a0880b66bbebf1d892ba5013 Mon Sep 17 00:00:00 2001
From: w00t <w00t@e03df62e-2008-0410-955e-edbf42e46eb7>
Date: Sat, 25 Oct 2008 12:59:13 +0000
Subject: Document SendMode.

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@10708 e03df62e-2008-0410-955e-edbf42e46eb7
---
 include/protocol.h | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'include')

diff --git a/include/protocol.h b/include/protocol.h
index 4d87f8a2c..b6568e313 100644
--- 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;
-- 
cgit v1.2.3