diff options
author | Jaehyun Cho <jae_hyun.cho@samsung.com> | 2017-10-26 13:49:07 +0900 |
---|---|---|
committer | Jaehyun Cho <jae_hyun.cho@samsung.com> | 2017-10-26 15:16:12 +0900 |
commit | 5ef408f49b5dd215ab5d751410b727832f08ddec (patch) | |
tree | f8b938c899ae109199ac43189c841cfeea0a9c86 /src/lib/eldbus/eldbus_connection.h | |
parent | ccbe98ccb2d8c1dd4ec2d2fc9523b7eb299612e5 (diff) | |
download | efl-5ef408f49b5dd215ab5d751410b727832f08ddec.tar.gz |
eldbus_connection: Add description of parameters to fix doxygen warning
Change-Id: I3be25d4b7c8bdb69c23c1c5071fac8ac1420d87d
Diffstat (limited to 'src/lib/eldbus/eldbus_connection.h')
-rw-r--r-- | src/lib/eldbus/eldbus_connection.h | 18 |
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 * @brief Add a callback function to be called when connection is freed * * @param conn The connection object to add the callback to. - * @param cb callback to be called - * @param data data passed to callback + * @param cb The callback to be called when the connection is free. + * @param data The data passed to the callback. */ EAPI void eldbus_connection_free_cb_add(Eldbus_Connection *conn, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); /** * @brief Remove callback registered in eldbus_connection_free_cb_add(). + * + * @param conn The connection object to delete the callback from. + * @param cb The callback that was called when the connection was free. + * @param data The data that was passed to the callback. */ EAPI void eldbus_connection_free_cb_del(Eldbus_Connection *conn, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); @@ -154,11 +158,21 @@ typedef void (*Eldbus_Connection_Event_Cb)(void *data, Eldbus_Connection *conn, /** * @brief Add a callback function to be called when an event occurs of the * type passed. + * + * @param conn The connection object to add the callback to. + * @param type The type of event that will trigger the callback. + * @param cb The callback to be called when the event is triggered. + * @param cb_data The data passed to the callback. */ EAPI 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); /** * @brief Remove callback registered in eldbus_connection_event_callback_add(). + * + * @param conn The connection object to delete the callback from. + * @param type The type of event that was triggered the callback. + * @param cb The callback that was called when the event was triggered. + * @param cb_data The data that was passed to the callback. */ EAPI 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); |