Merge branch 'settings-list-order' into 'master'

gsettings: Document that lists are returned in no defined order

See merge request GNOME/glib!851
This commit is contained in:
Sebastian Dröge 2019-06-11 11:35:58 +00:00
commit f78194e8d0
2 changed files with 14 additions and 10 deletions

View File

@ -2459,7 +2459,9 @@ g_settings_get_child (GSettings *settings,
* You should free the return value with g_strfreev() when you are done * You should free the return value with g_strfreev() when you are done
* with it. * with it.
* *
* Returns: (transfer full) (element-type utf8): a list of the keys on @settings * Returns: (transfer full) (element-type utf8): a list of the keys on
* @settings, in no defined order
* Deprecated: 2.46: Use g_settings_schema_list_keys instead().
*/ */
gchar ** gchar **
g_settings_list_keys (GSettings *settings) g_settings_list_keys (GSettings *settings)
@ -2483,7 +2485,8 @@ g_settings_list_keys (GSettings *settings)
* You should free the return value with g_strfreev() when you are done * You should free the return value with g_strfreev() when you are done
* with it. * with it.
* *
* Returns: (transfer full) (element-type utf8): a list of the children on @settings * Returns: (transfer full) (element-type utf8): a list of the children on
* @settings, in no defined order
*/ */
gchar ** gchar **
g_settings_list_children (GSettings *settings) g_settings_list_children (GSettings *settings)

View File

@ -742,9 +742,9 @@ g_settings_schema_source_get_text_tables (GSettingsSchemaSource *source)
* @source: a #GSettingsSchemaSource * @source: a #GSettingsSchemaSource
* @recursive: if we should recurse * @recursive: if we should recurse
* @non_relocatable: (out) (transfer full) (array zero-terminated=1): the * @non_relocatable: (out) (transfer full) (array zero-terminated=1): the
* list of non-relocatable schemas * list of non-relocatable schemas, in no defined order
* @relocatable: (out) (transfer full) (array zero-terminated=1): the list * @relocatable: (out) (transfer full) (array zero-terminated=1): the list
* of relocatable schemas * of relocatable schemas, in no defined order
* *
* Lists the schemas in a given source. * Lists the schemas in a given source.
* *
@ -857,8 +857,8 @@ ensure_schema_lists (void)
* Deprecated. * Deprecated.
* *
* Returns: (element-type utf8) (transfer none): a list of #GSettings * Returns: (element-type utf8) (transfer none): a list of #GSettings
* schemas that are available. The list must not be modified or * schemas that are available, in no defined order. The list must not be
* freed. * modified or freed.
* *
* Since: 2.26 * Since: 2.26
* *
@ -881,8 +881,8 @@ g_settings_list_schemas (void)
* Deprecated. * Deprecated.
* *
* Returns: (element-type utf8) (transfer none): a list of relocatable * Returns: (element-type utf8) (transfer none): a list of relocatable
* #GSettings schemas that are available. The list must not be * #GSettings schemas that are available, in no defined order. The list must
* modified or freed. * not be modified or freed.
* *
* Since: 2.28 * Since: 2.28
* *
@ -1035,7 +1035,8 @@ g_settings_schema_has_key (GSettingsSchema *schema,
* You should free the return value with g_strfreev() when you are done * You should free the return value with g_strfreev() when you are done
* with it. * with it.
* *
* Returns: (transfer full) (element-type utf8): a list of the children on @settings * Returns: (transfer full) (element-type utf8): a list of the children on
* @settings, in no defined order
* *
* Since: 2.44 * Since: 2.44
*/ */
@ -1080,7 +1081,7 @@ g_settings_schema_list_children (GSettingsSchema *schema)
* function is intended for introspection reasons. * function is intended for introspection reasons.
* *
* Returns: (transfer full) (element-type utf8): a list of the keys on * Returns: (transfer full) (element-type utf8): a list of the keys on
* @schema * @schema, in no defined order
* *
* Since: 2.46 * Since: 2.46
*/ */