luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-09 04:15:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

ginvoke: Port documentation to gi-docgen and update

Browse Source 
Review and update the documentation, making sure it’s complete,
formatted in gi-docgen format, and has all appropriate GIR annotations
and `Since:` lines.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #3155
This commit is contained in:
Philip Withnall 2023-12-14 01:02:57 +00:00
parent 5ccb2d7a06
commit de558d9384
1 changed files with 39 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
girepository/ginvoke.c
View File

@ -33,10 +33,15 @@
/** /**
* value_to_ffi_type: * value_to_ffi_type:
* @gvalue: TODO * @gvalue: (transfer none): a [type@GObject.Value] to convert
* @value: TODO * @value: (out caller-allocates): return location for the ffi data
* *
* TODO * Convert @gvalue to a format suitable for passing to ffi.
*
* @value is only valid as long as @gvalue is alive.
*
* Returns: pointer to the `ffi_type` associated with @value
* Since: 2.80
*/ */
static ffi_type * static ffi_type *
value_to_ffi_type (const GValue *gvalue, gpointer *value) value_to_ffi_type (const GValue *gvalue, gpointer *value)
@ -101,11 +106,18 @@ value_to_ffi_type (const GValue *gvalue, gpointer *value)
/** /**
* g_value_to_ffi_return_type: * g_value_to_ffi_return_type:
* @gvalue: TODO * @gvalue: (transfer none): a [type@GObject.Value] to convert
* @ffi_value: TODO * @ffi_value: (transfer none): a [type@GIRepository.Argument] containing the
* @value: TODO * data to use
* @value: (out caller-allocates): return location for the ffi data
* *
* TODO * Convert @ffi_value to a format suitable for passing to ffi, using the type
* data from @gvalue.
*
* @value is only valid as long as @gvalue and @ffi_value are alive.
*
* Returns: pointer to the `ffi_type` associated with @value
* Since: 2.80
*/ */
static ffi_type * static ffi_type *
g_value_to_ffi_return_type (const GValue *gvalue, g_value_to_ffi_return_type (const GValue *gvalue,
@ -172,10 +184,15 @@ g_value_to_ffi_return_type (const GValue *gvalue,
/** /**
* g_value_from_ffi_value: * g_value_from_ffi_value:
* @gvalue: TODO * @gvalue: (inout): a [type@GObject.Value] to set
* @value: TODO * @value: (transfer none): ffi data to convert
* *
* TODO * Convert @value to a [type@GObject.Value] according to the type already set
* on @gvalue.
*
* @gvalue is valid even after @value is finalised.
*
* Since: 2.80
*/ */
static void static void
g_value_from_ffi_value (GValue *gvalue, g_value_from_ffi_value (GValue *gvalue,
@ -236,14 +253,19 @@ g_value_from_ffi_value (GValue *gvalue,
/** /**
* gi_cclosure_marshal_generic: (skip) * gi_cclosure_marshal_generic: (skip)
* @closure: TODO * @closure: a [type@GObject.Closure]
* @return_gvalue: TODO * @return_gvalue: (optional) (out caller-allocates): return location for the
* @n_param_values: TODO * return value from the closure, or `NULL` to ignore
* @param_values: TODO * @n_param_values: number of param values
* @invocation_hint: TODO * @param_values: (array length=n_param_values): values to pass to the closure
* @marshal_data: TODO * parameters
* @invocation_hint: invocation hint
* @marshal_data: marshal data
* *
* TODO * A generic C closure marshal function using ffi and
* [type@GIRepository.Argument].
*
* Since: 2.80
*/ */
void void
gi_cclosure_marshal_generic (GClosure *closure, gi_cclosure_marshal_generic (GClosure *closure,