Doxygen'ify parse.h

This commit is contained in:
Alexander Barton 2010-12-27 17:34:26 +01:00
parent f3ec90f3f0
commit af6ac0fa41
1 changed files with 12 additions and 10 deletions

View File

@ -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 ));