summaryrefslogtreecommitdiff
path: root/src/lib/eldbus
diff options
context:
space:
mode:
authorJaehyun Cho <jae_hyun.cho@samsung.com>2017-10-26 13:49:07 +0900
committerJaehyun Cho <jae_hyun.cho@samsung.com>2017-10-26 15:16:12 +0900
commit5ef408f49b5dd215ab5d751410b727832f08ddec (patch)
treef8b938c899ae109199ac43189c841cfeea0a9c86 /src/lib/eldbus
parentccbe98ccb2d8c1dd4ec2d2fc9523b7eb299612e5 (diff)
eldbus_connection: Add description of parameters to fix doxygen warning
Change-Id: I3be25d4b7c8bdb69c23c1c5071fac8ac1420d87d
Diffstat (limited to 'src/lib/eldbus')
-rw-r--r--src/lib/eldbus/eldbus_connection.h18
1 files changed, 16 insertions, 2 deletions
diff --git a/src/lib/eldbus/eldbus_connection.h b/src/lib/eldbus/eldbus_connection.h
index 10995a7081..5615162028 100644
--- a/src/lib/eldbus/eldbus_connection.h
+++ b/src/lib/eldbus/eldbus_connection.h
@@ -94,13 +94,17 @@ EAPI void eldbus_connection_unref(Eldbus_Connection *conn) EINA_ARG
94 * @brief Add a callback function to be called when connection is freed 94 * @brief Add a callback function to be called when connection is freed
95 * 95 *
96 * @param conn The connection object to add the callback to. 96 * @param conn The connection object to add the callback to.
97 * @param cb callback to be called 97 * @param cb The callback to be called when the connection is free.
98 * @param data data passed to callback 98 * @param data The data passed to the callback.
99 */ 99 */
100EAPI void eldbus_connection_free_cb_add(Eldbus_Connection *conn, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); 100EAPI void eldbus_connection_free_cb_add(Eldbus_Connection *conn, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2);
101 101
102/** 102/**
103 * @brief Remove callback registered in eldbus_connection_free_cb_add(). 103 * @brief Remove callback registered in eldbus_connection_free_cb_add().
104 *
105 * @param conn The connection object to delete the callback from.
106 * @param cb The callback that was called when the connection was free.
107 * @param data The data that was passed to the callback.
104 */ 108 */
105EAPI void eldbus_connection_free_cb_del(Eldbus_Connection *conn, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); 109EAPI void eldbus_connection_free_cb_del(Eldbus_Connection *conn, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2);
106 110
@@ -154,11 +158,21 @@ typedef void (*Eldbus_Connection_Event_Cb)(void *data, Eldbus_Connection *conn,
154/** 158/**
155 * @brief Add a callback function to be called when an event occurs of the 159 * @brief Add a callback function to be called when an event occurs of the
156 * type passed. 160 * type passed.
161 *
162 * @param conn The connection object to add the callback to.
163 * @param type The type of event that will trigger the callback.
164 * @param cb The callback to be called when the event is triggered.
165 * @param cb_data The data passed to the callback.
157 */ 166 */
158EAPI void eldbus_connection_event_callback_add(Eldbus_Connection *conn, Eldbus_Connection_Event_Type type, Eldbus_Connection_Event_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 3); 167EAPI void eldbus_connection_event_callback_add(Eldbus_Connection *conn, Eldbus_Connection_Event_Type type, Eldbus_Connection_Event_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 3);
159 168
160/** 169/**
161 * @brief Remove callback registered in eldbus_connection_event_callback_add(). 170 * @brief Remove callback registered in eldbus_connection_event_callback_add().
171 *
172 * @param conn The connection object to delete the callback from.
173 * @param type The type of event that was triggered the callback.
174 * @param cb The callback that was called when the event was triggered.
175 * @param cb_data The data that was passed to the callback.
162 */ 176 */
163EAPI void eldbus_connection_event_callback_del(Eldbus_Connection *conn, Eldbus_Connection_Event_Type type, Eldbus_Connection_Event_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 3); 177EAPI void eldbus_connection_event_callback_del(Eldbus_Connection *conn, Eldbus_Connection_Event_Type type, Eldbus_Connection_Event_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 3);
164 178