Committer : entrope
CVSROOT : /cvsroot/undernet-ircu
Module : ircu2.10
Commit time: 2004-10-05 04:11:46 UTC
Modified files:
include/ircd_handler.h
Log message:
Doxyfy ircd_handler.h.
---------------------- diff included ----------------------
Index: ircu2.10/include/ircd_handler.h
diff -u ircu2.10/include/ircd_handler.h:1.1 ircu2.10/include/ircd_handler.h:1.2
--- ircu2.10/include/ircd_handler.h:1.1 Fri Mar 17 21:20:28 2000
+++ ircu2.10/include/ircd_handler.h Mon Oct 4 21:11:36 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_handler.h,v 1.1 2000/03/18 05:20:28 bleep Exp $
+ */
+/** @file
+ * @brief Message handler types and definitions.
+ * @version $Id: ircd_handler.h,v 1.2 2004/10/05 04:11:36 entrope Exp $
*/
#ifndef INCLUDED_ircd_handler_h
#define INCLUDED_ircd_handler_h
@@ -27,24 +29,24 @@
/*
* MessageHandler
*/
+/** Enumerated type for client message handlers. */
typedef enum HandlerType {
- UNREGISTERED_HANDLER,
- CLIENT_HANDLER,
- SERVER_HANDLER,
- OPER_HANDLER,
- SERVICE_HANDLER,
- LAST_HANDLER_TYPE
+ UNREGISTERED_HANDLER, /**< Used for unregistered clients. */
+ CLIENT_HANDLER, /**< Used for local users. */
+ SERVER_HANDLER, /**< Used for server conections. */
+ OPER_HANDLER, /**< Used for IRC operators. */
+ SERVICE_HANDLER, /**< Used for services connections. */
+ LAST_HANDLER_TYPE /**< NUmber of handler types. */
} HandlerType;
-/*
- * MessageHandler function
- * Params:
- * struct Client* cptr - connection message originated from
- * struct Client* sptr - source of message, may be different from cptr
- * int parc - parameter count
- * char* parv[] - parameter vector
+/**
+ * MessageHandler function.
+ * @param[in] cptr Client that sent us the message.
+ * @param[in] sptr Original source of message.
+ * @param[in] parc Number of arguments.
+ * @param[in] parv Argument vector.
*/
-typedef int (*MessageHandler)(struct Client*, struct Client*, int, char*[]);
+typedef int (*MessageHandler)(struct Client* cptr, struct Client* sptr, int parc,
char*parv[]);
#endif /* INCLUDED_ircd_handler_h */
----------------------- End of diff -----------------------
