From 0113088af6e81e51737d10f55e04f201b717535a Mon Sep 17 00:00:00 2001 From: Mark Riddoch Date: Wed, 26 Jun 2013 09:44:40 +0200 Subject: [PATCH] Added doxygen documentation --- include/mysql_protocol.h | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/include/mysql_protocol.h b/include/mysql_protocol.h index 424d01791..11d81adaa 100644 --- a/include/mysql_protocol.h +++ b/include/mysql_protocol.h @@ -36,36 +36,36 @@ struct dcb; -/* +/** * MySQL Protocol specific state data */ typedef struct { - int fd; /* The socket descriptor */ - struct dcb *descriptor; /* The DCB of the socket we are running on */ - int state; /* Current descriptor state */ - char scramble[MYSQL_SCRAMBLE_LEN]; /* server scramble, created or received */ - uint32_t server_capabilities; /* server capabilities, created or received */ - uint32_t client_capabilities; /* client capabilities, created or received */ - unsigned long tid; /* MySQL Thread ID, in handshake */ + int fd; /**< The socket descriptor */ + struct dcb *descriptor; /**< The DCB of the socket we are running on */ + int state; /**< Current descriptor state */ + char scramble[MYSQL_SCRAMBLE_LEN]; /**< server scramble, created or received */ + uint32_t server_capabilities; /**< server capabilities, created or received */ + uint32_t client_capabilities; /**< client capabilities, created or received */ + unsigned long tid; /**< MySQL Thread ID, in handshake */ } MySQLProtocol; -/* +/** * MySQL session specific data * */ typedef struct mysql_session { - uint8_t client_sha1[MYSQL_SCRAMBLE_LEN]; /* SHA1(passowrd) */ - char user[MYSQL_USER_MAXLEN]; /* username */ - char db[MYSQL_DATABASE_MAXLEN]; /* database */ + uint8_t client_sha1[MYSQL_SCRAMBLE_LEN]; /**< SHA1(passowrd) */ + char user[MYSQL_USER_MAXLEN]; /**< username */ + char db[MYSQL_DATABASE_MAXLEN]; /**< database */ } MYSQL_session; /* MySQL Protocol States */ -#define MYSQL_ALLOC 0 /* Allocate data */ -#define MYSQL_AUTH_SENT 1 /* Authentication handshake has been sent */ -#define MYSQL_AUTH_RECV 2 /* Received user, password, db and capabilities */ -#define MYSQL_AUTH_FAILED 3 /* Auth failed, return error packet */ -#define MYSQL_IDLE 4 /* Auth done. Protocol is idle, waiting for statements */ -#define MYSQL_ROUTING 5 /* The received command has been routed to backend(s) */ -#define MYSQL_WAITING_RESULT 6 /* Waiting for result set */ +#define MYSQL_ALLOC 0 /**< Allocate data */ +#define MYSQL_AUTH_SENT 1 /**< Authentication handshake has been sent */ +#define MYSQL_AUTH_RECV 2 /**< Received user, password, db and capabilities */ +#define MYSQL_AUTH_FAILED 3 /**< Auth failed, return error packet */ +#define MYSQL_IDLE 4 /**< Auth done. Protocol is idle, waiting for statements */ +#define MYSQL_ROUTING 5 /**< The received command has been routed to backend(s) */ +#define MYSQL_WAITING_RESULT 6 /**< Waiting for result set */ #endif