summaryrefslogtreecommitdiff
path: root/src/lib/eina
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2018-07-31 02:51:02 -0400
committerChris Michael <cp.michael@samsung.com>2018-07-31 02:51:02 -0400
commitdc2ad11281cd0d7a68696df80990612fc6b25b3b (patch)
treed2a67422e5d7cf9dda4faa9b83ef4dbb238b9167 /src/lib/eina
parent54907b199508f4a7b2058f683f1693993417b49b (diff)
eina: Add doxygen in/out tags for promise
Summary: Also, add some missing param docs, and fix some incorrect ones. Reviewers: devilhorns Reviewed By: devilhorns Subscribers: cedric, #committers, zmike Tags: #efl Differential Revision: https://phab.enlightenment.org/D6698
Diffstat (limited to 'src/lib/eina')
-rw-r--r--src/lib/eina/eina_promise.h114
1 files changed, 62 insertions, 52 deletions
diff --git a/src/lib/eina/eina_promise.h b/src/lib/eina/eina_promise.h
index 436856cc1b..769e02233e 100644
--- a/src/lib/eina/eina_promise.h
+++ b/src/lib/eina/eina_promise.h
@@ -41,14 +41,14 @@ typedef struct _Eina_Future_Cb_Log_Desc Eina_Future_Cb_Log_Desc;
41 * or similar failed due to invalid pointer or memory allocation. Then the callback is called from the 41 * or similar failed due to invalid pointer or memory allocation. Then the callback is called from the
42 * failed context using `EINVAL` or `ENOMEM` as errors and @p dead_future will be @c NULL. 42 * failed context using `EINVAL` or `ENOMEM` as errors and @p dead_future will be @c NULL.
43 * 43 *
44 * @param data The data provided by the user 44 * @param[in] data The data provided by the user
45 * 45 *
46 * @param value An Eina_Value which contains the operation result. Before using 46 * @param[in] value An Eina_Value which contains the operation result. Before using
47 * the @p value, its type must be checked in order to avoid errors. This is needed because 47 * the @p value, its type must be checked in order to avoid errors. This is needed because
48 * if an operation fails the Eina_Value type will be EINA_VALUE_TYPE_ERROR 48 * if an operation fails the Eina_Value type will be EINA_VALUE_TYPE_ERROR
49 * which is a different type than the expected operation result. 49 * which is a different type than the expected operation result.
50 * 50 *
51 * @param dead_future A pointer to the future that was completed. 51 * @param[in] dead_future A pointer to the future that was completed.
52 * 52 *
53 * @return An Eina_Value to pass to the next Eina_Future in the chain (if any). 53 * @return An Eina_Value to pass to the next Eina_Future in the chain (if any).
54 * If there is no need to convert the received value, it's @b recommended 54 * If there is no need to convert the received value, it's @b recommended
@@ -106,8 +106,8 @@ struct _Eina_Future_Schedule_Entry {
106 * A callback used by the Eina_Future_Scheduler to deliver 106 * A callback used by the Eina_Future_Scheduler to deliver
107 * the future operation result. 107 * the future operation result.
108 * 108 *
109 * @param f The delivered future. 109 * @param[out] f The delivered future.
110 * @param value The future result 110 * @param[in] value The future result
111 * 111 *
112 * 112 *
113 * @see eina_promise_new() 113 * @see eina_promise_new()
@@ -136,10 +136,10 @@ struct _Eina_Future_Scheduler {
136 * @note Must not be @c NULL 136 * @note Must not be @c NULL
137 * 137 *
138 * Must call back from a safe context using @p cb(f,value) 138 * Must call back from a safe context using @p cb(f,value)
139 * @param scheduler The scheduler to use. 139 * @param[in,out] scheduler The scheduler to use.
140 * @param cb The #Eina_Future_Scheduler_Cb to be called and deliver the @p f and @p value. 140 * @param[in] cb The #Eina_Future_Scheduler_Cb to be called and deliver the @p f and @p value.
141 * @param f The future to be delivered to @p cb 141 * @param[in] f The future to be delivered to @p cb
142 * @param value The value to be delivered to @p cb 142 * @param[in] value The value to be delivered to @p cb
143 * @return A scheduled entry or @c NULL on error 143 * @return A scheduled entry or @c NULL on error
144 */ 144 */
145 Eina_Future_Schedule_Entry *(*schedule)(Eina_Future_Scheduler *scheduler, Eina_Future_Scheduler_Cb cb, Eina_Future *f, Eina_Value value); 145 Eina_Future_Schedule_Entry *(*schedule)(Eina_Future_Scheduler *scheduler, Eina_Future_Scheduler_Cb cb, Eina_Future *f, Eina_Value value);
@@ -179,8 +179,8 @@ struct _Eina_Future_Scheduler {
179 * call yourself. It's only meant as cancellation, not a general 179 * call yourself. It's only meant as cancellation, not a general
180 * "free callback". 180 * "free callback".
181 * 181 *
182 * @param data The data provided by the user. 182 * @param[in] data The data provided by the user.
183 * @param dead_promise The canceled promise. 183 * @param[in] dead_promise The canceled promise.
184 * @see eina_promise_reject() 184 * @see eina_promise_reject()
185 * @see eina_promise_resolve() 185 * @see eina_promise_resolve()
186 * @see eina_future_cancel() 186 * @see eina_future_cancel()
@@ -201,8 +201,8 @@ typedef void (*Eina_Promise_Cancel_Cb) (void *data, const Eina_Promise *dead_pro
201 * 201 *
202 * @note This function is always called from a safe context (main loop or some platform defined safe context). 202 * @note This function is always called from a safe context (main loop or some platform defined safe context).
203 * 203 *
204 * @param data The data provided by the user. 204 * @param[in] data The data provided by the user.
205 * @param value The operation result 205 * @param[in] value The operation result
206 * @return An Eina_Value to pass to the next Eina_Future in the chain (if any). 206 * @return An Eina_Value to pass to the next Eina_Future in the chain (if any).
207 * If there is no need to convert the received value, it's @b recommended 207 * If there is no need to convert the received value, it's @b recommended
208 * to pass-thru @p value argument. If you need to convert to a different type 208 * to pass-thru @p value argument. If you need to convert to a different type
@@ -239,8 +239,8 @@ typedef Eina_Value (*Eina_Future_Success_Cb)(void *data, const Eina_Value value)
239 * if an Eina_Value type EINA_VALUE_TYPE_ERROR is returned the error will continue to be reported 239 * if an Eina_Value type EINA_VALUE_TYPE_ERROR is returned the error will continue to be reported
240 * to the other futures in the chain. 240 * to the other futures in the chain.
241 * 241 *
242 * @param data The data provided by the user. 242 * @param[in] data The data provided by the user.
243 * @param error The operation error 243 * @param[in] error The operation error
244 * @return An Eina_Value to pass to the next Eina_Future in the chain (if any). 244 * @return An Eina_Value to pass to the next Eina_Future in the chain (if any).
245 * If you need to convert to a different type or generate a new value, 245 * If you need to convert to a different type or generate a new value,
246 * use @c eina_value_setup() on @b another Eina_Value 246 * use @c eina_value_setup() on @b another Eina_Value
@@ -268,8 +268,8 @@ typedef Eina_Value (*Eina_Future_Error_Cb)(void *data, const Eina_Error error);
268 * @note This callback is always called, even if #Eina_Future_Error_Cb and/or #Eina_Future_Success_Cb 268 * @note This callback is always called, even if #Eina_Future_Error_Cb and/or #Eina_Future_Success_Cb
269 * were not provided, which can also be used to monitor when a future ends. 269 * were not provided, which can also be used to monitor when a future ends.
270 * 270 *
271 * @param data The data provided by the user. 271 * @param[in] data The data provided by the user.
272 * @param dead_future The future that was freed. 272 * @param[in] dead_future The future that was freed.
273 * 273 *
274 * @see eina_future_cb_easy_from_desc() 274 * @see eina_future_cb_easy_from_desc()
275 * @see eina_future_cb_easy() 275 * @see eina_future_cb_easy()
@@ -525,9 +525,10 @@ struct _Eina_Future_Desc {
525 * resolve to it directly use the eina_future_resolved(), it has the 525 * resolve to it directly use the eina_future_resolved(), it has the
526 * same effect as creating a promise and immediately resolving it. 526 * same effect as creating a promise and immediately resolving it.
527 * 527 *
528 * @param cancel_cb A callback used to inform that the promise was canceled. Use 528 * @param[in,out] scheduler The scheduler.
529 * @param[in] cancel_cb A callback used to inform that the promise was canceled. Use
529 * this callback to @c free @p data. @p cancel_cb must not be @c NULL ! 530 * this callback to @c free @p data. @p cancel_cb must not be @c NULL !
530 * @param data Data to @p cancel_cb. 531 * @param[in] data Data to @p cancel_cb.
531 * @return A promise or @c NULL on error. 532 * @return A promise or @c NULL on error.
532 * @see eina_future_cancel() 533 * @see eina_future_cancel()
533 * @see eina_future_new() 534 * @see eina_future_new()
@@ -591,10 +592,10 @@ EAPI Eina_Promise *eina_promise_new(Eina_Future_Scheduler *scheduler, Eina_Promi
591 * @note This function is to be used solely inside of a future resolve callback with 592 * @note This function is to be used solely inside of a future resolve callback with
592 * the Eina_Value being returned from it. 593 * the Eina_Value being returned from it.
593 * 594 *
594 * @param dead_future The future being resolved to get a scheduler from. 595 * @param[in] dead_future The future being resolved to get a scheduler from.
595 * @param cancel_cb A callback used to inform that the promise was canceled. Use 596 * @param[in] cancel_cb A callback used to inform that the promise was canceled. Use
596 * this callback to @c free @p data. @p cancel_cb must not be @c NULL ! 597 * this callback to @c free @p data. @p cancel_cb must not be @c NULL !
597 * @param data Data to @p cancel_cb. 598 * @param[in] data Data to @p cancel_cb.
598 * @return A promise or @c NULL on error. 599 * @return A promise or @c NULL on error.
599 * @see eina_future_cancel() 600 * @see eina_future_cancel()
600 * @see eina_future_new() 601 * @see eina_future_new()
@@ -634,8 +635,10 @@ EAPI void eina_promise_data_set(Eina_Promise *p, void *data) EINA_ARG_NONNULL(1)
634 * safe context (main loop or some platform defined safe context), 635 * safe context (main loop or some platform defined safe context),
635 * whenever possible the future callbacks will be dispatched. 636 * whenever possible the future callbacks will be dispatched.
636 * 637 *
637 * @param p A promise to resolve. 638 * @param[in,out] p A promise to resolve.
638 * @param value The value to be delivered. Note that the value contents must survive this function scope, 639 * @param[in] value The value to be delivered.
640 *
641 * Note that the @p value contents must survive this function scope,
639 * that is, do @b not use stack allocated blobs, arrays, structures or types that 642 * that is, do @b not use stack allocated blobs, arrays, structures or types that
640 * keep references to memory you give. Values will be automatically cleaned up 643 * keep references to memory you give. Values will be automatically cleaned up
641 * using @c eina_value_flush() once they are unused (no more future or futures 644 * using @c eina_value_flush() once they are unused (no more future or futures
@@ -655,8 +658,8 @@ EAPI void eina_promise_resolve(Eina_Promise *p, Eina_Value value) EINA_ARG_NONNU
655 * safe context (main loop or some platform defined safe context), 658 * safe context (main loop or some platform defined safe context),
656 * whenever possible the future callbacks will be dispatched. 659 * whenever possible the future callbacks will be dispatched.
657 * 660 *
658 * @param p A promise to reject. 661 * @param[in,out] p A promise to reject.
659 * @param err An Eina_Error value 662 * @param[in] err An Eina_Error value
660 * @note Internally this function will create an Eina_Value with type #EINA_VALUE_TYPE_ERROR. 663 * @note Internally this function will create an Eina_Value with type #EINA_VALUE_TYPE_ERROR.
661 * 664 *
662 * @see eina_promise_new() 665 * @see eina_promise_new()
@@ -679,7 +682,7 @@ EAPI void eina_promise_reject(Eina_Promise *p, Eina_Error err) EINA_ARG_NONNULL(
679 * and it will also cancel the promise linked against it. The Eina_Future_Cb will be called 682 * and it will also cancel the promise linked against it. The Eina_Future_Cb will be called
680 * with an Eina_Value typed as #EINA_VALUE_TYPE_ERROR, which its value will be 683 * with an Eina_Value typed as #EINA_VALUE_TYPE_ERROR, which its value will be
681 * ECANCELED 684 * ECANCELED
682 * @param f The future to cancel. 685 * @param[in,out] f The future to cancel.
683 * @{ 686 * @{
684 */ 687 */
685EAPI void eina_future_cancel(Eina_Future *f) EINA_ARG_NONNULL(1); 688EAPI void eina_future_cancel(Eina_Future *f) EINA_ARG_NONNULL(1);
@@ -690,7 +693,7 @@ EAPI void eina_future_cancel(Eina_Future *f) EINA_ARG_NONNULL(1);
690 * This function is mainly used by bindings to flush a #Eina_Future_Desc. 693 * This function is mainly used by bindings to flush a #Eina_Future_Desc.
691 * It will call the #Eina_Future_Cb with `ENOMEM` and zero the @p desc contents. 694 * It will call the #Eina_Future_Cb with `ENOMEM` and zero the @p desc contents.
692 * 695 *
693 * @param desc The #Eina_Future_Desc to flush, if @c NULL this is a noop. 696 * @param[in,out] desc The #Eina_Future_Desc to flush, if @c NULL this is a noop.
694 */ 697 */
695EAPI void eina_future_desc_flush(Eina_Future_Desc *desc); 698EAPI void eina_future_desc_flush(Eina_Future_Desc *desc);
696 699
@@ -701,7 +704,7 @@ EAPI void eina_future_desc_flush(Eina_Future_Desc *desc);
701 * It will call the #Eina_Future_Error_Cb with `ENOMEM`, the #Eina_Future_Free_Cb and 704 * It will call the #Eina_Future_Error_Cb with `ENOMEM`, the #Eina_Future_Free_Cb and
702 * zero the @p desc contents. 705 * zero the @p desc contents.
703 * 706 *
704 * @param desc The #Eina_Future_Cb_Easy_Desc to flush, if @c NULL this is a noop. 707 * @param[in,out] desc The #Eina_Future_Cb_Easy_Desc to flush, if @c NULL this is a noop.
705 */ 708 */
706EAPI void eina_future_cb_easy_desc_flush(Eina_Future_Cb_Easy_Desc *desc); 709EAPI void eina_future_cb_easy_desc_flush(Eina_Future_Cb_Easy_Desc *desc);
707 710
@@ -775,7 +778,9 @@ EAPI void eina_future_cb_easy_desc_flush(Eina_Future_Cb_Easy_Desc *desc);
775 * } 778 * }
776 * @endcode 779 * @endcode
777 * 780 *
781 * @param[in,out] p The promise obect to create the value from.
778 * @return An Eina_Value. On error the value's type will be @c NULL. 782 * @return An Eina_Value. On error the value's type will be @c NULL.
783 *
779 * @note If an error happens the promise will be CANCELED. 784 * @note If an error happens the promise will be CANCELED.
780 * @see eina_future_as_value() 785 * @see eina_future_as_value()
781 * @see eina_promise_reject() 786 * @see eina_promise_reject()
@@ -789,7 +794,7 @@ EAPI Eina_Value eina_promise_as_value(Eina_Promise *p) EINA_ARG_NONNULL(1) EINA_
789 * This function is used for the same purposes as eina_promise_as_value(), 794 * This function is used for the same purposes as eina_promise_as_value(),
790 * but receives an Eina_Future instead. 795 * but receives an Eina_Future instead.
791 * 796 *
792 * @param f A future to create a Eina_Value from. 797 * @param[in,out] f A future to create a Eina_Value from.
793 * @return An Eina_Value. On error the value's type will be @c NULL. 798 * @return An Eina_Value. On error the value's type will be @c NULL.
794 * @note If an error happens the future @p f will be CANCELED 799 * @note If an error happens the future @p f will be CANCELED
795 * @see eina_promise_as_value() 800 * @see eina_promise_as_value()
@@ -811,7 +816,7 @@ EAPI Eina_Value eina_future_as_value(Eina_Future *f)EINA_ARG_NONNULL(1) EINA_WAR
811 * result in an error (@c NULL is returned) and the future 816 * result in an error (@c NULL is returned) and the future
812 * attached to the promise will be canceled! 817 * attached to the promise will be canceled!
813 * 818 *
814 * @param p A promise used to attach a future. May not be @c NULL. 819 * @param[in,out] p A promise used to attach a future. May not be @c NULL.
815 * @return The future or @c NULL on error. 820 * @return The future or @c NULL on error.
816 * @note If an error happens this function will CANCEL the promise. 821 * @note If an error happens this function will CANCEL the promise.
817 * @see eina_promise_new() 822 * @see eina_promise_new()
@@ -835,8 +840,8 @@ EAPI Eina_Future *eina_future_new(Eina_Promise *p) EINA_ARG_NONNULL(1) EINA_WARN
835 * cause the whole chain to be canceled alongside with any pending 840 * cause the whole chain to be canceled alongside with any pending
836 * promise. 841 * promise.
837 * 842 *
838 * @param scheduler The scheduler to use. 843 * @param[in,out] scheduler The scheduler to use.
839 * @param value The value to be delivered. Note that the value 844 * @param[in] value The value to be delivered. Note that the value
840 * contents must survive this function scope, that is, do @b not use 845 * contents must survive this function scope, that is, do @b not use
841 * stack allocated blobs, arrays, structures or types that keep 846 * stack allocated blobs, arrays, structures or types that keep
842 * references to memory you give. Values will be automatically cleaned 847 * references to memory you give. Values will be automatically cleaned
@@ -867,8 +872,8 @@ EAPI Eina_Future *eina_future_resolved(Eina_Future_Scheduler *scheduler, Eina_Va
867 * cause the whole chain to be canceled alongside with any pending 872 * cause the whole chain to be canceled alongside with any pending
868 * promise. 873 * promise.
869 * 874 *
870 * @param scheduler The scheduler to use. 875 * @param[in,out] scheduler The scheduler to use.
871 * @param err An Eina_Error value 876 * @param[in] err An Eina_Error value
872 * 877 *
873 * @return The future or @c NULL on error. 878 * @return The future or @c NULL on error.
874 * 879 *
@@ -1015,8 +1020,8 @@ EAPI Eina_Future *eina_future_rejected(Eina_Future_Scheduler *scheduler, Eina_Er
1015 * @note This example does manual conversion and print, however we offer 1020 * @note This example does manual conversion and print, however we offer
1016 * eina_future_cb_convert_to() and eina_future_cb_console_from_desc() and to make those common case easier. 1021 * eina_future_cb_convert_to() and eina_future_cb_console_from_desc() and to make those common case easier.
1017 * 1022 *
1018 * @param prev A future to link against 1023 * @param[in,out] prev A future to link against
1019 * @param desc A description struct containing the callback and data. 1024 * @param[in] desc A description struct containing the callback and data.
1020 * @return A new future or @c NULL on error. 1025 * @return A new future or @c NULL on error.
1021 * @note If an error happens the whole future chain will CANCELED and 1026 * @note If an error happens the whole future chain will CANCELED and
1022 * desc.cb will be called in order to free desc.data. 1027 * desc.cb will be called in order to free desc.data.
@@ -1053,7 +1058,7 @@ EAPI Eina_Future *eina_future_then_from_desc(Eina_Future *prev, const Eina_Futur
1053 * @li #Eina_Future_Cb_Log_Desc::line: The __LINE__ macro will be used. 1058 * @li #Eina_Future_Cb_Log_Desc::line: The __LINE__ macro will be used.
1054 * 1059 *
1055 * 1060 *
1056 * @param desc The description data to be used. 1061 * @param[in] desc The description data to be used.
1057 * @return An #Eina_Future_Desc 1062 * @return An #Eina_Future_Desc
1058 * 1063 *
1059 * @see #Eina_Future_Cb_Log_Desc 1064 * @see #Eina_Future_Cb_Log_Desc
@@ -1099,8 +1104,8 @@ EAPI Eina_Future_Desc eina_future_cb_log_from_desc(const Eina_Future_Cb_Log_Desc
1099 * } 1104 * }
1100 * @endcode 1105 * @endcode
1101 * 1106 *
1102 * @param prev The previous future 1107 * @param[in,out] prev The previous future
1103 * @param descs An array of descriptions. The last element of the array must have the #Eina_Future_Desc::cb set to @c NULL 1108 * @param[in] descs An array of descriptions. The last element of the array must have the #Eina_Future_Desc::cb set to @c NULL
1104 * @return A future or @c NULL on error. 1109 * @return A future or @c NULL on error.
1105 * @note If an error happens the whole future chain will CANCELED and 1110 * @note If an error happens the whole future chain will CANCELED and
1106 * desc.cb will be called in order to free desc.data. 1111 * desc.cb will be called in order to free desc.data.
@@ -1127,8 +1132,8 @@ EAPI Eina_Future *eina_future_chain_array(Eina_Future *prev, const Eina_Future_D
1127 * check the macro eina_future_chain_easy() for a syntax sugar. 1132 * check the macro eina_future_chain_easy() for a syntax sugar.
1128 * 1133 *
1129 * 1134 *
1130 * @param prev The previous future 1135 * @param[in,out] prev The previous future
1131 * @param descs An array of descriptions. The last element of the array must have the #Eina_Future_Desc::cb set to @c NULL 1136 * @param[in] descs An array of descriptions. The last element of the array must have the #Eina_Future_Desc::cb set to @c NULL
1132 * @return A future or @c NULL on error. 1137 * @return A future or @c NULL on error.
1133 * @note If an error happens the whole future chain will CANCELED and 1138 * @note If an error happens the whole future chain will CANCELED and
1134 * desc.cb will be called in order to free desc.data. 1139 * desc.cb will be called in order to free desc.data.
@@ -1162,11 +1167,14 @@ EAPI Eina_Future *eina_future_chain_easy_array(Eina_Future *prev, const Eina_Fut
1162 * eina_future_cb_console("cb2 value:", " cb2 value suffix\n")) 1167 * eina_future_cb_console("cb2 value:", " cb2 value suffix\n"))
1163 * @endcode 1168 * @endcode
1164 * 1169 *
1165 * @param prefix A prefix to print, if @c NULL an empty string ("") is used. 1170 * @param[in] desc Description object with contextual information.
1166 * @param suffix A suffix to print. If @c NULL '\n' will be used. If suffix is provided
1167 * the '\n' must be provided by suffix otherwise the printed text will not contain
1168 * a line feed.
1169 * @return An #Eina_Future_Desc 1171 * @return An #Eina_Future_Desc
1172 *
1173 * The description object, @p desc, can (optionally) include a prefix, suffix,
1174 * filename and function name. If these are @c NULL, empty strings ("") are used
1175 * instead. If @p desc->suffix is provided, the '\n' should be provided to ensure
1176 * the printed string ends with a line feed.
1177 *
1170 * @see eina_future_then() 1178 * @see eina_future_then()
1171 * @see #Eina_Future_Desc 1179 * @see #Eina_Future_Desc
1172 * @see eina_future_chain() 1180 * @see eina_future_chain()
@@ -1187,7 +1195,7 @@ EAPI Eina_Future_Desc eina_future_cb_console_from_desc(const Eina_Future_Cb_Cons
1187 * specified error happens an EINA_VALUE_EMPTY will be delivered to the 1195 * specified error happens an EINA_VALUE_EMPTY will be delivered to the
1188 * next future in the chain. 1196 * next future in the chain.
1189 * 1197 *
1190 * @param err The error to be ignored. 1198 * @param[in] err The error to be ignored.
1191 * @param A future descriptor to be used with eina_future_then() or eina_future_chain() 1199 * @param A future descriptor to be used with eina_future_then() or eina_future_chain()
1192 */ 1200 */
1193EAPI Eina_Future_Desc eina_future_cb_ignore_error(Eina_Error err); 1201EAPI Eina_Future_Desc eina_future_cb_ignore_error(Eina_Error err);
@@ -1195,7 +1203,7 @@ EAPI Eina_Future_Desc eina_future_cb_ignore_error(Eina_Error err);
1195/** 1203/**
1196 * Creates an #Eina_Future_Desc which will convert the the received eina value to a given type. 1204 * Creates an #Eina_Future_Desc which will convert the the received eina value to a given type.
1197 * 1205 *
1198 * @param type The Eina_Value_Type to convert to. 1206 * @param[in] type The Eina_Value_Type to convert to.
1199 * @return An #Eina_Future_Desc 1207 * @return An #Eina_Future_Desc
1200 * @see eina_future_then() 1208 * @see eina_future_then()
1201 * @see #Eina_Future_Desc 1209 * @see #Eina_Future_Desc
@@ -1274,7 +1282,9 @@ EAPI Eina_Future_Desc eina_future_cb_convert_to(const Eina_Value_Type *type);
1274 * } 1282 * }
1275 * @endcode 1283 * @endcode
1276 * 1284 *
1285 * @param[in] desc The easy callback's description.
1277 * @return An #Eina_Future_Desc 1286 * @return An #Eina_Future_Desc
1287 *
1278 * @see eina_future_chain() 1288 * @see eina_future_chain()
1279 * @see eina_future_then() 1289 * @see eina_future_then()
1280 * @see eina_future_cb_easy() 1290 * @see eina_future_cb_easy()
@@ -1376,7 +1386,7 @@ EAPI Eina_Future_Desc eina_future_cb_easy_from_desc(const Eina_Future_Cb_Easy_De
1376 * } 1386 * }
1377 * @endcode 1387 * @endcode
1378 * 1388 *
1379 * @param array An array of futures, @c #EINA_FUTURE_SENTINEL terminated. 1389 * @param[in,out] array An array of futures, @c #EINA_FUTURE_SENTINEL terminated.
1380 * @return A promise or @c NULL on error. 1390 * @return A promise or @c NULL on error.
1381 * @note On error all the futures will be CANCELED. 1391 * @note On error all the futures will be CANCELED.
1382 * @see eina_future_all_array() 1392 * @see eina_future_all_array()
@@ -1488,7 +1498,7 @@ EAPI Eina_Promise *eina_promise_all_array(Eina_Future *array[]) EINA_ARG_NONNULL
1488 * } 1498 * }
1489 * @endcode 1499 * @endcode
1490 * 1500 *
1491 * @param array An array of futures, @c #EINA_FUTURE_SENTINEL terminated. 1501 * @param[in,out] array An array of futures, @c #EINA_FUTURE_SENTINEL terminated.
1492 * @return A promise or @c NULL on error. 1502 * @return A promise or @c NULL on error.
1493 * @note On error all the futures will be CANCELED. 1503 * @note On error all the futures will be CANCELED.
1494 * @see eina_future_race_array() 1504 * @see eina_future_race_array()
@@ -1556,7 +1566,7 @@ EAPI extern const Eina_Value_Struct_Desc *EINA_PROMISE_RACE_STRUCT_DESC;
1556 * Creates a future that will be resolved once all futures from @p array is resolved. 1566 * Creates a future that will be resolved once all futures from @p array is resolved.
1557 * This is a helper over eina_promise_all_array() 1567 * This is a helper over eina_promise_all_array()
1558 * 1568 *
1559 * @param array A future array, must be terminated with #EINA_FUTURE_SENTINEL 1569 * @param[in,out] array A future array, must be terminated with #EINA_FUTURE_SENTINEL
1560 * @return A future. 1570 * @return A future.
1561 * @see eina_promise_all_array() 1571 * @see eina_promise_all_array()
1562 * @see #EINA_FUTURE_SENTINEL 1572 * @see #EINA_FUTURE_SENTINEL
@@ -1573,7 +1583,7 @@ eina_future_all_array(Eina_Future *array[])
1573 * Creates a future that will be resolved once a future @p array is resolved. 1583 * Creates a future that will be resolved once a future @p array is resolved.
1574 * This is a helper over eina_promise_race_array() 1584 * This is a helper over eina_promise_race_array()
1575 * 1585 *
1576 * @param array A future array, must be terminated with #EINA_FUTURE_SENTINEL 1586 * @param[in,out] array A future array, must be terminated with #EINA_FUTURE_SENTINEL
1577 * @return A future. 1587 * @return A future.
1578 * @see eina_promise_race_array() 1588 * @see eina_promise_race_array()
1579 * @see #EINA_FUTURE_SENTINEL 1589 * @see #EINA_FUTURE_SENTINEL