girffi: Expand docs for gi_function_info_prep_invoker()

Mention that the returned `GIFunctionInvoker` needs to be cleared.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
This commit is contained in:
Philip Withnall 2024-01-23 18:09:28 +00:00
parent bf4cf2d464
commit 998baf9afb

View File

@ -269,6 +269,9 @@ gi_callable_info_get_ffi_return_type (GICallableInfo *callable_info)
* by a language binding could contain a [type@GIRepository.FunctionInvoker]
* structure inside the bindings function mapping.
*
* @invoker must be freed using [method@GIRepository.FunctionInvoker.destroy]
* when its finished with.
*
* Returns: `TRUE` on success, `FALSE` otherwise with @error set.
* Since: 2.80
*/