Rework check for number of parameters

[ngircd-alex.git] / src / ngircd / parse.h

diff --git a/src/ngircd/parse.h b/src/ngircd/parse.h
index 0ace285631cb260430d561fd1e5b37d69facbefd..beac227521b6d1d677df721b617f795b7e44bd62 100644 (file)
--- a/src/ngircd/parse.h
+++ b/src/ngircd/parse.h
@@ -7,42 +7,44 @@
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  * Please read the file COPYING, README and AUTHORS for more information.
- *
- * $Id: parse.h,v 1.9 2002/12/18 13:53:20 alex Exp $
- *
- * IRC command parser and validator (header)
  */
 
-
 #ifndef __parse_h__
 #define __parse_h__
 
+/**
+ * @file
+ * IRC command parser and validator (header)
+ */
 
-typedef struct _REQUEST                        /* vgl. RFC 2812, 2.3 */
+#include "portab.h"
+
+/** A single IRC request ("command"). See RFC 2812 section 2.3 for details. */
+typedef struct _REQUEST
 {
-       CHAR *prefix;                   /* Prefix */
-       CHAR *command;                  /* IRC-Befehl */
-       CHAR *argv[15];                 /* Parameter (max. 15: 0..14) */
-       INT argc;                       /* Anzahl vorhandener Parameter */
+       char *prefix;                   /**< Prefix */
+       char *command;                  /**< IRC command */
+       char *argv[15];                 /**< Parameters, at most 15 (0..14) */
+       int argc;                       /**< Number of given paramaters */
 } REQUEST;
 
-
+/** IRC command handling structure */
 typedef struct _COMMAND
 {
-       CHAR *name;             /* command name */
-       BOOLEAN (*function)( CLIENT *Client, REQUEST *Request );
-       CLIENT_TYPE type;       /* valid client types (bit mask) */
-       LONG lcount, rcount;    /* number of local and remote calls */
-       LONG bytes;             /* number of bytes created */
+       const char *name;               /**< Command name */
+       bool (*function) PARAMS(( CLIENT *Client, REQUEST *Request ));
+                                       /**< Function to handle this command */
+       CLIENT_TYPE type;               /**< Valid client types (bit mask) */
+       int min_argc;                   /**< Min parameters */
+       int max_argc;                   /**< Max parameters */
+       long lcount, rcount;            /**< Number of local and remote calls */
+       long bytes;                     /**< Number of bytes created */
 } COMMAND;
 
+GLOBAL bool Parse_Request PARAMS((CONN_ID Idx, char *Request ));
 
-GLOBAL BOOLEAN Parse_Request PARAMS((CONN_ID Idx, CHAR *Request ));
-
-GLOBAL COMMAND *Parse_GetCommandStruct PARAMS(( VOID ));
-
+GLOBAL COMMAND *Parse_GetCommandStruct PARAMS(( void ));
 
 #endif
 
-
 /* -eof- */