gdbusconnection: Fix error in g_dbus_connection_emit_signal() docs

It incorrectly said that an error could only be returned if the GVariant
was incorrect for the D-Bus API, but that’s not true: an error will also
be returned if you call it on a closed GDBusConnection.

Clarify that, and mention the actual error codes which are returned.

Signed-off-by: Philip Withnall <withnall@endlessm.com>
Reviewed-by: nobody
This commit is contained in:
Philip Withnall 2018-02-15 16:42:26 +00:00
parent 80d328b3a8
commit 0664b61782

View File

@ -5516,7 +5516,9 @@ g_dbus_connection_register_object_with_closures (GDBusConnection *connection
*
* If the parameters GVariant is floating, it is consumed.
*
* This can only fail if @parameters is not compatible with the D-Bus protocol.
* This can only fail if @parameters is not compatible with the D-Bus protocol
* (%G_IO_ERROR_INVALID_ARGUMENT), or if @connection has been closed
* (%G_IO_ERROR_CLOSED).
*
* Returns: %TRUE unless @error is set
*