mirrors/ngircd
1
0
Fork 0
mirror of https://github.com/osmarks/ngircd.git synced 2024-10-28 04:46:17 +00:00
Code Issues Releases Wiki Activity

irc-op.c: Update source code documentation

Browse Source
This commit is contained in:
Alexander Barton 2013-02-24 18:50:12 +01:00
parent bb31d7b88c
commit e8f512bfe7
1 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/ngircd/irc-op.c
View File

@ -1,6 +1,6 @@
/* /*
* ngIRCd -- The Next Generation IRC Daemon * 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 * 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 * it under the terms of the GNU General Public License as published by
@ -33,6 +33,7 @@
#include "exp.h" #include "exp.h"
#include "irc-op.h" #include "irc-op.h"
/* Local functions */
static bool static bool
try_kick(CLIENT *peer, CLIENT* from, const char *nick, const char *channel, 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, const char *channel,
return true; 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 GLOBAL bool
IRC_KICK(CLIENT *Client, REQUEST *Req) IRC_KICK(CLIENT *Client, REQUEST *Req)
{ {
@ -128,7 +137,13 @@ IRC_KICK(CLIENT *Client, REQUEST *Req)
return true; return true;
} /* IRC_KICK */ } /* 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 GLOBAL bool
IRC_INVITE(CLIENT *Client, REQUEST *Req) IRC_INVITE(CLIENT *Client, REQUEST *Req)
{ {
@ -197,8 +212,8 @@ 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: * RFC 2812 says:
@ -226,5 +241,4 @@ IRC_INVITE(CLIENT *Client, REQUEST *Req)
return CONNECTED; return CONNECTED;
} /* IRC_INVITE */ } /* IRC_INVITE */
/* -eof- */ /* -eof- */