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

Clarify docs for g_settings_list_children

Browse Source 
The docs sound like settings list is a thing, and
a ::children-changed signal exists. That is not the
case, and will never be the case at this point, so
stop pretending.

Closes: #1362
This commit is contained in:
Matthias Clasen 2018-11-12 08:07:52 -05:00
parent e990a9ff8e
commit bb1f765df3
1 changed files with 3 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
gio/gsettings.c
View File

@ -2469,16 +2469,9 @@ g_settings_list_keys (GSettings *settings)
* The list is exactly the list of strings for which it is not an error * The list is exactly the list of strings for which it is not an error
* to call g_settings_get_child(). * to call g_settings_get_child().
* *
* For GSettings objects that are lists, this value can change at any * There is little reason to call this function from "normal" code, since
* time. Note that there is a race condition here: you may * you should already know what children are in your schema. This function
* request a child after listing it only for it to have been destroyed * may still be useful there for introspection reasons, however.
* in the meantime. For this reason, g_settings_get_child() may return
* %NULL even for a child that was listed by this function.
*
* For GSettings objects that are not lists, you should probably not be
* calling this function from "normal" code (since you should already
* know what children are in your schema). This function may still be
* useful there for introspection reasons, however.
* *
* 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.