Committer : entrope
CVSROOT : /cvsroot/undernet-ircu
Module : ircu2.10
Commit time: 2004-10-05 02:39:48 UTC
Modified files:
include/ircd_reply.h ircd/ircd_reply.c
Log message:
Doxyfy ircd_reply.h and ircd_reply.c.
---------------------- diff included ----------------------
Index: ircu2.10/include/ircd_reply.h
diff -u ircu2.10/include/ircd_reply.h:1.7 ircu2.10/include/ircd_reply.h:1.8
--- ircu2.10/include/ircd_reply.h:1.7 Sat Apr 14 23:58:56 2001
+++ ircu2.10/include/ircd_reply.h Mon Oct 4 19:39:38 2004
@@ -16,8 +16,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: ircd_reply.h,v 1.7 2001/04/15 06:58:56 isomer Exp $
+ */
+/** @file
+ * @brief Interfaces for sending common replies to users.
+ * @version $Id: ircd_reply.h,v 1.8 2004/10/05 02:39:38 entrope Exp $
*/
#ifndef INCLUDED_ircd_reply_h
#define INCLUDED_ircd_reply_h
@@ -26,10 +28,9 @@
extern int protocol_violation(struct Client* cptr, const char* pattern, ...);
extern int need_more_params(struct Client* cptr, const char* cmd);
-extern int send_error_to_client(struct Client* cptr, int error, ...);
extern int send_reply(struct Client* to, int reply, ...);
-#define SND_EXPLICIT 0x40000000 /* first arg is a pattern to use */
+#define SND_EXPLICIT 0x40000000 /**< first arg is a pattern to use */
#endif /* INCLUDED_ircd_reply_h */
Index: ircu2.10/ircd/ircd_reply.c
diff -u ircu2.10/ircd/ircd_reply.c:1.20 ircu2.10/ircd/ircd_reply.c:1.21
--- ircu2.10/ircd/ircd_reply.c:1.20 Wed Feb 13 16:20:42 2002
+++ ircu2.10/ircd/ircd_reply.c Mon Oct 4 19:39:38 2004
@@ -19,8 +19,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: ircd_reply.c,v 1.20 2002/02/14 00:20:42 ghostwolf Exp $
+ */
+/** @file
+ * @brief Implementation of functions to send common replies to users.
+ * @version $Id: ircd_reply.c,v 1.21 2004/10/05 02:39:38 entrope Exp $
*/
#include "config.h"
@@ -38,10 +40,12 @@
#include <assert.h>
#include <string.h>
-/* Report a protocol violation warning to anyone listening. This can be
- * easily used to cleanup the last couple of parts of the code up.
+/** Report a protocol violation warning to anyone listening. This can
+ * be easily used to clean up the last couple of parts of the code.
+ * @param[in] cptr Client that violated the protocol.
+ * @param[in] pattern Description of how the protocol was violated.
+ * @return Zero.
*/
-
int protocol_violation(struct Client* cptr, const char* pattern, ...)
{
struct VarData vd;
@@ -59,12 +63,22 @@
return 0;
}
+/** Inform a client that they need to provide more parameters.
+ * @param[in] cptr Taciturn client.
+ * @param[in] cmd Command name.
+ * @return Zero.
+ */
int need_more_params(struct Client* cptr, const char* cmd)
{
send_reply(cptr, ERR_NEEDMOREPARAMS, cmd);
return 0;
}
+/** Send a generic reply to a user.
+ * @param[in] to Client that wants a reply.
+ * @param[in] reply Numeric of message to send.
+ * @return Zero.
+ */
int send_reply(struct Client *to, int reply, ...)
{
struct VarData vd;
----------------------- End of diff -----------------------
