diff options
| author | David Sommerseth <dazo@users.sourceforge.net> | 2009-09-04 15:24:05 +0200 |
|---|---|---|
| committer | David Sommerseth <dazo@users.sourceforge.net> | 2009-09-04 15:24:05 +0200 |
| commit | dea39103b369f0903be326c505d36a9d489a0c1e (patch) | |
| tree | 97a114b3fe7667c07678abdf528530efae8bfea8 /common/eurephia_values_struct.h | |
| parent | 856ecfcec0956d3269f2b119836ec31908d02836 (diff) | |
| download | eurephia-dea39103b369f0903be326c505d36a9d489a0c1e.tar.gz eurephia-dea39103b369f0903be326c505d36a9d489a0c1e.tar.xz eurephia-dea39103b369f0903be326c505d36a9d489a0c1e.zip | |
More comments in common/
Diffstat (limited to 'common/eurephia_values_struct.h')
| -rw-r--r-- | common/eurephia_values_struct.h | 25 |
1 files changed, 20 insertions, 5 deletions
diff --git a/common/eurephia_values_struct.h b/common/eurephia_values_struct.h index 37e709e..69b3c02 100644 --- a/common/eurephia_values_struct.h +++ b/common/eurephia_values_struct.h @@ -19,15 +19,30 @@ * */ +/** + * @file eurephia_values_struct.h + * @author David Sommerseth <dazo@users.sourceforge.net> + * @date 2008-11-05 + * + * @brief Definition of the eurephiaVALUES struct + * + */ + #ifndef EUREPHIA_VALUES_STRUCT_H_ # define EUREPHIA_VALUES_STRUCT_H_ +/** + * eurephiaVALUES is a pointer chain with key/value pairs. If having several + * such pointer chains, they can be given different group IDs to separate them, + * especially during debugging. + * + */ typedef struct __eurephiaVALUES { - unsigned int evgid; - unsigned int evid; - char *key; - char *val; - struct __eurephiaVALUES *next; + unsigned int evgid; /**< Group ID, all elements in the same chain should have the same value */ + unsigned int evid; /**< Unique ID per element in a pointer chain */ + char *key; /**< The key name of a value */ + char *val; /**< The value itself */ + struct __eurephiaVALUES *next; /**< Pointer to the next element in the chain. NULL == end of chain */ } eurephiaVALUES; #endif /* !EUREPHIA_VALUES_STRUCT_H_ */ |