diff options
| author | David Sommerseth <dazo@users.sourceforge.net> | 2012-01-28 18:58:38 +0100 |
|---|---|---|
| committer | David Sommerseth <dazo@users.sourceforge.net> | 2013-06-13 01:06:19 +0200 |
| commit | 1af49dea1e1819e5d7ca0692f0f4fb5e82252602 (patch) | |
| tree | 63194a8d244a54d0c71a5c42e6c829cdccdd9feb | |
| parent | 6ce2be3d09484d393c894a291dc9429525d3d914 (diff) | |
| download | eurephia-1af49dea1e1819e5d7ca0692f0f4fb5e82252602.tar.gz eurephia-1af49dea1e1819e5d7ca0692f0f4fb5e82252602.tar.xz eurephia-1af49dea1e1819e5d7ca0692f0f4fb5e82252602.zip | |
Improved some of the Doxygen documentation
Signed-off-by: David Sommerseth <dazo@users.sourceforge.net>
| -rw-r--r-- | database/eurephiadb_mapping.c | 10 | ||||
| -rw-r--r-- | database/eurephiadb_mapping.h | 22 |
2 files changed, 24 insertions, 8 deletions
diff --git a/database/eurephiadb_mapping.c b/database/eurephiadb_mapping.c index 5033c43..289afcb 100644 --- a/database/eurephiadb_mapping.c +++ b/database/eurephiadb_mapping.c @@ -65,11 +65,11 @@ const char *TABLE_NAME[] = { * Simple mapping table for session status */ const char *SESSION_STATUS[] = { - "UNKNOWN", - "STARTED", - "OPEN", - "CLOSING", - "CLOSED", + "UNKNOWN", // Unknown session status + "STARTED", // Client has initiated contact, not authenticated + "OPEN", // Client has been authenticated + "CLOSING", // Client has disconnected, might re-connect; session not cleaned up + "CLOSED", // Client has completely disconnected "CLEANEDUP", NULL}; diff --git a/database/eurephiadb_mapping.h b/database/eurephiadb_mapping.h index ba077be..b1170a3 100644 --- a/database/eurephiadb_mapping.h +++ b/database/eurephiadb_mapping.h @@ -43,12 +43,28 @@ /** * Enumeration of different field types */ -typedef enum eDBfieldType_e { ft_UNDEF, ft_INT, ft_STRING, ft_STRING_LOWER, ft_DATETIME, ft_PASSWD, ft_SETNULL, ft_BOOL } eDBfieldType; +typedef enum eDBfieldType_e { ft_UNDEF, /**< Not defined */ + ft_INT, /**< Numeric, integer */ + ft_STRING, /**< String/text/varchar */ + ft_STRING_LOWER, /**< As ft_STRING but should be + passed through lower() at query time*/ + ft_DATETIME, /**< Time stamp field */ + ft_PASSWD, /**< As ft_STRING but contains a hashed password */ + ft_SETNULL, /**< Store value in database as NULL */ + ft_BOOL /**< Boolean value, according to the format the database expects */ +} eDBfieldType; /** - * Enumeration of different SQL filter types (IS NULL, =, !=, <=, >=, >, <, etc) + * Enumeration of different SQL filter types */ -typedef enum eDBfieldFilterType_e { flt_NOTSET, flt_EQ, flt_NEQ, flt_LT, flt_LTE, flt_GT, flt_GTE } eDBfieldFilterType; +typedef enum eDBfieldFilterType_e { flt_NOTSET, /**< IS NULL */ + flt_EQ, /**< Equal */ + flt_NEQ, /**< Not equal */ + flt_LT, /**< Less than */ + flt_LTE, /**< Less than or equal */ + flt_GT, /**< Greater than */ + flt_GTE /**< Greather than or equal */ +} eDBfieldFilterType; /** * Definition of the eDBfieldMap structure which maps a given numeric table ID and field ID |