summaryrefslogtreecommitdiff
path: root/legacy
diff options
context:
space:
mode:
authorGustavo Sverzut Barbieri <barbieri@gmail.com>2010-03-17 00:49:51 +0000
committerGustavo Sverzut Barbieri <barbieri@gmail.com>2010-03-17 00:49:51 +0000
commit42c8058da2fd911b3a6919f99440f0fc86df4bbd (patch)
tree763561e0c770fa7d6f47838782fa5ffdbfa6a38f /legacy
parenta859e60140ea130247ced25ca6e6022d2b429d3c (diff)
Fix docs indentation and one example.
@vincent: This is an ongoing effort, after we're all done we'll update the damn ChangeLog :-) @cedric: There are couple of @since 2.0.0, but we're at 1.2.3, could you review in which version you introduced those changes? :-) SVN revision: 47300
Diffstat (limited to '')
-rw-r--r--legacy/eet/doc/eet.dox.in2
-rw-r--r--legacy/eet/src/lib/Eet.h185
2 files changed, 107 insertions, 80 deletions
diff --git a/legacy/eet/doc/eet.dox.in b/legacy/eet/doc/eet.dox.in
index 54f748ef8f..9fc5d3103f 100644
--- a/legacy/eet/doc/eet.dox.in
+++ b/legacy/eet/doc/eet.dox.in
@@ -65,7 +65,7 @@ main(int argc, char **argv)
65 char buf[32]; 65 char buf[32];
66 char *ret; 66 char *ret;
67 int size; 67 int size;
68 char **entries = 68 char *entries[] =
69 { 69 {
70 "Entry 1", 70 "Entry 1",
71 "Big text string here compared to others", 71 "Big text string here compared to others",
diff --git a/legacy/eet/src/lib/Eet.h b/legacy/eet/src/lib/Eet.h
index ff3d069477..b32b0d339a 100644
--- a/legacy/eet/src/lib/Eet.h
+++ b/legacy/eet/src/lib/Eet.h
@@ -191,9 +191,10 @@ extern "C" {
191 /** 191 /**
192 * Clear eet cache 192 * Clear eet cache
193 * 193 *
194 * Eet didn't free items by default. If you are under memory presure, just 194 * Eet didn't free items by default. If you are under memory
195 * call this function to recall all memory that are not yet referenced anymore. 195 * presure, just call this function to recall all memory that are
196 * The cache take care of modification on disk. 196 * not yet referenced anymore. The cache take care of modification
197 * on disk.
197 * 198 *
198 * @since 1.0.0 199 * @since 1.0.0
199 */ 200 */
@@ -202,7 +203,8 @@ extern "C" {
202 /** 203 /**
203 * Open an eet file on disk, and returns a handle to it. 204 * Open an eet file on disk, and returns a handle to it.
204 * @param file The file path to the eet file. eg: "/tmp/file.eet". 205 * @param file The file path to the eet file. eg: "/tmp/file.eet".
205 * @param mode The mode for opening. Either EET_FILE_MODE_READ, EET_FILE_MODE_WRITE or EET_FILE_MODE_READ_WRITE. 206 * @param mode The mode for opening. Either EET_FILE_MODE_READ,
207 * EET_FILE_MODE_WRITE or EET_FILE_MODE_READ_WRITE.
206 * @return An opened eet file handle. 208 * @return An opened eet file handle.
207 * 209 *
208 * This function will open an exiting eet file for reading, and build 210 * This function will open an exiting eet file for reading, and build
@@ -833,13 +835,15 @@ extern "C" {
833 835
834 /** 836 /**
835 * Create a new empty data structure descriptor. 837 * Create a new empty data structure descriptor.
836 * @param name The string name of this data structure (most be a global constant and never change). 838 * @param name The string name of this data structure (most be a
839 * global constant and never change).
837 * @param size The size of the struct (in bytes). 840 * @param size The size of the struct (in bytes).
838 * @param func_list_next The function to get the next list node. 841 * @param func_list_next The function to get the next list node.
839 * @param func_list_append The function to append a member to a list. 842 * @param func_list_append The function to append a member to a list.
840 * @param func_list_data The function to get the data from a list node. 843 * @param func_list_data The function to get the data from a list node.
841 * @param func_list_free The function to free an entire linked list. 844 * @param func_list_free The function to free an entire linked list.
842 * @param func_hash_foreach The function to iterate through all hash table entries. 845 * @param func_hash_foreach The function to iterate through all
846 * hash table entries.
843 * @param func_hash_add The function to add a member to a hash table. 847 * @param func_hash_add The function to add a member to a hash table.
844 * @param func_hash_free The function to free an entire hash table. 848 * @param func_hash_free The function to free an entire hash table.
845 * @return A new empty data descriptor. 849 * @return A new empty data descriptor.
@@ -858,7 +862,7 @@ extern "C" {
858 * endian-independant serialised data chunks for transmission across a 862 * endian-independant serialised data chunks for transmission across a
859 * a network or more. 863 * a network or more.
860 * 864 *
861 * The function pointers to the list and hash table functions are only 865 * The function pointers to the list and hash table functions are only
862 * needed if you use those data types, else you can pass NULL instead. 866 * needed if you use those data types, else you can pass NULL instead.
863 * 867 *
864 * Example: 868 * Example:
@@ -955,17 +959,17 @@ extern "C" {
955 * EET_DATA_DESCRIPTOR_ADD_SUB(edd, Blah, "blah2", blah2, edd2); 959 * EET_DATA_DESCRIPTOR_ADD_SUB(edd, Blah, "blah2", blah2, edd2);
956 * EET_DATA_DESCRIPTOR_ADD_LIST(edd, Blah, "blah3", blah3, edd3); 960 * EET_DATA_DESCRIPTOR_ADD_LIST(edd, Blah, "blah3", blah3, edd3);
957 * 961 *
958 * blah3.string="PANTS"; 962 * blah3.string = "PANTS";
959 * 963 *
960 * blah2.string="subtype string here!"; 964 * blah2.string = "subtype string here!";
961 * 965 *
962 * blah.character='7'; 966 * blah.character = '7';
963 * blah.sixteen=0x7777; 967 * blah.sixteen = 0x7777;
964 * blah.integer=0xc0def00d; 968 * blah.integer = 0xc0def00d;
965 * blah.lots=0xdeadbeef31337777; 969 * blah.lots = 0xdeadbeef31337777;
966 * blah.floating=3.141592654; 970 * blah.floating = 3.141592654;
967 * blah.floating_lots=0.777777777777777; 971 * blah.floating_lots = 0.777777777777777;
968 * blah.string="bite me like a turnip"; 972 * blah.string = "bite me like a turnip";
969 * blah.blah2 = &blah2; 973 * blah.blah2 = &blah2;
970 * blah.blah3 = eina_list_append(NULL, &blah3); 974 * blah.blah3 = eina_list_append(NULL, &blah3);
971 * blah.blah3 = eina_list_append(blah.blah3, &blah3); 975 * blah.blah3 = eina_list_append(blah.blah3, &blah3);
@@ -1063,12 +1067,13 @@ extern "C" {
1063 * endian-independant serialised data chunks for transmission across a 1067 * endian-independant serialised data chunks for transmission across a
1064 * a network or more. 1068 * a network or more.
1065 * 1069 *
1066 * This function use str_direct_alloc and str_direct_free. It is usefull when 1070 * This function use str_direct_alloc and str_direct_free. It is
1067 * the eet_data you are reading come from a file and have a dictionnary. This 1071 * usefull when the eet_data you are reading come from a file and
1068 * will reduce memory use, improve the possibility for the OS to page this 1072 * have a dictionnary. This will reduce memory use, improve the
1069 * string out. But be carrefull all EET_T_STRING are pointer to a mmapped area 1073 * possibility for the OS to page this string out. But be carrefull
1070 * and it will point to nowhere if you close the file. So as long as you use 1074 * all EET_T_STRING are pointer to a mmapped area and it will point
1071 * this strings, you need to have the Eet_File open. 1075 * to nowhere if you close the file. So as long as you use this
1076 * strings, you need to have the Eet_File open.
1072 * 1077 *
1073 * @since 1.3.0 1078 * @since 1.3.0
1074 */ 1079 */
@@ -1088,37 +1093,43 @@ extern "C" {
1088 EAPI Eina_Bool eet_eina_stream_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc, const char *name, int size); 1093 EAPI Eina_Bool eet_eina_stream_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc, const char *name, int size);
1089 1094
1090 /** 1095 /**
1091 * This macro is an helper that set all the parameter of an Eet_Data_Descriptor_Class 1096 * This macro is an helper that set all the parameter of an
1092 * correctly when you use Eina data type with stream. 1097 * Eet_Data_Descriptor_Class correctly when you use Eina data type
1098 * with stream.
1093 * @param class The Eet_Data_Descriptor_Class you want to set. 1099 * @param class The Eet_Data_Descriptor_Class you want to set.
1094 * @param type The type of the structure described by this class. 1100 * @param type The type of the structure described by this class.
1095 * @return EINA_TRUE if the structure was correctly set (The only reason that could make 1101 * @return EINA_TRUE if the structure was correctly set (The only
1096 * it fail is if you did give wrong parameter). 1102 * reason that could make it fail is if you did give wrong
1103 * parameter).
1097 * 1104 *
1098 * @since 1.3.0 1105 * @since 1.3.0
1099 */ 1106 */
1100#define EET_EINA_STREAM_DATA_DESCRIPTOR_CLASS_SET(Clas, Type) (eet_eina_stream_data_descriptor_class_set(Clas, #Type , sizeof (Type))) 1107#define EET_EINA_STREAM_DATA_DESCRIPTOR_CLASS_SET(Clas, Type) (eet_eina_stream_data_descriptor_class_set(Clas, #Type , sizeof (Type)))
1101 1108
1102 /** 1109 /**
1103 * This function is an helper that set all the parameter of an Eet_Data_Descriptor_Class 1110 * This function is an helper that set all the parameter of an
1104 * correctly when you use Eina data type with a file. 1111 * Eet_Data_Descriptor_Class correctly when you use Eina data type
1112 * with a file.
1105 * @param class The Eet_Data_Descriptor_Class you want to set. 1113 * @param class The Eet_Data_Descriptor_Class you want to set.
1106 * @param name The name of the structure described by this class. 1114 * @param name The name of the structure described by this class.
1107 * @param size The size of the structure described by this class. 1115 * @param size The size of the structure described by this class.
1108 * @return EINA_TRUE if the structure was correctly set (The only reason that could make 1116 * @return EINA_TRUE if the structure was correctly set (The only
1109 * it fail is if you did give wrong parameter). 1117 * reason that could make it fail is if you did give wrong
1118 * parameter).
1110 * 1119 *
1111 * @since 1.3.0 1120 * @since 1.3.0
1112 */ 1121 */
1113 EAPI Eina_Bool eet_eina_file_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc, const char *name, int size); 1122 EAPI Eina_Bool eet_eina_file_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc, const char *name, int size);
1114 1123
1115 /** 1124 /**
1116 * This macro is an helper that set all the parameter of an Eet_Data_Descriptor_Class 1125 * This macro is an helper that set all the parameter of an
1117 * correctly when you use Eina data type with file. 1126 * Eet_Data_Descriptor_Class correctly when you use Eina data type
1127 * with file.
1118 * @param class The Eet_Data_Descriptor_Class you want to set. 1128 * @param class The Eet_Data_Descriptor_Class you want to set.
1119 * @param type The type of the structure described by this class. 1129 * @param type The type of the structure described by this class.
1120 * @return EINA_TRUE if the structure was correctly set (The only reason that could make 1130 * @return EINA_TRUE if the structure was correctly set (The only
1121 * it fail is if you did give wrong parameter). 1131 * reason that could make it fail is if you did give wrong
1132 * parameter).
1122 * 1133 *
1123 * @since 1.3.0 1134 * @since 1.3.0
1124 */ 1135 */
@@ -1196,21 +1207,22 @@ extern "C" {
1196 * Dump an eet encoded data structure into ascii text 1207 * Dump an eet encoded data structure into ascii text
1197 * @param data_in The pointer to the data to decode into a struct. 1208 * @param data_in The pointer to the data to decode into a struct.
1198 * @param size_in The size of the data pointed to in bytes. 1209 * @param size_in The size of the data pointed to in bytes.
1199 * @param dumpfunc The function to call passed a string when new data is converted to text 1210 * @param dumpfunc The function to call passed a string when new
1211 * data is converted to text
1200 * @param dumpdata The data to pass to the @p dumpfunc callback. 1212 * @param dumpdata The data to pass to the @p dumpfunc callback.
1201 * @return 1 on success, 0 on failure 1213 * @return 1 on success, 0 on failure
1202 * 1214 *
1203 * This function will take a chunk of data encoded by 1215 * This function will take a chunk of data encoded by
1204 * eet_data_descriptor_encode() and convert it into human readable ascii text. 1216 * eet_data_descriptor_encode() and convert it into human readable
1205 * It does this by calling the @p dumpfunc callback for all new text that is 1217 * ascii text. It does this by calling the @p dumpfunc callback
1206 * generated. This callback should append to any existing text buffer and 1218 * for all new text that is generated. This callback should append
1207 * will be passed the pointer @p dumpdata as a parameter as well as a string 1219 * to any existing text buffer and will be passed the pointer @p
1208 * with new text to be appended. 1220 * dumpdata as a parameter as well as a string with new text to be
1221 * appended.
1209 * 1222 *
1210 * Example: 1223 * Example:
1211 * 1224 *
1212 * @code 1225 * @code
1213 *
1214 * void output(void *data, const char *string) 1226 * void output(void *data, const char *string)
1215 * { 1227 * {
1216 * printf("%s", string); 1228 * printf("%s", string);
@@ -1241,8 +1253,10 @@ extern "C" {
1241 /** 1253 /**
1242 * Take an ascii encoding from eet_data_text_dump() and re-encode in binary. 1254 * Take an ascii encoding from eet_data_text_dump() and re-encode in binary.
1243 * @param text The pointer to the string data to parse and encode. 1255 * @param text The pointer to the string data to parse and encode.
1244 * @param textlen The size of the string in bytes (not including 0 byte terminator). 1256 * @param textlen The size of the string in bytes (not including 0
1245 * @param size_ret This gets filled in with the encoded data blob size in bytes. 1257 * byte terminator).
1258 * @param size_ret This gets filled in with the encoded data blob
1259 * size in bytes.
1246 * @return The encoded data on success, NULL on failure. 1260 * @return The encoded data on success, NULL on failure.
1247 * 1261 *
1248 * This function will parse the string pointed to by @p text and return 1262 * This function will parse the string pointed to by @p text and return
@@ -1259,16 +1273,19 @@ extern "C" {
1259 * Dump an eet encoded data structure from an eet file into ascii text 1273 * Dump an eet encoded data structure from an eet file into ascii text
1260 * @param ef A valid eet file handle. 1274 * @param ef A valid eet file handle.
1261 * @param name Name of the entry. eg: "/base/file_i_want". 1275 * @param name Name of the entry. eg: "/base/file_i_want".
1262 * @param dumpfunc The function to call passed a string when new data is converted to text 1276 * @param dumpfunc The function to call passed a string when new
1277 * data is converted to text
1263 * @param dumpdata The data to pass to the @p dumpfunc callback. 1278 * @param dumpdata The data to pass to the @p dumpfunc callback.
1264 * @return 1 on success, 0 on failure 1279 * @return 1 on success, 0 on failure
1265 * 1280 *
1266 * This function will take an open and valid eet file from eet_open() request 1281 * This function will take an open and valid eet file from
1267 * the data encoded by eet_data_descriptor_encode() corresponding to the key @p name 1282 * eet_open() request the data encoded by
1268 * and convert it into human readable ascii text. It does this by calling the 1283 * eet_data_descriptor_encode() corresponding to the key @p name
1269 * @p dumpfunc callback for all new text that is generated. This callback should 1284 * and convert it into human readable ascii text. It does this by
1270 * append to any existing text buffer and will be passed the pointer @p dumpdata 1285 * calling the @p dumpfunc callback for all new text that is
1271 * as a parameter as well as a string with new text to be appended. 1286 * generated. This callback should append to any existing text
1287 * buffer and will be passed the pointer @p dumpdata as a parameter
1288 * as well as a string with new text to be appended.
1272 * 1289 *
1273 * @since 1.0.0 1290 * @since 1.0.0
1274 */ 1291 */
@@ -1280,13 +1297,14 @@ extern "C" {
1280 * @param ef A valid eet file handle. 1297 * @param ef A valid eet file handle.
1281 * @param name Name of the entry. eg: "/base/file_i_want". 1298 * @param name Name of the entry. eg: "/base/file_i_want".
1282 * @param text The pointer to the string data to parse and encode. 1299 * @param text The pointer to the string data to parse and encode.
1283 * @param textlen The size of the string in bytes (not including 0 byte terminator). 1300 * @param textlen The size of the string in bytes (not including 0
1301 * byte terminator).
1284 * @param compress Compression flags (1 == compress, 0 = don't compress). 1302 * @param compress Compression flags (1 == compress, 0 = don't compress).
1285 * @return 1 on success, 0 on failure 1303 * @return 1 on success, 0 on failure
1286 * 1304 *
1287 * This function will parse the string pointed to by @p text, encode it the same 1305 * This function will parse the string pointed to by @p text,
1288 * way eet_data_descriptor_encode() takes an in-memory data struct and encodes into a 1306 * encode it the same way eet_data_descriptor_encode() takes an
1289 * binary blob. 1307 * in-memory data struct and encodes into a binary blob.
1290 * 1308 *
1291 * The data (optionally compressed) will be in ram, pending a flush to 1309 * The data (optionally compressed) will be in ram, pending a flush to
1292 * disk (it will stay in ram till the eet file handle is closed though). 1310 * disk (it will stay in ram till the eet file handle is closed though).
@@ -1327,7 +1345,7 @@ extern "C" {
1327 * Encode a dsata struct to memory and return that encoded data. 1345 * Encode a dsata struct to memory and return that encoded data.
1328 * @param edd The data descriptor to use when encoding. 1346 * @param edd The data descriptor to use when encoding.
1329 * @param data_in The pointer to the struct to encode into data. 1347 * @param data_in The pointer to the struct to encode into data.
1330 * @param size_ret A pointer to the an int to be filled with the decoded size. 1348 * @param size_ret pointer to the an int to be filled with the decoded size.
1331 * @return NULL on failure, or a valid encoded data chunk on success. 1349 * @return NULL on failure, or a valid encoded data chunk on success.
1332 * 1350 *
1333 * This function takes a data structutre in memory and encodes it into a 1351 * This function takes a data structutre in memory and encodes it into a
@@ -1356,20 +1374,22 @@ extern "C" {
1356 * Add a basic data element to a data descriptor. 1374 * Add a basic data element to a data descriptor.
1357 * @param edd The data descriptor to add the type to. 1375 * @param edd The data descriptor to add the type to.
1358 * @param struct_type The type of the struct. 1376 * @param struct_type The type of the struct.
1359 * @param name The string name to use to encode/decode this member (must be a constant global and never change). 1377 * @param name The string name to use to encode/decode this member
1378 * (must be a constant global and never change).
1360 * @param member The struct member itself to be encoded. 1379 * @param member The struct member itself to be encoded.
1361 * @param type The type of the member to encode. 1380 * @param type The type of the member to encode.
1362 * 1381 *
1363 * This macro is a convenience macro provided to add a member to the data 1382 * This macro is a convenience macro provided to add a member to
1364 * descriptor @p edd. The type of the structure is provided as the 1383 * the data descriptor @p edd. The type of the structure is
1365 * @p struct_type parameter (for example: struct my_struct). The @p name 1384 * provided as the @p struct_type parameter (for example: struct
1366 * parameter defines a string that will be used to uniquely name that 1385 * my_struct). The @p name parameter defines a string that will be
1367 * member of the struct (it is suggested to use the struct member itself). 1386 * used to uniquely name that member of the struct (it is suggested
1368 * The @p member parameter is the actual struct member itself (for 1387 * to use the struct member itself). The @p member parameter is
1369eet_dictionary_string_check * example: values), and @p type is the basic data type of the member which 1388 * the actual struct member itself (for eet_dictionary_string_check
1370 * must be one of: EET_T_CHAR, EET_T_SHORT, EET_T_INT, EET_T_LONG_LONG, 1389 * example: values), and @p type is the basic data type of the
1371 * EET_T_FLOAT, EET_T_DOUBLE, EET_T_UCHAR, EET_T_USHORT, EET_T_UINT, 1390 * member which must be one of: EET_T_CHAR, EET_T_SHORT, EET_T_INT,
1372 * EET_T_ULONG_LONG or EET_T_STRING. 1391 * EET_T_LONG_LONG, EET_T_FLOAT, EET_T_DOUBLE, EET_T_UCHAR,
1392 * EET_T_USHORT, EET_T_UINT, EET_T_ULONG_LONG or EET_T_STRING.
1373 * 1393 *
1374 * @since 1.0.0 1394 * @since 1.0.0
1375 */ 1395 */
@@ -1386,7 +1406,8 @@ eet_dictionary_string_check * example: values), and @p type is the basic data
1386 * Add a sub-element type to a data descriptor 1406 * Add a sub-element type to a data descriptor
1387 * @param edd The data descriptor to add the type to. 1407 * @param edd The data descriptor to add the type to.
1388 * @param struct_type The type of the struct. 1408 * @param struct_type The type of the struct.
1389 * @param name The string name to use to encode/decode this member (must be a constant global and never change). 1409 * @param name The string name to use to encode/decode this member
1410 * (must be a constant global and never change).
1390 * @param member The struct member itself to be encoded. 1411 * @param member The struct member itself to be encoded.
1391 * @param subtype The type of sub-type struct to add. 1412 * @param subtype The type of sub-type struct to add.
1392 * 1413 *
@@ -1411,7 +1432,8 @@ eet_dictionary_string_check * example: values), and @p type is the basic data
1411 * Add a linked list type to a data descriptor 1432 * Add a linked list type to a data descriptor
1412 * @param edd The data descriptor to add the type to. 1433 * @param edd The data descriptor to add the type to.
1413 * @param struct_type The type of the struct. 1434 * @param struct_type The type of the struct.
1414 * @param name The string name to use to encode/decode this member (must be a constant global and never change). 1435 * @param name The string name to use to encode/decode this member
1436 * (must be a constant global and never change).
1415 * @param member The struct member itself to be encoded. 1437 * @param member The struct member itself to be encoded.
1416 * @param subtype The type of linked list member to add. 1438 * @param subtype The type of linked list member to add.
1417 * 1439 *
@@ -1435,7 +1457,8 @@ eet_dictionary_string_check * example: values), and @p type is the basic data
1435 * Add a hash type to a data descriptor 1457 * Add a hash type to a data descriptor
1436 * @param edd The data descriptor to add the type to. 1458 * @param edd The data descriptor to add the type to.
1437 * @param struct_type The type of the struct. 1459 * @param struct_type The type of the struct.
1438 * @param name The string name to use to encode/decode this member (must be a constant global and never change). 1460 * @param name The string name to use to encode/decode this member
1461 * (must be a constant global and never change).
1439 * @param member The struct member itself to be encoded. 1462 * @param member The struct member itself to be encoded.
1440 * @param subtype The type of hash member to add. 1463 * @param subtype The type of hash member to add.
1441 * 1464 *
@@ -1459,14 +1482,16 @@ eet_dictionary_string_check * example: values), and @p type is the basic data
1459 * Add a fixed size array type to a data descriptor 1482 * Add a fixed size array type to a data descriptor
1460 * @param edd The data descriptor to add the type to. 1483 * @param edd The data descriptor to add the type to.
1461 * @param struct_type The type of the struct. 1484 * @param struct_type The type of the struct.
1462 * @param name The string name to use to encode/decode this member (must be a constant global and never change). 1485 * @param name The string name to use to encode/decode this member
1486 * (must be a constant global and never change).
1463 * @param member The struct member itself to be encoded. 1487 * @param member The struct member itself to be encoded.
1464 * @param subtype The type of hash member to add. 1488 * @param subtype The type of hash member to add.
1465 * 1489 *
1466 * This macro lets you easily add a fixed size array of other data types. All the 1490 * This macro lets you easily add a fixed size array of other data
1467 * parameters are the same as for EET_DATA_DESCRIPTOR_ADD_BASIC(), with the 1491 * types. All the parameters are the same as for
1468 * @p subtype being the exception. This must be the data descriptor of the 1492 * EET_DATA_DESCRIPTOR_ADD_BASIC(), with the @p subtype being the
1469 * element that is in each member of the hash to be stored. 1493 * exception. This must be the data descriptor of the element that
1494 * is in each member of the hash to be stored.
1470 * 1495 *
1471 * @since 1.0.2 1496 * @since 1.0.2
1472 */ 1497 */
@@ -1483,14 +1508,16 @@ eet_dictionary_string_check * example: values), and @p type is the basic data
1483 * Add a variable size array type to a data descriptor 1508 * Add a variable size array type to a data descriptor
1484 * @param edd The data descriptor to add the type to. 1509 * @param edd The data descriptor to add the type to.
1485 * @param struct_type The type of the struct. 1510 * @param struct_type The type of the struct.
1486 * @param name The string name to use to encode/decode this member (must be a constant global and never change). 1511 * @param name The string name to use to encode/decode this member
1512 * (must be a constant global and never change).
1487 * @param member The struct member itself to be encoded. 1513 * @param member The struct member itself to be encoded.
1488 * @param subtype The type of hash member to add. 1514 * @param subtype The type of hash member to add.
1489 * 1515 *
1490 * This macro lets you easily add a fixed size array of other data types. All the 1516 * This macro lets you easily add a fixed size array of other data
1491 * parameters are the same as for EET_DATA_DESCRIPTOR_ADD_BASIC(), with the 1517 * types. All the parameters are the same as for
1492 * @p subtype being the exception. This must be the data descriptor of the 1518 * EET_DATA_DESCRIPTOR_ADD_BASIC(), with the @p subtype being the
1493 * element that is in each member of the hash to be stored. 1519 * exception. This must be the data descriptor of the element that
1520 * is in each member of the hash to be stored.
1494 * 1521 *
1495 * @since 1.0.2 1522 * @since 1.0.2
1496 */ 1523 */