summaryrefslogtreecommitdiff
path: root/src/lib/eina
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2018-07-31 16:40:43 -0400
committerChris Michael <cp.michael@samsung.com>2018-07-31 16:40:43 -0400
commit3524d48719e7815792a28bf624468b21d5030736 (patch)
treef4085d1a591ebfaf4bf906dc3e94df9a9ba1f9e2 /src/lib/eina
parent14aeb244837ca8b2898ecff717e2a60bb7a1dd09 (diff)
eina: Add doxygen in/out tags for value and value_util
Reviewers: devilhorns Reviewed By: devilhorns Subscribers: cedric, #committers, zmike Tags: #efl Differential Revision: https://phab.enlightenment.org/D6713
Diffstat (limited to 'src/lib/eina')
-rw-r--r--src/lib/eina/eina_value.h54
-rw-r--r--src/lib/eina/eina_value_util.h2
2 files changed, 31 insertions, 25 deletions
diff --git a/src/lib/eina/eina_value.h b/src/lib/eina/eina_value.h
index 729a674408..7124cbf07d 100644
--- a/src/lib/eina/eina_value.h
+++ b/src/lib/eina/eina_value.h
@@ -666,7 +666,7 @@ struct _Eina_Value
666 666
667/** 667/**
668 * @brief Creates generic value storage. 668 * @brief Creates generic value storage.
669 * @param type How to manage this value. 669 * @param[in] type How to manage this value.
670 * @return The new value or @c NULL on failure. 670 * @return The new value or @c NULL on failure.
671 * 671 *
672 * Create a new generic value storage. The members are managed using 672 * Create a new generic value storage. The members are managed using
@@ -690,7 +690,7 @@ EAPI Eina_Value *eina_value_new(const Eina_Value_Type *type) EINA_ARG_NONNULL(1)
690 690
691/** 691/**
692 * @brief Frees value and its data. 692 * @brief Frees value and its data.
693 * @param value value object 693 * @param[in] value value object
694 * 694 *
695 * @see eina_value_flush() 695 * @see eina_value_flush()
696 * 696 *
@@ -701,8 +701,8 @@ EAPI void eina_value_free(Eina_Value *value);
701/** 701/**
702 * @brief Initializes generic value storage. 702 * @brief Initializes generic value storage.
703 * 703 *
704 * @param value Value object 704 * @param[out] value Value object
705 * @param type How to manage this value. 705 * @param[out] type How to manage this value.
706 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 706 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
707 * 707 *
708 * Initializes existing generic value storage. The members are managed using the 708 * Initializes existing generic value storage. The members are managed using the
@@ -726,7 +726,7 @@ static inline Eina_Bool eina_value_setup(Eina_Value *value,
726/** 726/**
727 * @brief Creates generic value storage. 727 * @brief Creates generic value storage.
728 * 728 *
729 * @param value Value object 729 * @param[in] value Value object
730 * 730 *
731 * Releases all the resources associated with an #Eina_Value. The 731 * Releases all the resources associated with an #Eina_Value. The
732 * value must be already set with eina_value_setup() or 732 * value must be already set with eina_value_setup() or
@@ -745,8 +745,8 @@ static inline void eina_value_flush(Eina_Value *value) EINA_ARG_NONNULL(1);
745/** 745/**
746 * @brief Copies generic value storage. 746 * @brief Copies generic value storage.
747 * 747 *
748 * @param value Source value object 748 * @param[in] value Source value object
749 * @param copy Destination value object 749 * @param[out] copy Destination value object
750 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 750 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
751 * 751 *
752 * The @a copy object is considered uninitialized and its existing 752 * The @a copy object is considered uninitialized and its existing
@@ -763,8 +763,8 @@ EAPI Eina_Bool eina_value_copy(const Eina_Value *value,
763 763
764/** 764/**
765 * @brief Compares generic value storage. 765 * @brief Compares generic value storage.
766 * @param a left side of comparison 766 * @param[in] a left side of comparison
767 * @param b right side of comparison 767 * @param[in] b right side of comparison
768 * @return less than zero if a < b, greater than zero if a > b, zero 768 * @return less than zero if a < b, greater than zero if a > b, zero
769 * if a == b 769 * if a == b
770 * 770 *
@@ -776,7 +776,8 @@ static inline int eina_value_compare(const Eina_Value *a,
776/** 776/**
777 * @brief Sets the generic value. 777 * @brief Sets the generic value.
778 * 778 *
779 * @param value Source value object 779 * @param[in,out] value Source value object
780 * @param[in] ... Data to set.
780 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 781 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
781 * 782 *
782 * The variable argument is dependent on chosen type. The list for 783 * The variable argument is dependent on chosen type. The list for
@@ -836,7 +837,8 @@ static inline Eina_Bool eina_value_set(Eina_Value *value,
836/** 837/**
837 * @brief Gets the generic value. 838 * @brief Gets the generic value.
838 * 839 *
839 * @param value Source value object 840 * @param[in] value Source value object.
841 * @param[out] ... Data value retrieved.
840 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 842 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
841 * 843 *
842 * The value is returned in the variable argument parameter, the 844 * The value is returned in the variable argument parameter, the
@@ -904,8 +906,8 @@ static inline Eina_Bool eina_value_get(const Eina_Value *value,
904/** 906/**
905 * @brief Sets the generic value. 907 * @brief Sets the generic value.
906 * 908 *
907 * @param value Source value object 909 * @param[in,out] value Source value object
908 * @param args Variable argument 910 * @param[in] args Variable argument
909 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 911 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
910 * 912 *
911 * @note for array member see eina_value_array_vset() 913 * @note for array member see eina_value_array_vset()
@@ -924,8 +926,8 @@ static inline Eina_Bool eina_value_vset(Eina_Value *value,
924/** 926/**
925 * @brief Gets the generic value. 927 * @brief Gets the generic value.
926 * 928 *
927 * @param value Source value object 929 * @param[in] value Source value object
928 * @param args Variable argument 930 * @param[out] args Variable argument
929 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 931 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
930 * 932 *
931 * The value is returned in the variable argument parameter, the 933 * The value is returned in the variable argument parameter, the
@@ -948,8 +950,9 @@ static inline Eina_Bool eina_value_vget(const Eina_Value *value,
948 950
949/** 951/**
950 * @brief Sets the generic value from pointer. 952 * @brief Sets the generic value from pointer.
951 * @param value Source value object 953 *
952 * @param ptr Pointer to specify the contents. 954 * @param [in,out] value Source value object
955 * @param [in] ptr Pointer to specify the contents.
953 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 956 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
954 * 957 *
955 * The pointer type is dependent on chosen value type. The list for 958 * The pointer type is dependent on chosen value type. The list for
@@ -1013,8 +1016,8 @@ static inline Eina_Bool eina_value_pset(Eina_Value *value,
1013/** 1016/**
1014 * @brief Gets the generic value to pointer. 1017 * @brief Gets the generic value to pointer.
1015 * 1018 *
1016 * @param value Source value object 1019 * @param[in] value Source value object
1017 * @param ptr Pointer to receive the contents. 1020 * @param[out] ptr Pointer to receive the contents.
1018 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 1021 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
1019 * 1022 *
1020 * The value is returned in pointer contents, the actual value is 1023 * The value is returned in pointer contents, the actual value is
@@ -1082,8 +1085,8 @@ static inline Eina_Bool eina_value_pget(const Eina_Value *value,
1082/** 1085/**
1083 * @brief Converts one value to another type. 1086 * @brief Converts one value to another type.
1084 * 1087 *
1085 * @param value Source value object. 1088 * @param[in] value Source value object.
1086 * @param convert Destination value object. 1089 * @param[out] convert Destination value object.
1087 * @return #EINA_TRUE if converted, #EINA_FALSE otherwise. 1090 * @return #EINA_TRUE if converted, #EINA_FALSE otherwise.
1088 * 1091 *
1089 * Converts one value to another trying first @a value type 1092 * Converts one value to another trying first @a value type
@@ -1107,7 +1110,8 @@ EAPI Eina_Bool eina_value_convert(const Eina_Value *value,
1107 1110
1108/** 1111/**
1109 * @brief Converts one value to Eina_Binbuf. 1112 * @brief Converts one value to Eina_Binbuf.
1110 * @param value Source value object. 1113 *
1114 * @param[in,out] value Source value object.
1111 * @return @c NULL if it failed to get a memory content, a valid Eina_Binbuf otherwise. 1115 * @return @c NULL if it failed to get a memory content, a valid Eina_Binbuf otherwise.
1112 * 1116 *
1113 * Converts one value to EINA_TYPE_VALUE_BLOB if necessary by calling 1117 * Converts one value to EINA_TYPE_VALUE_BLOB if necessary by calling
@@ -1124,7 +1128,8 @@ EAPI Eina_Binbuf *eina_value_to_binbuf(Eina_Value *value);
1124 1128
1125/** 1129/**
1126 * @brief Converts value to string. 1130 * @brief Converts value to string.
1127 * @param value value object. 1131 *
1132 * @param[in] value value object.
1128 * @return newly allocated memory or @c NULL on failure. 1133 * @return newly allocated memory or @c NULL on failure.
1129 * 1134 *
1130 * @see eina_value_convert() 1135 * @see eina_value_convert()
@@ -1135,7 +1140,8 @@ EAPI char *eina_value_to_string(const Eina_Value *value) EINA_ARG_NONNULL(1);
1135 1140
1136/** 1141/**
1137 * @brief Queries value type. 1142 * @brief Queries value type.
1138 * @param value Value object. 1143 *
1144 * @param[in] value Value object.
1139 * @return Type instance, or @c NULL if type is invalid. 1145 * @return Type instance, or @c NULL if type is invalid.
1140 * 1146 *
1141 * Check if value type is valid and returns it. A type is invalid if 1147 * Check if value type is valid and returns it. A type is invalid if
diff --git a/src/lib/eina/eina_value_util.h b/src/lib/eina/eina_value_util.h
index 8cc0e5241a..9b4fff78b0 100644
--- a/src/lib/eina/eina_value_util.h
+++ b/src/lib/eina/eina_value_util.h
@@ -40,7 +40,7 @@ EAPI Eina_Value_Struct_Desc *eina_value_util_struct_desc_new(void);
40/** 40/**
41 * @brief Creates a new #Eina_Value containing the passed parameter. 41 * @brief Creates a new #Eina_Value containing the passed parameter.
42 * 42 *
43 * @param timestr The value to use 43 * @param[in] timestr The value to use
44 * @return The #Eina_Value 44 * @return The #Eina_Value
45 * 45 *
46 * @since 1.12 46 * @since 1.12