summaryrefslogtreecommitdiff
path: root/src/lib/eldbus
diff options
context:
space:
mode:
authorJinYong Park <j4939.park@samsung.com>2017-10-26 11:54:13 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-10-26 12:17:41 +0900
commitb7359e7ff527823eb753a1b49d62753c8d84d4ed (patch)
treea63416d20653faef9fa5cd908468c6a25a7a5a75 /src/lib/eldbus
parent157daefd5bff87933b576c7f3eb473fc8824cf1d (diff)
eldbus signal handler: add param, return type description for doxygen
Summary: Add omitted description to eldbus signal handler for doxygen warning Test Plan: API Doxygen Revision Reviewers: raster, cedric, jpeg, myoungwoon, Jaehyun_Cho Differential Revision: https://phab.enlightenment.org/D5379
Diffstat (limited to 'src/lib/eldbus')
-rw-r--r--src/lib/eldbus/eldbus_signal_handler.h22
1 files changed, 22 insertions, 0 deletions
diff --git a/src/lib/eldbus/eldbus_signal_handler.h b/src/lib/eldbus/eldbus_signal_handler.h
index b842bfcac9..7e6435360e 100644
--- a/src/lib/eldbus/eldbus_signal_handler.h
+++ b/src/lib/eldbus/eldbus_signal_handler.h
@@ -18,17 +18,25 @@
18 * @param member name of the signal 18 * @param member name of the signal
19 * @param cb callback that will be called when this signal is received 19 * @param cb callback that will be called when this signal is received
20 * @param cb_data data that will be passed to callback 20 * @param cb_data data that will be passed to callback
21 *
22 * @return signal handler
21 */ 23 */
22EAPI Eldbus_Signal_Handler *eldbus_signal_handler_add(Eldbus_Connection *conn, const char *sender, const char *path, const char *interface, const char *member, Eldbus_Signal_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 6); 24EAPI Eldbus_Signal_Handler *eldbus_signal_handler_add(Eldbus_Connection *conn, const char *sender, const char *path, const char *interface, const char *member, Eldbus_Signal_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 6);
23 25
24/** 26/**
25 * @brief Increase signal handler reference. 27 * @brief Increase signal handler reference.
28 *
29 * @param handler signal handler
30 *
31 * @return the same signal handler, @p handler
26 */ 32 */
27EAPI Eldbus_Signal_Handler *eldbus_signal_handler_ref(Eldbus_Signal_Handler *handler) EINA_ARG_NONNULL(1); 33EAPI Eldbus_Signal_Handler *eldbus_signal_handler_ref(Eldbus_Signal_Handler *handler) EINA_ARG_NONNULL(1);
28 34
29/** 35/**
30 * @brief Decrease signal handler reference. 36 * @brief Decrease signal handler reference.
31 * If reference == 0 signal handler will be freed. 37 * If reference == 0 signal handler will be freed.
38 *
39 * @param handler signal handler
32 */ 40 */
33EAPI void eldbus_signal_handler_unref(Eldbus_Signal_Handler *handler) EINA_ARG_NONNULL(1); 41EAPI void eldbus_signal_handler_unref(Eldbus_Signal_Handler *handler) EINA_ARG_NONNULL(1);
34 42
@@ -36,6 +44,8 @@ EAPI void eldbus_signal_handler_unref(Eldbus_Signal_Handler *ha
36 * @brief Decrease signal handler reference like eldbus_signal_handler_unref() 44 * @brief Decrease signal handler reference like eldbus_signal_handler_unref()
37 * but if reference > 0 this signal handler will stop listening to signals. In other 45 * but if reference > 0 this signal handler will stop listening to signals. In other
38 * words it will be canceled but memory will not be freed. 46 * words it will be canceled but memory will not be freed.
47 *
48 * @param handler signal handler to delete
39 */ 49 */
40EAPI void eldbus_signal_handler_del(Eldbus_Signal_Handler *handler) EINA_ARG_NONNULL(1); 50EAPI void eldbus_signal_handler_del(Eldbus_Signal_Handler *handler) EINA_ARG_NONNULL(1);
41 51
@@ -52,6 +62,8 @@ EAPI void eldbus_signal_handler_del(Eldbus_Signal_Handler *hand
52 * @param sh signal handler 62 * @param sh signal handler
53 * @param ... variadic of key and value and must be ended with a NULL 63 * @param ... variadic of key and value and must be ended with a NULL
54 * 64 *
65 * @return EINA_TRUE if success
66 *
55 * @note For more information: 67 * @note For more information:
56 * http://dbus.freedesktop.org/doc/dbus-specification.html#message-bus-routing-match-rules 68 * http://dbus.freedesktop.org/doc/dbus-specification.html#message-bus-routing-match-rules
57 */ 69 */
@@ -70,6 +82,8 @@ EAPI Eina_Bool eldbus_signal_handler_match_extra_set(Eldbus_Signal_H
70 * @param sh signal handler 82 * @param sh signal handler
71 * @param ap va_list with the keys and values, must be ended with a NULL 83 * @param ap va_list with the keys and values, must be ended with a NULL
72 * 84 *
85 * @return EINA_TRUE if success
86 *
73 * @note To information: 87 * @note To information:
74 * http://dbus.freedesktop.org/doc/dbus-specification.html#message-bus-routing-match-rules 88 * http://dbus.freedesktop.org/doc/dbus-specification.html#message-bus-routing-match-rules
75 */ 89 */
@@ -77,11 +91,19 @@ EAPI Eina_Bool eldbus_signal_handler_match_extra_vset(Eldbus_Signal_
77 91
78/** 92/**
79 * @brief Add a callback function to be called when signal handler will be freed. 93 * @brief Add a callback function to be called when signal handler will be freed.
94 *
95 * @param handler signal handler
96 * @param cb callback that will be called when this signal handler is freed
97 * @param data data that will be passed to callback
80 */ 98 */
81EAPI void eldbus_signal_handler_free_cb_add(Eldbus_Signal_Handler *handler, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); 99EAPI void eldbus_signal_handler_free_cb_add(Eldbus_Signal_Handler *handler, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2);
82 100
83/** 101/**
84 * @brief Remove callback registered in eldbus_signal_handler_free_cb_add(). 102 * @brief Remove callback registered in eldbus_signal_handler_free_cb_add().
103 *
104 * @param handler signal handler
105 * @param cb registered callback to remove
106 * @param data data that will be passed to callback
85 */ 107 */
86EAPI void eldbus_signal_handler_free_cb_del(Eldbus_Signal_Handler *handler, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); 108EAPI void eldbus_signal_handler_free_cb_del(Eldbus_Signal_Handler *handler, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2);
87 109