gerror: Add (optional) annotation to g_propagate_error()

Also clarify in the documentation that @src must be non-%NULL.
This commit is contained in:
Philip Withnall 2015-10-08 11:16:02 +01:00
parent 2e078f1fc0
commit 0cc8c0f3e1

View File

@ -626,12 +626,14 @@ g_set_error_literal (GError **err,
/** /**
* g_propagate_error: * g_propagate_error:
* @dest: error return location * @dest: (out callee-allocates) (optional) (nullable): error return location
* @src: error to move into the return location * @src: (transfer full): error to move into the return location
* *
* If @dest is %NULL, free @src; otherwise, moves @src into *@dest. * If @dest is %NULL, free @src; otherwise, moves @src into *@dest.
* The error variable @dest points to must be %NULL. * The error variable @dest points to must be %NULL.
* *
* @src must be non-%NULL.
*
* Note that @src is no longer valid after this call. If you want * Note that @src is no longer valid after this call. If you want
* to keep using the same GError*, you need to set it to %NULL * to keep using the same GError*, you need to set it to %NULL
* after calling this function on it. * after calling this function on it.