From 9459b0294dee48313e71b59b9049a7b6faffd9c3 Mon Sep 17 00:00:00 2001
From: Gustavo Sverzut Barbieri <barbieri@gmail.com>
Date: Thu, 12 Jan 2012 17:35:50 +0000
Subject: [PATCH] eina_value: improve docs a bit

SVN revision: 67148
---
 legacy/eina/src/include/eina_value.h | 79 +++++++++++++++++++++++++---
 1 file changed, 71 insertions(+), 8 deletions(-)

diff --git a/legacy/eina/src/include/eina_value.h b/legacy/eina/src/include/eina_value.h
index 05204aad3a..97fbee9c7a 100644
--- a/legacy/eina/src/include/eina_value.h
+++ b/legacy/eina/src/include/eina_value.h
@@ -273,6 +273,13 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_HASH;
 /**
  * @var EINA_VALUE_TYPE_TIMEVAL
  * manages 'struct timeval' type
+ *
+ * eina_value_set() takes a "struct timeval" from sys/time.h.
+ * eina_value_pset() takes a pointer to "struct timeval".
+ *
+ * eina_value_get() and eina_value_pget() takes a pointer to "struct
+ * timeval" and it's an exact copy of value.
+ *
  * @since 1.2
  */
 EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_TIMEVAL;
@@ -445,6 +452,8 @@ static inline int eina_value_compare(const Eina_Value *a,
  * @li EINA_VALUE_TYPE_ARRAY: Eina_Value_Array
  * @li EINA_VALUE_TYPE_LIST: Eina_Value_List
  * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob
  *
  * @code
  *     Eina_Value *value = eina_value_new(EINA_VALUE_TYPE_INT);
@@ -503,6 +512,8 @@ static inline Eina_Bool eina_value_set(Eina_Value *value,
  * @li EINA_VALUE_TYPE_ARRAY: Eina_Value_Array*
  * @li EINA_VALUE_TYPE_LIST: Eina_Value_List*
  * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @code
  *     Eina_Value *value = eina_value_new(EINA_VALUE_TYPE_INT);
@@ -603,6 +614,8 @@ static inline Eina_Bool eina_value_vget(const Eina_Value *value,
  * @li EINA_VALUE_TYPE_ARRAY: Eina_Value_Array*
  * @li EINA_VALUE_TYPE_LIST: Eina_Value_List*
  * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @note the pointer contents are written using the size defined by
  *       type. It can be larger than void* or uint64_t.
@@ -666,6 +679,8 @@ static inline Eina_Bool eina_value_pset(Eina_Value *value,
  * @li EINA_VALUE_TYPE_ARRAY: Eina_Value_Array*
  * @li EINA_VALUE_TYPE_LIST: Eina_Value_List*
  * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @code
  *     Eina_Value *value = eina_value_new(EINA_VALUE_TYPE_INT);
@@ -871,6 +886,8 @@ static inline Eina_Bool eina_value_array_remove(Eina_Value *value,
  * @li EINA_VALUE_TYPE_ARRAY: Eina_Value_Array
  * @li EINA_VALUE_TYPE_LIST: Eina_Value_List
  * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob
  *
  * @code
  *     Eina_Value *value = eina_value_array_new(EINA_VALUE_TYPE_INT, 0);
@@ -929,6 +946,8 @@ static inline Eina_Bool eina_value_array_set(Eina_Value *value,
  * @li EINA_VALUE_TYPE_ARRAY: Eina_Value_Array*
  * @li EINA_VALUE_TYPE_LIST: Eina_Value_List*
  * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @code
  *     Eina_Value *value = eina_value_array_new(EINA_VALUE_TYPE_INT, 0);
@@ -975,6 +994,8 @@ static inline Eina_Bool eina_value_array_get(const Eina_Value *value,
  * @li EINA_VALUE_TYPE_ARRAY: Eina_Value_Array
  * @li EINA_VALUE_TYPE_LIST: Eina_Value_List
  * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob
  *
  * @code
  *     Eina_Value *value = eina_value_array_new(EINA_VALUE_TYPE_INT, 0);
@@ -1027,6 +1048,8 @@ static inline Eina_Bool eina_value_array_insert(Eina_Value *value,
  * @li EINA_VALUE_TYPE_ARRAY: Eina_Value_Array
  * @li EINA_VALUE_TYPE_LIST: Eina_Value_List
  * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob
  *
  * @code
  *     Eina_Value *value = eina_value_array_new(EINA_VALUE_TYPE_INT, 0);
@@ -1163,8 +1186,10 @@ static inline Eina_Bool eina_value_array_vappend(Eina_Value *value,
  * @li EINA_VALUE_TYPE_STRINGSHARE: const char **
  * @li EINA_VALUE_TYPE_STRING: const char **
  * @li EINA_VALUE_TYPE_ARRAY: Eina_Value_Array*
- * @li EINA_VALUE_TYPE_LIST: Eina_Value_List
- * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash
+ * @li EINA_VALUE_TYPE_LIST: Eina_Value_List*
+ * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @note the pointer contents are written using the size defined by
  *       type. It can be larger than void* or uint64_t.
@@ -1225,8 +1250,10 @@ static inline Eina_Bool eina_value_array_pset(Eina_Value *value,
  * @li EINA_VALUE_TYPE_STRINGSHARE: const char **
  * @li EINA_VALUE_TYPE_STRING: const char **
  * @li EINA_VALUE_TYPE_ARRAY: Eina_Value_Array*
- * @li EINA_VALUE_TYPE_LIST: Eina_Value_List
- * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash
+ * @li EINA_VALUE_TYPE_LIST: Eina_Value_List*
+ * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @code
  *     Eina_Value *value = eina_value_array_new(EINA_VALUE_TYPE_INT, 0);
@@ -1272,8 +1299,10 @@ static inline Eina_Bool eina_value_array_pget(const Eina_Value *value,
  * @li EINA_VALUE_TYPE_STRINGSHARE: const char **
  * @li EINA_VALUE_TYPE_STRING: const char **
  * @li EINA_VALUE_TYPE_ARRAY: Eina_Value_Array*
- * @li EINA_VALUE_TYPE_LIST: Eina_Value_List
- * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash
+ * @li EINA_VALUE_TYPE_LIST: Eina_Value_List*
+ * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @note the pointer contents are written using the size defined by
  *       type. It can be larger than void* or uint64_t.
@@ -1327,8 +1356,10 @@ static inline Eina_Bool eina_value_array_pinsert(Eina_Value *value,
  * @li EINA_VALUE_TYPE_STRINGSHARE: const char **
  * @li EINA_VALUE_TYPE_STRING: const char **
  * @li EINA_VALUE_TYPE_ARRAY: Eina_Value_Array*
- * @li EINA_VALUE_TYPE_LIST: Eina_Value_List
- * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash
+ * @li EINA_VALUE_TYPE_LIST: Eina_Value_List*
+ * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @note the pointer contents are written using the size defined by
  *       type. It can be larger than void* or uint64_t.
@@ -1475,6 +1506,9 @@ static inline Eina_Bool eina_value_list_remove(Eina_Value *value,
  * @li EINA_VALUE_TYPE_STRINGSHARE: const char *
  * @li EINA_VALUE_TYPE_STRING: const char *
  * @li EINA_VALUE_TYPE_LIST: Eina_Value_List
+ * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob
  *
  * @code
  *     Eina_Value *value = eina_value_list_new(EINA_VALUE_TYPE_INT);
@@ -1531,6 +1565,9 @@ static inline Eina_Bool eina_value_list_set(Eina_Value *value,
  * @li EINA_VALUE_TYPE_STRINGSHARE: const char **
  * @li EINA_VALUE_TYPE_STRING: const char **
  * @li EINA_VALUE_TYPE_LIST: Eina_Value_List*
+ * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @code
  *     Eina_Value *value = eina_value_list_new(EINA_VALUE_TYPE_INT);
@@ -1575,6 +1612,9 @@ static inline Eina_Bool eina_value_list_get(const Eina_Value *value,
  * @li EINA_VALUE_TYPE_STRINGSHARE: const char *
  * @li EINA_VALUE_TYPE_STRING: const char *
  * @li EINA_VALUE_TYPE_LIST: Eina_Value_List
+ * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob
  *
  * @code
  *     Eina_Value *value = eina_value_list_new(EINA_VALUE_TYPE_INT);
@@ -1625,6 +1665,9 @@ static inline Eina_Bool eina_value_list_insert(Eina_Value *value,
  * @li EINA_VALUE_TYPE_STRINGSHARE: const char *
  * @li EINA_VALUE_TYPE_STRING: const char *
  * @li EINA_VALUE_TYPE_LIST: Eina_Value_List
+ * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob
  *
  * @code
  *     Eina_Value *value = eina_value_list_new(EINA_VALUE_TYPE_INT);
@@ -1761,6 +1804,9 @@ static inline Eina_Bool eina_value_list_vappend(Eina_Value *value,
  * @li EINA_VALUE_TYPE_STRINGSHARE: const char **
  * @li EINA_VALUE_TYPE_STRING: const char **
  * @li EINA_VALUE_TYPE_LIST: Eina_Value_List*
+ * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @note the pointer contents are written using the size defined by
  *       type. It can be larger than void* or uint64_t.
@@ -1821,6 +1867,9 @@ static inline Eina_Bool eina_value_list_pset(Eina_Value *value,
  * @li EINA_VALUE_TYPE_STRINGSHARE: const char **
  * @li EINA_VALUE_TYPE_STRING: const char **
  * @li EINA_VALUE_TYPE_LIST: Eina_Value_List*
+ * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @code
  *     Eina_Value *value = eina_value_list_new(EINA_VALUE_TYPE_INT);
@@ -1866,6 +1915,9 @@ static inline Eina_Bool eina_value_list_pget(const Eina_Value *value,
  * @li EINA_VALUE_TYPE_STRINGSHARE: const char **
  * @li EINA_VALUE_TYPE_STRING: const char **
  * @li EINA_VALUE_TYPE_LIST: Eina_Value_List*
+ * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @note the pointer contents are written using the size defined by
  *       type. It can be larger than void* or uint64_t.
@@ -1919,6 +1971,9 @@ static inline Eina_Bool eina_value_list_pinsert(Eina_Value *value,
  * @li EINA_VALUE_TYPE_STRINGSHARE: const char **
  * @li EINA_VALUE_TYPE_STRING: const char **
  * @li EINA_VALUE_TYPE_LIST: Eina_Value_List*
+ * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @note the pointer contents are written using the size defined by
  *       type. It can be larger than void* or uint64_t.
@@ -2069,6 +2124,8 @@ static inline Eina_Bool eina_value_hash_del(Eina_Value *value,
  * @li EINA_VALUE_TYPE_STRINGSHARE: const char *
  * @li EINA_VALUE_TYPE_STRING: const char *
  * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @code
  *     Eina_Value *value = eina_value_hash_new(EINA_VALUE_TYPE_INT, 0);
@@ -2119,6 +2176,8 @@ static inline Eina_Bool eina_value_hash_set(Eina_Value *value,
  * @li EINA_VALUE_TYPE_STRINGSHARE: const char **
  * @li EINA_VALUE_TYPE_STRING: const char **
  * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @code
  *     Eina_Value *value = eina_value_hash_new(EINA_VALUE_TYPE_INT, 0);
@@ -2202,6 +2261,8 @@ static inline Eina_Bool eina_value_hash_vget(const Eina_Value *value,
  * @li EINA_VALUE_TYPE_STRINGSHARE: const char **
  * @li EINA_VALUE_TYPE_STRING: const char **
  * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @note the pointer contents are written using the size defined by
  *       type. It can be larger than void* or uint64_t.
@@ -2255,6 +2316,8 @@ static inline Eina_Bool eina_value_hash_pset(Eina_Value *value,
  * @li EINA_VALUE_TYPE_STRINGSHARE: const char **
  * @li EINA_VALUE_TYPE_STRING: const char **
  * @li EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
+ * @li EINA_VALUE_TYPE_TIMEVAL: struct timeval*
+ * @li EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
  *
  * @code
  *     Eina_Value *value = eina_value_hash_new(EINA_VALUE_TYPE_INT, 0);