GSocket: fix broadcast documentation

The :broadcast property only affects sending broadcast packets, not
receiving them.
This commit is contained in:
Dan Winship 2013-02-17 09:41:55 -05:00
parent 3784927764
commit 2ea4af6f01

View File

@ -895,14 +895,14 @@ g_socket_class_init (GSocketClass *klass)
/** /**
* GSocket:broadcast: * GSocket:broadcast:
* *
* Whether the socket should allow sending to and receiving from broadcast addresses. * Whether the socket should allow sending to broadcast addresses.
* *
* Since: 2.32 * Since: 2.32
*/ */
g_object_class_install_property (gobject_class, PROP_BROADCAST, g_object_class_install_property (gobject_class, PROP_BROADCAST,
g_param_spec_boolean ("broadcast", g_param_spec_boolean ("broadcast",
P_("Broadcast"), P_("Broadcast"),
P_("Whether to allow sending to and receiving from broadcast addresses"), P_("Whether to allow sending to broadcast addresses"),
FALSE, FALSE,
G_PARAM_READWRITE | G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS)); G_PARAM_STATIC_STRINGS));
@ -1387,7 +1387,7 @@ g_socket_set_ttl (GSocket *socket,
* *
* Gets the broadcast setting on @socket; if %TRUE, * Gets the broadcast setting on @socket; if %TRUE,
* it is possible to send packets to broadcast * it is possible to send packets to broadcast
* addresses or receive from broadcast addresses. * addresses.
* *
* Returns: the broadcast setting on @socket * Returns: the broadcast setting on @socket
* *
@ -1415,11 +1415,11 @@ g_socket_get_broadcast (GSocket *socket)
/** /**
* g_socket_set_broadcast: * g_socket_set_broadcast:
* @socket: a #GSocket. * @socket: a #GSocket.
* @broadcast: whether @socket should allow sending to and receiving * @broadcast: whether @socket should allow sending to broadcast
* from broadcast addresses * addresses
* *
* Sets whether @socket should allow sending to and receiving from * Sets whether @socket should allow sending to broadcast addresses.
* broadcast addresses. This is %FALSE by default. * This is %FALSE by default.
* *
* Since: 2.32 * Since: 2.32
*/ */