Merge branch 'gio-add-gsettings-nullable-annotations' into 'main'

gsettings: Add various missing (nullable) or (not nullable) annotations

See merge request GNOME/glib!2242
This commit is contained in:
Philip Withnall
2021-09-21 10:39:37 +00:00
3 changed files with 40 additions and 39 deletions

View File

@@ -202,7 +202,7 @@ static GSettingsSchemaSource *schema_sources;
*
* Increase the reference count of @source, returning a new reference.
*
* Returns: a new reference to @source
* Returns: (transfer full) (not nullable): a new reference to @source
*
* Since: 2.32
**/
@@ -869,9 +869,9 @@ ensure_schema_lists (void)
*
* Deprecated.
*
* Returns: (element-type utf8) (transfer none): a list of #GSettings
* schemas that are available, in no defined order. The list must not be
* modified or freed.
* Returns: (element-type utf8) (transfer none) (not nullable): a list of
* #GSettings schemas that are available, in no defined order. The list
* must not be modified or freed.
*
* Since: 2.26
*
@@ -893,9 +893,9 @@ g_settings_list_schemas (void)
*
* Deprecated.
*
* Returns: (element-type utf8) (transfer none): a list of relocatable
* #GSettings schemas that are available, in no defined order. The list must
* not be modified or freed.
* Returns: (element-type utf8) (transfer none) (not nullable): a list of
* relocatable #GSettings schemas that are available, in no defined order.
* The list must not be modified or freed.
*
* Since: 2.28
*
@@ -915,7 +915,7 @@ g_settings_list_relocatable_schemas (void)
*
* Increase the reference count of @schema, returning a new reference.
*
* Returns: a new reference to @schema
* Returns: (transfer full) (not nullable): a new reference to @schema
*
* Since: 2.32
**/
@@ -1066,8 +1066,8 @@ g_settings_schema_has_key (GSettingsSchema *schema,
* You should free the return value with g_strfreev() when you are done
* with it.
*
* Returns: (transfer full) (element-type utf8): a list of the children on
* @settings, in no defined order
* Returns: (not nullable) (transfer full) (element-type utf8): a list of
* the children on @settings, in no defined order
*
* Since: 2.44
*/
@@ -1111,8 +1111,8 @@ g_settings_schema_list_children (GSettingsSchema *schema)
* (since you should already know what keys are in your schema). This
* function is intended for introspection reasons.
*
* Returns: (transfer full) (element-type utf8): a list of the keys on
* @schema, in no defined order
* Returns: (not nullable) (transfer full) (element-type utf8): a list
* of the keys on @schema, in no defined order
*
* Since: 2.46
*/
@@ -1250,7 +1250,7 @@ g_settings_schema_list (GSettingsSchema *schema,
*
* Get the ID of @schema.
*
* Returns: (transfer none): the ID
* Returns: (not nullable) (transfer none): the ID
**/
const gchar *
g_settings_schema_get_id (GSettingsSchema *schema)
@@ -1581,7 +1581,7 @@ G_DEFINE_BOXED_TYPE (GSettingsSchemaKey, g_settings_schema_key, g_settings_schem
*
* Increase the reference count of @key, returning a new reference.
*
* Returns: a new reference to @key
* Returns: (not nullable) (transfer full): a new reference to @key
*
* Since: 2.40
**/
@@ -1626,7 +1626,7 @@ g_settings_schema_key_unref (GSettingsSchemaKey *key)
* It is a programmer error to request a key that does not exist. See
* g_settings_schema_list_keys().
*
* Returns: (transfer full): the #GSettingsSchemaKey for @name
* Returns: (not nullable) (transfer full): the #GSettingsSchemaKey for @name
*
* Since: 2.40
**/
@@ -1652,7 +1652,7 @@ g_settings_schema_get_key (GSettingsSchema *schema,
*
* Gets the name of @key.
*
* Returns: the name of @key.
* Returns: (not nullable) (transfer none): the name of @key.
*
* Since: 2.44
*/
@@ -1682,7 +1682,7 @@ g_settings_schema_key_get_name (GSettingsSchemaKey *key)
* function has to parse all of the source XML files in the schema
* directory.
*
* Returns: (nullable): the summary for @key, or %NULL
* Returns: (nullable) (transfer none): the summary for @key, or %NULL
*
* Since: 2.34
**/
@@ -1717,7 +1717,7 @@ g_settings_schema_key_get_summary (GSettingsSchemaKey *key)
* function has to parse all of the source XML files in the schema
* directory.
*
* Returns: (nullable): the description for @key, or %NULL
* Returns: (nullable) (transfer none): the description for @key, or %NULL
*
* Since: 2.34
**/
@@ -1739,7 +1739,7 @@ g_settings_schema_key_get_description (GSettingsSchemaKey *key)
*
* Gets the #GVariantType of @key.
*
* Returns: (transfer none): the type of @key
* Returns: (not nullable) (transfer none): the type of @key
*
* Since: 2.40
**/
@@ -1760,7 +1760,7 @@ g_settings_schema_key_get_value_type (GSettingsSchemaKey *key)
* Note that this is the default value according to the schema. System
* administrator defaults and lockdown are not visible via this API.
*
* Returns: (transfer full): the default value for the key
* Returns: (not nullable) (transfer full): the default value for the key
*
* Since: 2.40
**/
@@ -1823,7 +1823,7 @@ g_settings_schema_key_get_default_value (GSettingsSchemaKey *key)
* You should free the returned value with g_variant_unref() when it is
* no longer needed.
*
* Returns: (transfer full): a #GVariant describing the range
* Returns: (not nullable) (transfer full): a #GVariant describing the range
*
* Since: 2.40
**/