diff --git a/legacy/edbus/src/lib/EDBus.h b/legacy/edbus/src/lib/EDBus.h index 66b5320390..784139c75d 100644 --- a/legacy/edbus/src/lib/EDBus.h +++ b/legacy/edbus/src/lib/EDBus.h @@ -81,19 +81,19 @@ typedef struct _EDBus_Connection EDBus_Connection; /** * @typedef EDBus_Object * - * Represents a object path already attach with bus name or unique id. + * Represents an object path already attached with bus name or unique id. */ typedef struct _EDBus_Object EDBus_Object; /** * @typedef EDBus_Proxy * - * Represents a interface of a object path. + * Represents an interface of an object path. */ typedef struct _EDBus_Proxy EDBus_Proxy; /** * @typedef EDBus_Message * - * Represents the way of how the data is send and received in DBus. + * Represents the way data is sent and received in DBus. */ typedef struct _EDBus_Message EDBus_Message; /** @@ -107,7 +107,7 @@ typedef struct _EDBus_Message_Iter EDBus_Message_Iter; /** * @typedef EDBus_Pending * - * Represents a message that was been sent but has not yet reached its + * Represents a message that has been sent but has not yet reached its * destination. */ typedef struct _EDBus_Pending EDBus_Pending; diff --git a/legacy/edbus/src/lib/edbus_connection.h b/legacy/edbus/src/lib/edbus_connection.h index 955ffd7f09..811854db72 100644 --- a/legacy/edbus/src/lib/edbus_connection.h +++ b/legacy/edbus/src/lib/edbus_connection.h @@ -36,7 +36,7 @@ EAPI EDBus_Connection *edbus_connection_get(EDBus_Connection_Type type); EAPI EDBus_Connection *edbus_connection_ref(EDBus_Connection *conn) EINA_ARG_NONNULL(1); /** - * @brief Decrement object reference count. + * @brief Decrement connection reference count. * * If reference count reaches 0, the connection to bus will be dropped and all * its children will be invalidated. @@ -48,7 +48,7 @@ EAPI void edbus_connection_unref(EDBus_Connection *conn) EINA_ARG_N * * @param conn The connection object to add the callback to. * @param cb callback to be called - * @param data passed to callback + * @param data data passed to callback */ EAPI void edbus_connection_cb_free_add(EDBus_Connection *conn, EDBus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); @@ -69,8 +69,8 @@ EAPI void edbus_connection_data_set(EDBus_Connection *conn, const c /** * @brief Get data stored in connection. * - * @param conn connection where data are stored - * @param key that identify data + * @param conn connection where data is stored + * @param key key that identifies data * * @return pointer to data if found otherwise NULL */ @@ -79,8 +79,8 @@ EAPI void *edbus_connection_data_get(const EDBus_Connection *conn, c /** * @brief Del data stored in connection. * - * @param conn connection where data are stored - * @param key that identify data + * @param conn connection where data is stored + * @param key that identifies data * * @return pointer to data if found otherwise NULL */ @@ -116,7 +116,7 @@ typedef struct _EDBus_Connection_Event_Name_Owner_Changed typedef void (*EDBus_Connection_Event_Cb)(void *data, EDBus_Connection *conn, void *event_info); /** - * @brief Add a callback function to be called when occurs a event of the + * @brief Add a callback function to be called when an event occurs of the * type passed. */ EAPI void edbus_connection_event_callback_add(EDBus_Connection *conn, EDBus_Connection_Event_Type type, EDBus_Connection_Event_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 3); @@ -129,12 +129,12 @@ EAPI void edbus_connection_event_callback_del(EDBus_Connection /** * @brief Send a message. * - * @param conn the connection where the message will be send - * @param msg message that will be send + * @param conn the connection where the message will be sent + * @param msg message that will be sent * @param cb if msg is a method call a callback should be passed - * to be execute when response arrive + * to be executed when a response arrives * @param cb_data data passed to callback - * @param timeout timeout in milliseconds, -1 to default internal value or + * @param timeout timeout in milliseconds, -1 to use default internal value or * EDBUS_TIMEOUT_INFINITE for no timeout */ EAPI EDBus_Pending *edbus_connection_send(EDBus_Connection *conn, EDBus_Message *msg, EDBus_Message_Cb cb, const void *cb_data, double timeout) EINA_ARG_NONNULL(1, 2); diff --git a/legacy/edbus/src/lib/edbus_message.h b/legacy/edbus/src/lib/edbus_message.h index 1aa0bacd45..5986b5b60a 100644 --- a/legacy/edbus/src/lib/edbus_message.h +++ b/legacy/edbus/src/lib/edbus_message.h @@ -25,7 +25,7 @@ EAPI EDBus_Message *edbus_message_method_call_new(const char *dest, const EAPI EDBus_Message *edbus_message_ref(EDBus_Message *msg) EINA_ARG_NONNULL(1); /** * @brief Decrease message reference. - * If reference == 0 message will be freed and all your children's. + * If reference == 0 message will be freed and all its children. */ EAPI void edbus_message_unref(EDBus_Message *msg) EINA_ARG_NONNULL(1); @@ -72,29 +72,29 @@ EAPI EDBus_Message *edbus_message_signal_new(const char *path, const char EAPI Eina_Bool edbus_message_error_get(const EDBus_Message *msg, const char **name, const char **text) EINA_ARG_NONNULL(1); /** - * @brief Get data from EDBus_Message, for each complete type must have - * a pointer to store his value, in case of complex type a - * EDBus_Message_Iter will be need. + * @brief Get data from EDBus_Message. For each complete type we must have + * a pointer to store its value. In case of complex type EDBus_Message_Iter + * needs to be need. */ EAPI Eina_Bool edbus_message_arguments_get(const EDBus_Message *msg, const char *signature, ...) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; /** - * @brief Get data from EDBus_Message, for each complete type must have - * a pointer to store his value, in case of complex type a - * EDBus_Message_Iter will be need. + * @brief Get data from EDBus_Message. For each complete type we must have + * a pointer to store its value, in case of complex type + * EDBus_Message_Iter needs to be used. */ EAPI Eina_Bool edbus_message_arguments_vget(const EDBus_Message *msg, const char *signature, va_list ap) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; /** * @brief Set data to EDBus_Message. * - * This function only support basic type from complex type use + * This function only supports basic type, for complex types use * edbus_message_iter_* functions. */ EAPI Eina_Bool edbus_message_arguments_set(EDBus_Message *msg, const char *signature, ...) EINA_ARG_NONNULL(1, 2); /** * @brief Set data to EDBus_Message. * - * This function only support basic type from complex type use + * This function only supports basic types, for complex types use * edbus_message_iter_* functions. */ EAPI Eina_Bool edbus_message_arguments_vset(EDBus_Message *msg, const char *signature, va_list ap) EINA_ARG_NONNULL(1, 2); diff --git a/legacy/edbus/src/lib/edbus_object.h b/legacy/edbus/src/lib/edbus_object.h index d663eba165..de1f345dfd 100644 --- a/legacy/edbus/src/lib/edbus_object.h +++ b/legacy/edbus/src/lib/edbus_object.h @@ -7,10 +7,10 @@ * @{ */ /** - * @brief Get a object of the following bus and path. + * @brief Get an object of the given bus and path. * * @param conn connection where object belongs - * @param bus name of bus or unique-id of who listen for calls of this object + * @param bus name of bus or unique-id of who listens for calls of this object * @param path object path of this object */ EAPI EDBus_Object *edbus_object_get(EDBus_Connection *conn, const char *bus, const char *path) EINA_ARG_NONNULL(1, 2, 3) EINA_WARN_UNUSED_RESULT; @@ -20,15 +20,15 @@ EAPI EDBus_Object *edbus_object_get(EDBus_Connection *conn, const char *bus, con EAPI EDBus_Object *edbus_object_ref(EDBus_Object *obj) EINA_ARG_NONNULL(1); /** * @brief Decrease object reference. - * If reference == 0 object will be freed and all your children's. + * If reference == 0 object will be freed and all its children. */ EAPI void edbus_object_unref(EDBus_Object *obj) EINA_ARG_NONNULL(1); /** * @brief Add a callback function to be called when object will be freed. * - * @param obj object that you want to know when it will be free - * @param cb callback that will be execute + * @param obj object that you want to monitor + * @param cb callback that will be executed * @param data passed to callback */ EAPI void edbus_object_cb_free_add(EDBus_Object *obj, EDBus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); @@ -76,8 +76,8 @@ typedef struct _EDBus_Object_Event_Property_Removed typedef void (*EDBus_Object_Event_Cb)(void *data, EDBus_Object *obj, void *event_info); /** - * @brief Add a callback function to be called when occurs a event of the - * type passed. + * @brief Add a callback function to be called when an event of the specified + * type occurs. */ EAPI void edbus_object_event_callback_add(EDBus_Object *obj, EDBus_Object_Event_Type type, EDBus_Object_Event_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 3); /** @@ -92,10 +92,10 @@ EAPI const char *edbus_object_bus_path_get(const EDBus_Object *obj) EI /** * @brief Send a message. * - * @param obj the msg will be send in connection that obj belongs - * @param msg message that will be send + * @param obj the msg will be sent in connection to this object + * @param msg message that will be sent * @param cb if msg is a method call a callback should be passed - * to be execute when response arrive + * to be executed when a response arrives * @param cb_data data passed to callback * @param timeout timeout in milliseconds, -1 to default internal value or * EDBUS_TIMEOUT_INFINITE for no timeout diff --git a/legacy/edbus/src/lib/edbus_proxy.h b/legacy/edbus/src/lib/edbus_proxy.h index ff4403c714..6632df4795 100644 --- a/legacy/edbus/src/lib/edbus_proxy.h +++ b/legacy/edbus/src/lib/edbus_proxy.h @@ -16,7 +16,7 @@ EAPI EDBus_Proxy *edbus_proxy_get(EDBus_Object *obj, const char *interf EAPI EDBus_Proxy *edbus_proxy_ref(EDBus_Proxy *proxy) EINA_ARG_NONNULL(1); /** * @brief Decrease proxy reference. - * If reference == 0 proxy will be freed and all your children's. + * If reference == 0 proxy will be freed and all your children. */ EAPI void edbus_proxy_unref(EDBus_Proxy *proxy) EINA_ARG_NONNULL(1); diff --git a/legacy/edbus/src/lib/edbus_service.h b/legacy/edbus/src/lib/edbus_service.h index 0daa7d8163..5b6b296b01 100644 --- a/legacy/edbus/src/lib/edbus_service.h +++ b/legacy/edbus/src/lib/edbus_service.h @@ -46,7 +46,7 @@ typedef struct _EDBus_Signal } EDBus_Signal; /** - * @brief Register a interface on the passed path and connection. + * @brief Register an interface in the given path and connection. * * @param conn where the interface should listen * @param path object path @@ -63,8 +63,8 @@ typedef struct _EDBus_Signal EAPI EDBus_Service_Interface *edbus_service_interface_register(EDBus_Connection *conn, const char *path, const char *interface, const EDBus_Method methods[], const EDBus_Signal signals[]); /** * @brief Unregister a interface. - * If this is the last interface of object path, the object path will be - * remove too. + * If this is the last interface of the object path, the object path will be + * removed too. */ EAPI void edbus_service_interface_unregister(EDBus_Service_Interface *iface); /** @@ -89,7 +89,7 @@ EAPI Eina_Bool edbus_service_signal_emit(EDBus_Service_Interface *iface, unsigne * @brief Create signal message. * Each signal handler have a internal id, the first signal handler of * interface is = 0 the second = 1 and go on. - * This function is used when signal have complex types. + * This function is used when the signal has complex types. * * @param iface interface of the signal * @param signal_id id of signal @@ -100,7 +100,7 @@ EAPI EDBus_Message *edbus_service_signal_new(EDBus_Service_Interface *iface, uns */ EAPI Eina_Bool edbus_service_signal_send(EDBus_Service_Interface *iface, EDBus_Message *signal_msg) EINA_ARG_NONNULL(1, 2); /** - * @brief Store data at object path, this data can be get from all interfaces + * @brief Store data at object path, this data can be obtained from all interfaces * of the same object. * * @param iface interface that belong to the object path where data will @@ -112,7 +112,7 @@ EAPI void edbus_service_object_data_set(EDBus_Service_Interface *iface, const ch /** * @brief Get data stored in object path. * - * @param iface interface that belong to the object path where data are stored + * @param iface interface that belongs to the object path where data are stored * @param key that identify data * * @return pointer to data if found otherwise NULL @@ -121,7 +121,7 @@ EAPI void *edbus_service_object_data_get(const EDBus_Service_Interface *iface, c /** * @brief Del data stored in object path. * - * @param iface interface that belong to the object path where data are stored + * @param iface interface that belongs to the object path where data are stored * @param key that identify data * * @return pointer to data if found otherwise NULL diff --git a/legacy/edbus/src/lib/edbus_signal_handler.h b/legacy/edbus/src/lib/edbus_signal_handler.h index 8769026a34..8be91be594 100644 --- a/legacy/edbus/src/lib/edbus_signal_handler.h +++ b/legacy/edbus/src/lib/edbus_signal_handler.h @@ -30,8 +30,8 @@ EAPI EDBus_Signal_Handler *edbus_signal_handler_ref(EDBus_Signal_Handler *handle EAPI void edbus_signal_handler_unref(EDBus_Signal_Handler *handler) EINA_ARG_NONNULL(1); /** * @brief Decrease signal handler reference like edbus_signal_handler_unref() - * but if reference > 0 this signal handler will stop listen signals. In other - * words will be canceled but memory will not be freed. + * but if reference > 0 this signal handler will stop listening to signals. In other + * words it will be canceled but memory will not be freed. */ EAPI void edbus_signal_handler_del(EDBus_Signal_Handler *handler) EINA_ARG_NONNULL(1); /** @@ -42,12 +42,12 @@ EAPI void edbus_signal_handler_del(EDBus_Signal_Handler *handle * With this extra arguments this signal handler callback only will be called * when Banshee is started. * - * @note For now is only supported argX. + * @note For now only argX is supported. * * @param sh signal handler * @param ... variadic of key and value and must be ended with a NULL * - * @note To information: + * @note For more information: * http://dbus.freedesktop.org/doc/dbus-specification.html#message-bus-routing-match-rules */ EAPI Eina_Bool edbus_signal_handler_match_extra_set(EDBus_Signal_Handler *sh, ...) EINA_ARG_NONNULL(1) EINA_SENTINEL;