summaryrefslogtreecommitdiff
path: root/src/lib/eldbus/eldbus_service.h
diff options
context:
space:
mode:
authorJinYong Park <j4939.park@samsung.com>2017-10-26 11:54:04 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-10-26 12:17:41 +0900
commit157daefd5bff87933b576c7f3eb473fc8824cf1d (patch)
tree0f08b5c3239e4776a798292d00099dff8504df06 /src/lib/eldbus/eldbus_service.h
parente784afbd8806790d15a768c5e04fef935c2c2668 (diff)
eldbus-service: add parameters and return type description for doxygen
Summary: Add omitted descriptions for doxygen warning Test Plan: API Doxygen Revision Reviewers: raster, cedric, jpeg, myoungwoon, Jaehyun_Cho Differential Revision: https://phab.enlightenment.org/D5378
Diffstat (limited to 'src/lib/eldbus/eldbus_service.h')
-rw-r--r--src/lib/eldbus/eldbus_service.h17
1 files changed, 16 insertions, 1 deletions
diff --git a/src/lib/eldbus/eldbus_service.h b/src/lib/eldbus/eldbus_service.h
index ba5a9a3..febf67d 100644
--- a/src/lib/eldbus/eldbus_service.h
+++ b/src/lib/eldbus/eldbus_service.h
@@ -182,12 +182,16 @@ eldbus_service_interface_fallback_register2(Eldbus_Connection *conn, const char
182 * @brief Unregister a interface. 182 * @brief Unregister a interface.
183 * Note: This doesn't unregister the object path if interface count reaches 0. 183 * Note: This doesn't unregister the object path if interface count reaches 0.
184 * Use eldbus_service_object_unregister() to unregister the object. 184 * Use eldbus_service_object_unregister() to unregister the object.
185 *
186 * @param iface interface to unregister
185 */ 187 */
186EAPI void eldbus_service_interface_unregister(Eldbus_Service_Interface *iface) EINA_ARG_NONNULL(1); 188EAPI void eldbus_service_interface_unregister(Eldbus_Service_Interface *iface) EINA_ARG_NONNULL(1);
187 189
188/** 190/**
189 * @brief Unregister all interfaces of the object path that this interface belongs 191 * @brief Unregister all interfaces of the object path that this interface belongs
190 * and the object path. 192 * and the object path.
193 *
194 * @param iface interface to unregister
191 */ 195 */
192EAPI void eldbus_service_object_unregister(Eldbus_Service_Interface *iface) EINA_ARG_NONNULL(1); 196EAPI void eldbus_service_object_unregister(Eldbus_Service_Interface *iface) EINA_ARG_NONNULL(1);
193EAPI Eldbus_Connection *eldbus_service_connection_get(const Eldbus_Service_Interface *iface) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; 197EAPI Eldbus_Connection *eldbus_service_connection_get(const Eldbus_Service_Interface *iface) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
@@ -201,6 +205,8 @@ EAPI const char *eldbus_service_object_path_get(const Eldbus_Service_Interface *
201 * @param iface interface of the signal 205 * @param iface interface of the signal
202 * @param signal_id id of signal 206 * @param signal_id id of signal
203 * @param ... values that will be send on signal 207 * @param ... values that will be send on signal
208 *
209 * @return EINA_TRUE if success
204 */ 210 */
205EAPI Eina_Bool eldbus_service_signal_emit(const Eldbus_Service_Interface *iface, unsigned int signal_id, ...) EINA_ARG_NONNULL(1); 211EAPI Eina_Bool eldbus_service_signal_emit(const Eldbus_Service_Interface *iface, unsigned int signal_id, ...) EINA_ARG_NONNULL(1);
206 212
@@ -212,15 +218,22 @@ EAPI Eina_Bool eldbus_service_signal_emit(const Eldbus_Service_Interface *iface,
212 * 218 *
213 * @param iface interface of the signal 219 * @param iface interface of the signal
214 * @param signal_id id of signal 220 * @param signal_id id of signal
221 *
222 * @return EINA_TRUE if success
215 */ 223 */
216EAPI Eldbus_Message *eldbus_service_signal_new(const Eldbus_Service_Interface *iface, unsigned int signal_id) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; 224EAPI Eldbus_Message *eldbus_service_signal_new(const Eldbus_Service_Interface *iface, unsigned int signal_id) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
217 225
218/** 226/**
219 * @brief Send a signal message. 227 * @brief Send a signal message.
220 * 228 *
221 * On success this will call eldbus_message_unref() on the @param signal_msg, 229 * On success this will call eldbus_message_unref() on the @p signal_msg,
222 * which is the intended behavior in 99% of the cases. Remember to increment 230 * which is the intended behavior in 99% of the cases. Remember to increment
223 * the refcount if you want to keep it alive. 231 * the refcount if you want to keep it alive.
232 *
233 * @param iface interface of the signal
234 * @param signal_msg message of signal
235 *
236 * @return EINA_TRUE if success
224 */ 237 */
225EAPI Eina_Bool eldbus_service_signal_send(const Eldbus_Service_Interface *iface, Eldbus_Message *signal_msg) EINA_ARG_NONNULL(1, 2); 238EAPI Eina_Bool eldbus_service_signal_send(const Eldbus_Service_Interface *iface, Eldbus_Message *signal_msg) EINA_ARG_NONNULL(1, 2);
226 239
@@ -262,6 +275,8 @@ EAPI void *eldbus_service_object_data_del(Eldbus_Service_Interface *iface, const
262 * 275 *
263 * @param iface Interface containing the changed property 276 * @param iface Interface containing the changed property
264 * @param name Property name 277 * @param name Property name
278 *
279 * @return EINA_TRUE if success
265 */ 280 */
266EAPI Eina_Bool eldbus_service_property_changed(const Eldbus_Service_Interface *iface, const char *name) EINA_ARG_NONNULL(1, 2); 281EAPI Eina_Bool eldbus_service_property_changed(const Eldbus_Service_Interface *iface, const char *name) EINA_ARG_NONNULL(1, 2);
267 282