Module: ngircd.git Branch: master Commit: af6ac0fa41a10889cdaf9898d995980bebcefec1 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=af6ac...
Author: Alexander Barton alex@barton.de Date: Mon Dec 27 17:34:26 2010 +0100
Doxygen'ify parse.h
---
src/ngircd/parse.h | 22 ++++++++++++---------- 1 files changed, 12 insertions(+), 10 deletions(-)
diff --git a/src/ngircd/parse.h b/src/ngircd/parse.h index 3acab7d..0c6f8a6 100644 --- a/src/ngircd/parse.h +++ b/src/ngircd/parse.h @@ -19,22 +19,24 @@
#include "portab.h"
-typedef struct _REQUEST /* vgl. RFC 2812, 2.3 */ +/** 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 { - const char *name; /* command name */ + 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 */ + /**< Function to handle this command */ + 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 ));