summaryrefslogtreecommitdiff
path: root/gobject/gboxed.c
diff options
context:
space:
mode:
authorPhilip Withnall <philip.withnall@collabora.co.uk>2013-12-06 12:23:09 +0000
committerPhilip Withnall <philip.withnall@collabora.co.uk>2015-11-07 10:48:32 +0100
commit25a7c817d3cbef8b6508b44bca6d0b01ca77916b (patch)
tree22f5321329f61c74ab335cf9149b6fe484aad6dc /gobject/gboxed.c
parent90808a02796449615947e49ae57f5f4fa2e404ea (diff)
downloadglib-25a7c817d3cbef8b6508b44bca6d0b01ca77916b.tar.gz
glib: Add missing (nullable) and (optional) annotations
Add various (nullable) and (optional) annotations which were missing from a variety of functions. Also port a couple of existing (allow-none) annotations in the same files to use (nullable) and (optional) as appropriate instead. Secondly, add various (not nullable) annotations as needed by the new default in gobject-introspection of marking gpointers as (nullable). See https://bugzilla.gnome.org/show_bug.cgi?id=729660. This includes adding some stub documentation comments for the assertion macro error functions, which weren’t previously documented. The new comments are purely to allow for annotations, and hence are marked as (skip) to prevent the symbols appearing in the GIR file. https://bugzilla.gnome.org/show_bug.cgi?id=719966
Diffstat (limited to 'gobject/gboxed.c')
-rw-r--r--gobject/gboxed.c7
1 files changed, 4 insertions, 3 deletions
diff --git a/gobject/gboxed.c b/gobject/gboxed.c
index 54f658ed3..40723f53b 100644
--- a/gobject/gboxed.c
+++ b/gobject/gboxed.c
@@ -322,11 +322,12 @@ g_boxed_type_register_static (const gchar *name,
/**
* g_boxed_copy:
* @boxed_type: The type of @src_boxed.
- * @src_boxed: The boxed structure to be copied.
+ * @src_boxed: (not nullable): The boxed structure to be copied.
*
* Provide a copy of a boxed structure @src_boxed which is of type @boxed_type.
*
- * Returns: (transfer full): The newly created copy of the boxed structure.
+ * Returns: (transfer full) (not nullable): The newly created copy of the boxed
+ * structure.
*/
gpointer
g_boxed_copy (GType boxed_type,
@@ -383,7 +384,7 @@ g_boxed_copy (GType boxed_type,
/**
* g_boxed_free:
* @boxed_type: The type of @boxed.
- * @boxed: The boxed structure to be freed.
+ * @boxed: (not nullable): The boxed structure to be freed.
*
* Free the boxed structure @boxed which is of type @boxed_type.
*/