commit e8f512bfe70a6c620e09aa221fb7058dc2c6687e
from: Alexander Barton <alex@barton.de>
date: Sun Feb 24 17:50:12 2013 UTC

irc-op.c: Update source code documentation

commit - bb31d7b88cd11ceec65aed08a99ac9a2270ce3ef
commit + e8f512bfe70a6c620e09aa221fb7058dc2c6687e
blob - 5c12faf78022ac8929d239029a4e7d2e8ff2fe47
blob + 0297015a8758e9075b608a95e17502fe6e391540
--- src/ngircd/irc-op.c
+++ src/ngircd/irc-op.c
@@ -1,6 +1,6 @@
 /*
  * ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001-2005 by Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2013 Alexander Barton (alex@barton.de) and Contributors.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -33,6 +33,7 @@
 #include "exp.h"
 #include "irc-op.h"
 
+/* Local functions */
 
 static bool
 try_kick(CLIENT *peer, CLIENT* from, const char *nick, const char *channel,
@@ -47,7 +48,15 @@ try_kick(CLIENT *peer, CLIENT* from, const char *nick,
 	return true;
 }
 
+/* Global functions */
 
+/**
+ * Handler for the IRC command "KICK".
+ *
+ * @param Client The client from which this command has been received.
+ * @param Req Request structure with prefix and all parameters.
+ * @return CONNECTED or DISCONNECTED.
+ */
 GLOBAL bool
 IRC_KICK(CLIENT *Client, REQUEST *Req)
 {
@@ -128,7 +137,13 @@ IRC_KICK(CLIENT *Client, REQUEST *Req)
 	return true;
 } /* IRC_KICK */
 
-
+/**
+ * Handler for the IRC command "INVITE".
+ *
+ * @param Client The client from which this command has been received.
+ * @param Req Request structure with prefix and all parameters.
+ * @return CONNECTED or DISCONNECTED.
+ */
 GLOBAL bool
 IRC_INVITE(CLIENT *Client, REQUEST *Req)
 {
@@ -197,9 +212,9 @@ IRC_INVITE(CLIENT *Client, REQUEST *Req)
 		}
 	}
 
-	LogDebug("User \"%s\" invites \"%s\" to \"%s\" ...", Client_Mask(from), Req->argv[0], Req->argv[1]);
+	LogDebug("User \"%s\" invites \"%s\" to \"%s\" ...", Client_Mask(from),
+		 Req->argv[0], Req->argv[1]);
 
-
 	/*
 	 * RFC 2812 says:
 	 * 'There is no requirement that the channel [..] must exist or be a valid channel'
@@ -226,5 +241,4 @@ IRC_INVITE(CLIENT *Client, REQUEST *Req)
 	return CONNECTED;
 } /* IRC_INVITE */
 
-
 /* -eof- */