mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-11-03 09:01:42 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

client: Reword and add documentation about the marshal functions

Browse source 
Some rewording to improve grammar a bit with some additions about the
type expectations of va_list arguments.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
This commit is contained in:
Jonas Ådahl 2015-10-02 17:32:53 +08:00 • committed by Bryce Harrington
parent e74cde739e
commit f755dbde26
1 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
src/wayland-client.c
View file

@ -562,9 +562,9 @@ create_outgoing_proxy(struct wl_proxy *proxy, const struct wl_message *message,
* \param args Extra arguments for the given request * \param args Extra arguments for the given request
* \param interface The interface to use for the new proxy * \param interface The interface to use for the new proxy
* *
* Translates the request given by opcode and the extra arguments into the * This function translates a request given an opcode, an interface and a
* wire format and write it to the connection buffer. This version takes an * wl_argument array to the wire format and writes it to the connection
* array of the union type wl_argument. * buffer.
* *
* For new-id arguments, this function will allocate a new wl_proxy * For new-id arguments, this function will allocate a new wl_proxy
* and send the ID to the server. The new wl_proxy will be returned * and send the ID to the server. The new wl_proxy will be returned
@ -656,8 +656,10 @@ wl_proxy_marshal(struct wl_proxy *proxy, uint32_t opcode, ...)
* \param ... Extra arguments for the given request * \param ... Extra arguments for the given request
* \return A new wl_proxy for the new_id argument or NULL on error * \return A new wl_proxy for the new_id argument or NULL on error
* *
* Translates the request given by opcode and the extra arguments into the * This function translates a request given an opcode, an interface and extra
* wire format and write it to the connection buffer. * arguments to the wire format and writes it to the connection buffer. The
* types of the extra arguments must correspond to the argument types of the
* method associated with the opcode in the interface.
* *
* For new-id arguments, this function will allocate a new wl_proxy * For new-id arguments, this function will allocate a new wl_proxy
* and send the ID to the server. The new wl_proxy will be returned * and send the ID to the server. The new wl_proxy will be returned