X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=src%2Fngircd%2Fparse.h;h=beac227521b6d1d677df721b617f795b7e44bd62;hp=3acab7d53fbf25d3e8a0b700e94af714ec7d8ac1;hb=00249f3c805ec0b4564901dce0f3a7b0c20ce439;hpb=2a7dd06ebd9cc72d45a6a4becdbef5213d7b7800 diff --git a/src/ngircd/parse.h b/src/ngircd/parse.h index 3acab7d5..beac2275 100644 --- a/src/ngircd/parse.h +++ b/src/ngircd/parse.h @@ -19,22 +19,26 @@ #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) */ + 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 ));