about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
authorAlexander Barton <alex@barton.de>2010-12-29 14:10:18 +0100
committerAlexander Barton <alex@barton.de>2011-02-13 17:52:39 +0100
commit07f241ff6d3afee88d6c6b3e2ed1e195c0367c91 (patch)
treea65e6a2e1a8c8afc28d72fdfcd6146a6f284710d /src
parent53fecf5a2b3e0f396b08b2a00a73eb73c46e1853 (diff)
downloadngircd-07f241ff6d3afee88d6c6b3e2ed1e195c0367c91.tar.gz
ngircd-07f241ff6d3afee88d6c6b3e2ed1e195c0367c91.zip
Enhance documentation for the WEBIRC command
Diffstat (limited to 'src')
-rw-r--r--src/ngircd/irc-login.c10
1 files changed, 8 insertions, 2 deletions
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)