diff options
Diffstat (limited to 'database/eurephiadb_struct.h')
| -rw-r--r-- | database/eurephiadb_struct.h | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/database/eurephiadb_struct.h b/database/eurephiadb_struct.h index da45f4e..657e838 100644 --- a/database/eurephiadb_struct.h +++ b/database/eurephiadb_struct.h @@ -19,18 +19,28 @@ * */ +/** + * @file eurephiadb_struct.h + * @author David Sommerseth <dazo@users.sourceforge.net> + * @date 2008-11-05 + * + * @brief Definition of the eDBconn struct, a database independent + * connection handle + * + */ + #ifndef EUREPHIADB_STRUCT_H_ # define EUREPHIADB_STRUCT_H_ #include "eurephia_values_struct.h" -// -// Struct containing connection to the database we are using -// +/** + * Struct containing connection to the database we are using + */ typedef struct { - void *dbhandle; - char *dbname; - eurephiaVALUES *config; + void *dbhandle; /**< The DB handle used for the connection */ + char *dbname; /**< String with name of database, used in logs */ + eurephiaVALUES *config; /**< eurephia config parameters retrieved from the database */ } eDBconn; #endif |