gsocket: Clarify flags documentation for g_socket_receive_message()

The API design here is a bit awkward — the in/out flags argument should
actually have been an in flags argument and an out msg_flags argument.
Clarify that a bit in the documentation.

https://bugzilla.gnome.org/show_bug.cgi?id=751924
This commit is contained in:
Philip Withnall 2015-07-27 14:46:54 +01:00
parent 4745c08220
commit 8fdc670188

View File

@ -4399,6 +4399,8 @@ cache_recv_address (GSocket *socket, struct sockaddr *native, int native_len)
* values there are the same as the system values, and the flags
* are passed in as-is, so you can pass in system-specific flags too
* (and g_socket_receive_message() may pass system-specific flags out).
* Flags passed in to the parameter affect the receive operation; flags returned
* out of it are relevant to the specific returned message.
*
* As with g_socket_receive(), data may be discarded if @socket is
* %G_SOCKET_TYPE_DATAGRAM or %G_SOCKET_TYPE_SEQPACKET and you do not