Enhance documentation for the WEBIRC command

[ngircd-alex.git] / src / ngircd / irc-login.c

diff --git a/src/ngircd/irc-login.c b/src/ngircd/irc-login.c
index 1557f1845fe8e3657949f45e1c386062cdaa7661..6a97074aa94491b067ca2369845ec5f36fefdd9c 100644 (file)
--- 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)