summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChidambar Zinnoury <chidambar.zinnoury@zefla.fr>2014-10-20 16:54:56 +0200
committerNicolas Aguirre <aguirre.nicolas@gmail.com>2014-10-20 17:00:10 +0200
commitad335387107bff5836aaf1c2b295455a2376ae89 (patch)
tree994bcb95353e6ecd14405f364298325708fa251d
parent9635289eed89a38898839dd63c222fcf4eabe761 (diff)
Eet.h: add some more documentation.devs/captainigloo/doc
-rw-r--r--src/lib/eet/Eet.h99
1 files changed, 82 insertions, 17 deletions
diff --git a/src/lib/eet/Eet.h b/src/lib/eet/Eet.h
index b0a0d3c7ed..15ca829b54 100644
--- a/src/lib/eet/Eet.h
+++ b/src/lib/eet/Eet.h
@@ -4241,7 +4241,10 @@ struct _Eet_Node_Data
4241 */ 4241 */
4242 4242
4243/** 4243/**
4244 * TODO FIX ME 4244 * Create a new character node.
4245 * @param name Name of the node.
4246 * @param c Character value.
4247 * @return A new character node.
4245 * @ingroup Eet_Node_Group 4248 * @ingroup Eet_Node_Group
4246 */ 4249 */
4247EAPI Eet_Node * 4250EAPI Eet_Node *
@@ -4249,7 +4252,10 @@ eet_node_char_new(const char *name,
4249 char c); 4252 char c);
4250 4253
4251/** 4254/**
4252 * TODO FIX ME 4255 * Create a new short node.
4256 * @param name Name of the node.
4257 * @param s short value.
4258 * @return A new short node.
4253 * @ingroup Eet_Node_Group 4259 * @ingroup Eet_Node_Group
4254 */ 4260 */
4255EAPI Eet_Node * 4261EAPI Eet_Node *
@@ -4257,7 +4263,10 @@ eet_node_short_new(const char *name,
4257 short s); 4263 short s);
4258 4264
4259/** 4265/**
4260 * TODO FIX ME 4266 * Create a new integer node.
4267 * @param name Name of the node.
4268 * @param i integer value.
4269 * @return A new integer node.
4261 * @ingroup Eet_Node_Group 4270 * @ingroup Eet_Node_Group
4262 */ 4271 */
4263EAPI Eet_Node * 4272EAPI Eet_Node *
@@ -4265,7 +4274,10 @@ eet_node_int_new(const char *name,
4265 int i); 4274 int i);
4266 4275
4267/** 4276/**
4268 * TODO FIX ME 4277 * Create a new long long integer node.
4278 * @param name Name of the node.
4279 * @param l long long integer value.
4280 * @return A new long long integer node.
4269 * @ingroup Eet_Node_Group 4281 * @ingroup Eet_Node_Group
4270 */ 4282 */
4271EAPI Eet_Node * 4283EAPI Eet_Node *
@@ -4273,7 +4285,10 @@ eet_node_long_long_new(const char *name,
4273 long long l); 4285 long long l);
4274 4286
4275/** 4287/**
4276 * TODO FIX ME 4288 * Create a new float node.
4289 * @param name Name of the node.
4290 * @param f float value.
4291 * @return A new float node.
4277 * @ingroup Eet_Node_Group 4292 * @ingroup Eet_Node_Group
4278 */ 4293 */
4279EAPI Eet_Node * 4294EAPI Eet_Node *
@@ -4281,7 +4296,10 @@ eet_node_float_new(const char *name,
4281 float f); 4296 float f);
4282 4297
4283/** 4298/**
4284 * TODO FIX ME 4299 * Create a new double node.
4300 * @param name Name of the node.
4301 * @param d double value.
4302 * @return A new double node.
4285 * @ingroup Eet_Node_Group 4303 * @ingroup Eet_Node_Group
4286 */ 4304 */
4287EAPI Eet_Node * 4305EAPI Eet_Node *
@@ -4289,7 +4307,10 @@ eet_node_double_new(const char *name,
4289 double d); 4307 double d);
4290 4308
4291/** 4309/**
4292 * TODO FIX ME 4310 * Create a new unsigned character node.
4311 * @param name Name of the node.
4312 * @param uc unsigned char value.
4313 * @return A new unsigned char node.
4293 * @ingroup Eet_Node_Group 4314 * @ingroup Eet_Node_Group
4294 */ 4315 */
4295EAPI Eet_Node * 4316EAPI Eet_Node *
@@ -4297,7 +4318,10 @@ eet_node_unsigned_char_new(const char *name,
4297 unsigned char uc); 4318 unsigned char uc);
4298 4319
4299/** 4320/**
4300 * TODO FIX ME 4321 * Create a new unsigned short node.
4322 * @param name Name of the node.
4323 * @param us unsigned short value.
4324 * @return A new unsigned short node.
4301 * @ingroup Eet_Node_Group 4325 * @ingroup Eet_Node_Group
4302 */ 4326 */
4303EAPI Eet_Node * 4327EAPI Eet_Node *
@@ -4305,7 +4329,10 @@ eet_node_unsigned_short_new(const char *name,
4305 unsigned short us); 4329 unsigned short us);
4306 4330
4307/** 4331/**
4308 * TODO FIX ME 4332 * Create a new unsigned integer node.
4333 * @param name Name of the node.
4334 * @param ui unsigned integer value.
4335 * @return A new unsigned integer node.
4309 * @ingroup Eet_Node_Group 4336 * @ingroup Eet_Node_Group
4310 */ 4337 */
4311EAPI Eet_Node * 4338EAPI Eet_Node *
@@ -4313,7 +4340,10 @@ eet_node_unsigned_int_new(const char *name,
4313 unsigned int ui); 4340 unsigned int ui);
4314 4341
4315/** 4342/**
4316 * TODO FIX ME 4343 * Create a new unsigned long long integer node.
4344 * @param name Name of the node.
4345 * @param l unsigned long long integer value.
4346 * @return A new unsigned long long integer node.
4317 * @ingroup Eet_Node_Group 4347 * @ingroup Eet_Node_Group
4318 */ 4348 */
4319EAPI Eet_Node * 4349EAPI Eet_Node *
@@ -4321,7 +4351,10 @@ eet_node_unsigned_long_long_new(const char *name,
4321 unsigned long long l); 4351 unsigned long long l);
4322 4352
4323/** 4353/**
4324 * TODO FIX ME 4354 * Create a new string node.
4355 * @param name Name of the node.
4356 * @param str string value.
4357 * @return A new string node.
4325 * @ingroup Eet_Node_Group 4358 * @ingroup Eet_Node_Group
4326 */ 4359 */
4327EAPI Eet_Node * 4360EAPI Eet_Node *
@@ -4329,7 +4362,10 @@ eet_node_string_new(const char *name,
4329 const char *str); 4362 const char *str);
4330 4363
4331/** 4364/**
4332 * TODO FIX ME 4365 * Create a new inlined string node.
4366 * @param name Name of the node.
4367 * @param str string value.
4368 * @return A new inlined string node.
4333 * @ingroup Eet_Node_Group 4369 * @ingroup Eet_Node_Group
4334 */ 4370 */
4335EAPI Eet_Node * 4371EAPI Eet_Node *
@@ -4337,14 +4373,19 @@ eet_node_inlined_string_new(const char *name,
4337 const char *str); 4373 const char *str);
4338 4374
4339/** 4375/**
4340 * TODO FIX ME 4376 * Create a new empty node.
4377 * @param name Name of the node.
4378 * @return A new empty node.
4341 * @ingroup Eet_Node_Group 4379 * @ingroup Eet_Node_Group
4342 */ 4380 */
4343EAPI Eet_Node * 4381EAPI Eet_Node *
4344eet_node_null_new(const char *name); 4382eet_node_null_new(const char *name);
4345 4383
4346/** 4384/**
4347 * TODO FIX ME 4385 * Create a new list node.
4386 * @param name Name of the node.
4387 * @param nodes list of nodes.
4388 * @return A new list node.
4348 * @ingroup Eet_Node_Group 4389 * @ingroup Eet_Node_Group
4349 */ 4390 */
4350EAPI Eet_Node * 4391EAPI Eet_Node *
@@ -4352,7 +4393,11 @@ eet_node_list_new(const char *name,
4352 Eina_List *nodes); 4393 Eina_List *nodes);
4353 4394
4354/** 4395/**
4355 * TODO FIX ME 4396 * Create a new array node.
4397 * @param name Name of the node.
4398 * @param count number of nodes
4399 * @param nodes list of nodes.
4400 * @return A new array node.
4356 * @ingroup Eet_Node_Group 4401 * @ingroup Eet_Node_Group
4357 */ 4402 */
4358EAPI Eet_Node * 4403EAPI Eet_Node *
@@ -4361,7 +4406,10 @@ eet_node_array_new(const char *name,
4361 Eina_List *nodes); 4406 Eina_List *nodes);
4362 4407
4363/** 4408/**
4364 * TODO FIX ME 4409 * Create a new variable array node.
4410 * @param name Name of the node.
4411 * @param nodes list of nodes.
4412 * @return A new variable array node.
4365 * @ingroup Eet_Node_Group 4413 * @ingroup Eet_Node_Group
4366 */ 4414 */
4367EAPI Eet_Node * 4415EAPI Eet_Node *
@@ -4372,13 +4420,23 @@ eet_node_var_array_new(const char *name,
4372 * TODO FIX ME 4420 * TODO FIX ME
4373 * @ingroup Eet_Node_Group 4421 * @ingroup Eet_Node_Group
4374 */ 4422 */
4423/**
4424 * Create a new short node.
4425 * @param name Name of the node.
4426 * @param s short value.
4427 * @return A new short node.
4428 * @ingroup Eet_Node_Group
4429 */
4375EAPI Eet_Node * 4430EAPI Eet_Node *
4376eet_node_hash_new(const char *name, 4431eet_node_hash_new(const char *name,
4377 const char *key, 4432 const char *key,
4378 Eet_Node *node); 4433 Eet_Node *node);
4379 4434
4380/** 4435/**
4381 * TODO FIX ME 4436 * Create a new struct node.
4437 * @param name Name of the node.
4438 * @param nodes list of nodes.
4439 * @return A new struct node.
4382 * @ingroup Eet_Node_Group 4440 * @ingroup Eet_Node_Group
4383 */ 4441 */
4384EAPI Eet_Node * 4442EAPI Eet_Node *
@@ -4389,6 +4447,13 @@ eet_node_struct_new(const char *name,
4389 * TODO FIX ME 4447 * TODO FIX ME
4390 * @ingroup Eet_Node_Group 4448 * @ingroup Eet_Node_Group
4391 */ 4449 */
4450/**
4451 * Create a new short node.
4452 * @param name Name of the node.
4453 * @param s short value.
4454 * @return A new short node.
4455 * @ingroup Eet_Node_Group
4456 */
4392EAPI Eet_Node * 4457EAPI Eet_Node *
4393eet_node_struct_child_new(const char *parent, 4458eet_node_struct_child_new(const char *parent,
4394 Eet_Node *child); 4459 Eet_Node *child);