summaryrefslogtreecommitdiff
path: root/src/lib/eldbus
diff options
context:
space:
mode:
authorJaehyun Cho <jae_hyun.cho@samsung.com>2017-10-26 15:11:18 +0900
committerJaehyun Cho <jae_hyun.cho@samsung.com>2017-10-26 15:28:43 +0900
commit73baa73972bdc02b108afd248b215668835a4233 (patch)
tree8718a2a4bac792364eaca51566cc7e38bfedde44 /src/lib/eldbus
parent5ef408f49b5dd215ab5d751410b727832f08ddec (diff)
eldbus_message: Add description to fix doxygen warning
Change-Id: Id85f85de352019b29268cfa3d6e70df7cd8e84ee
Diffstat (limited to 'src/lib/eldbus')
-rw-r--r--src/lib/eldbus/eldbus_message.h15
1 files changed, 14 insertions, 1 deletions
diff --git a/src/lib/eldbus/eldbus_message.h b/src/lib/eldbus/eldbus_message.h
index 439ea4687b..dbb9e0c919 100644
--- a/src/lib/eldbus/eldbus_message.h
+++ b/src/lib/eldbus/eldbus_message.h
@@ -90,7 +90,7 @@ EAPI Eldbus_Message *eldbus_message_method_call_new(const char *dest, con
90 * @brief Create a new signal message. 90 * @brief Create a new signal message.
91 * 91 *
92 * @param path object path 92 * @param path object path
93 * @param iface interface name 93 * @param interface interface name
94 * @param name name of the signal to be broadcasted 94 * @param name name of the signal to be broadcasted
95 * 95 *
96 * @return a new Eldbus_Message, free with eldbus_message_unref() 96 * @return a new Eldbus_Message, free with eldbus_message_unref()
@@ -226,6 +226,12 @@ EAPI Eldbus_Message_Iter *eldbus_message_iter_container_new(Eldbus_Message_Iter
226 226
227/** 227/**
228 * @brief Append a basic type into an Eldbus_Iterator. 228 * @brief Append a basic type into an Eldbus_Iterator.
229 *
230 * @param iter The iterator in which basic type will be appended.
231 * @param type The basic type that will be appended.
232 * @param ... The values for the basic type.
233 *
234 * @return EINA_TRUE on success, else EINA_FALSE.
229 */ 235 */
230EAPI Eina_Bool eldbus_message_iter_basic_append(Eldbus_Message_Iter *iter, int type, ...) EINA_ARG_NONNULL(1, 3); 236EAPI Eina_Bool eldbus_message_iter_basic_append(Eldbus_Message_Iter *iter, int type, ...) EINA_ARG_NONNULL(1, 3);
231 237
@@ -299,11 +305,18 @@ EAPI Eina_Bool eldbus_message_iter_container_close(Eldbus_Message_
299 305
300/** 306/**
301 * @brief Get the main Eldbus_Message_Iter from the Eldbus_Message. 307 * @brief Get the main Eldbus_Message_Iter from the Eldbus_Message.
308 *
309 * @param msg The message to get the iterator from.
310 *
311 * @return The iterator of the message.
302 */ 312 */
303EAPI Eldbus_Message_Iter *eldbus_message_iter_get(const Eldbus_Message *msg) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; 313EAPI Eldbus_Message_Iter *eldbus_message_iter_get(const Eldbus_Message *msg) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
304 314
305/** 315/**
306 * @brief Get a basic type from Eldbus_Iterator. 316 * @brief Get a basic type from Eldbus_Iterator.
317 *
318 * @param iter The iterator to get the basic type from.
319 * @param value The basic type of the iterator.
307 */ 320 */
308EAPI void eldbus_message_iter_basic_get(Eldbus_Message_Iter *iter, void *value) EINA_ARG_NONNULL(1, 2); 321EAPI void eldbus_message_iter_basic_get(Eldbus_Message_Iter *iter, void *value) EINA_ARG_NONNULL(1, 2);
309 322