From 07f241ff6d3afee88d6c6b3e2ed1e195c0367c91 Mon Sep 17 00:00:00 2001
From: Alexander Barton <alex@barton.de>
Date: Wed, 29 Dec 2010 14:10:18 +0100
Subject: Enhance documentation for the WEBIRC command

---
 src/ngircd/irc-login.c | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

(limited to 'src')

diff --git a/src/ngircd/irc-login.c b/src/ngircd/irc-login.c
index 1557f184..6a97074a 100644
--- a/src/ngircd/irc-login.c
+++ b/src/ngircd/irc-login.c
@@ -596,8 +596,14 @@ IRC_SERVICE(CLIENT *Client, REQUEST *Req)
 
 
 /**
- * Handler for the IRC command "WEBIRC".
- * Syntax: WEBIRC <password> <username> <real-hostname> <real-IP-address>
+ * Handler for the IRC "WEBIRC" command.
+ *
+ * See doc/Protocol.txt, section II.4:
+ * "Update webchat/proxy client information".
+ *
+ * @param Client	The client from which this command has been received.
+ * @param Req		Request structure with prefix and all parameters.
+ * @returns		CONNECTED or DISCONNECTED.
  */
 GLOBAL bool
 IRC_WEBIRC(CLIENT *Client, REQUEST *Req)
-- 
cgit 1.4.1