Add Doxygen @file documentation to each source and header file

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

diff --git a/src/ngircd/parse.h b/src/ngircd/parse.h
index 6c252b153caf2d7408bbfab9656c0c771eb9ddcd..ef42be1456b0ce5099799213963a029e7881d5af 100644 (file)
--- a/src/ngircd/parse.h
+++ b/src/ngircd/parse.h
@@ -7,28 +7,41 @@
  * 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.8 2002/12/12 12:23:43 alex Exp $
- *
- * IRC command parser and validator (header)
  */
 
 
 #ifndef __parse_h__
 #define __parse_h__
 
+/**
+ * @file
+ * IRC command parser and validator (header)
+ */
+
+#include "portab.h"
 
 typedef struct _REQUEST                        /* vgl. RFC 2812, 2.3 */
 {
-       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-Befehl */
+       char *argv[15];                 /* Parameter (max. 15: 0..14) */
+       int argc;                       /* Anzahl vorhandener Parameter */
 } REQUEST;
 
 
-GLOBAL BOOLEAN Parse_Request PARAMS((CONN_ID Idx, CHAR *Request ));
+typedef struct _COMMAND
+{
+       const char *name;               /* command name */
+       bool (*function) PARAMS(( 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 */
+} COMMAND;
+
+
+GLOBAL bool Parse_Request PARAMS((CONN_ID Idx, char *Request ));
 
+GLOBAL COMMAND *Parse_GetCommandStruct PARAMS(( void ));
 
 #endif