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

Clarify docs/params for 'schema' vs 'schema id'

Browse Source 
Clean up our parameter naming and documentation to draw a clearer line
between a schema and its identifier.
This commit is contained in:
Ryan Lortie 2011-11-15 12:42:02 +00:00
parent 1e70072065
commit 446eda8c2b
2 changed files with 28 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
gio/gsettings.c
View File

@ -825,10 +825,11 @@ g_settings_class_init (GSettingsClass *class)
/* Construction (new, new_with_path, etc.) {{{1 */ /* Construction (new, new_with_path, etc.) {{{1 */
/** /**
* g_settings_new: * g_settings_new:
* @schema: the name of the schema * @schema_id: the id of the schema
* @returns: a new #GSettings object * @returns: a new #GSettings object
* *
* Creates a new #GSettings object with a given schema. * Creates a new #GSettings object with the schema specified by
* @schema_id.
* *
* Signals on the newly created #GSettings object will be dispatched * Signals on the newly created #GSettings object will be dispatched
* via the thread-default #GMainContext in effect at the time of the * via the thread-default #GMainContext in effect at the time of the
@ -838,22 +839,23 @@ g_settings_class_init (GSettingsClass *class)
* Since: 2.26 * Since: 2.26
*/ */
GSettings * GSettings *
g_settings_new (const gchar *schema) g_settings_new (const gchar *schema_id)
{ {
g_return_val_if_fail (schema != NULL, NULL); g_return_val_if_fail (schema_id != NULL, NULL);
return g_object_new (G_TYPE_SETTINGS, return g_object_new (G_TYPE_SETTINGS,
"schema-id", schema, "schema-id", schema_id,
NULL); NULL);
} }
/** /**
* g_settings_new_with_path: * g_settings_new_with_path:
* @schema: the name of the schema * @schema_id: the id of the schema
* @path: the path to use * @path: the path to use
* @returns: a new #GSettings object * @returns: a new #GSettings object
* *
* Creates a new #GSettings object with a given schema and path. * Creates a new #GSettings object with the relocatable schema specified
* by @schema_id and a given path.
* *
* You only need to do this if you want to directly create a settings * You only need to do this if you want to directly create a settings
* object with a schema that doesn't have a specified path of its own. * object with a schema that doesn't have a specified path of its own.
@ -865,25 +867,26 @@ g_settings_new (const gchar *schema)
* Since: 2.26 * Since: 2.26
*/ */
GSettings * GSettings *
g_settings_new_with_path (const gchar *schema, g_settings_new_with_path (const gchar *schema_id,
const gchar *path) const gchar *path)
{ {
g_return_val_if_fail (schema != NULL, NULL); g_return_val_if_fail (schema_id != NULL, NULL);
g_return_val_if_fail (path != NULL, NULL); g_return_val_if_fail (path != NULL, NULL);
return g_object_new (G_TYPE_SETTINGS, return g_object_new (G_TYPE_SETTINGS,
"schema-id", schema, "schema-id", schema_id,
"path", path, "path", path,
NULL); NULL);
} }
/** /**
* g_settings_new_with_backend: * g_settings_new_with_backend:
* @schema: the name of the schema * @schema_id: the id of the schema
* @backend: the #GSettingsBackend to use * @backend: the #GSettingsBackend to use
* @returns: a new #GSettings object * @returns: a new #GSettings object
* *
* Creates a new #GSettings object with a given schema and backend. * Creates a new #GSettings object with the schema specified by
* @schema_id and a given #GSettingsBackend.
* *
* Creating a #GSettings object with a different backend allows accessing * Creating a #GSettings object with a different backend allows accessing
* settings from a database other than the usual one. For example, it may make * settings from a database other than the usual one. For example, it may make
@ -894,27 +897,27 @@ g_settings_new_with_path (const gchar *schema,
* Since: 2.26 * Since: 2.26
*/ */
GSettings * GSettings *
g_settings_new_with_backend (const gchar *schema, g_settings_new_with_backend (const gchar *schema_id,
GSettingsBackend *backend) GSettingsBackend *backend)
{ {
g_return_val_if_fail (schema != NULL, NULL); g_return_val_if_fail (schema_id != NULL, NULL);
g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL); g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
return g_object_new (G_TYPE_SETTINGS, return g_object_new (G_TYPE_SETTINGS,
"schema-id", schema, "schema-id", schema_id,
"backend", backend, "backend", backend,
NULL); NULL);
} }
/** /**
* g_settings_new_with_backend_and_path: * g_settings_new_with_backend_and_path:
* @schema: the name of the schema * @schema_id: the id of the schema
* @backend: the #GSettingsBackend to use * @backend: the #GSettingsBackend to use
* @path: the path to use * @path: the path to use
* @returns: a new #GSettings object * @returns: a new #GSettings object
* *
* Creates a new #GSettings object with a given schema, backend and * Creates a new #GSettings object with the schema specified by
* path. * @schema_id and a given #GSettingsBackend and path.
* *
* This is a mix of g_settings_new_with_backend() and * This is a mix of g_settings_new_with_backend() and
* g_settings_new_with_path(). * g_settings_new_with_path().
@ -922,16 +925,16 @@ g_settings_new_with_backend (const gchar *schema,
* Since: 2.26 * Since: 2.26
*/ */
GSettings * GSettings *
g_settings_new_with_backend_and_path (const gchar *schema, g_settings_new_with_backend_and_path (const gchar *schema_id,
GSettingsBackend *backend, GSettingsBackend *backend,
const gchar *path) const gchar *path)
{ {
g_return_val_if_fail (schema != NULL, NULL); g_return_val_if_fail (schema_id != NULL, NULL);
g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL); g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
g_return_val_if_fail (path != NULL, NULL); g_return_val_if_fail (path != NULL, NULL);
return g_object_new (G_TYPE_SETTINGS, return g_object_new (G_TYPE_SETTINGS,
"schema-id", schema, "schema-id", schema_id,
"backend", backend, "backend", backend,
"path", path, "path", path,
NULL); NULL);

8
gio/gsettings.h
View File

@ -73,12 +73,12 @@ GType g_settings_get_type (void);
const gchar * const * g_settings_list_schemas (void); const gchar * const * g_settings_list_schemas (void);
const gchar * const * g_settings_list_relocatable_schemas (void); const gchar * const * g_settings_list_relocatable_schemas (void);
GSettings * g_settings_new (const gchar *schema); GSettings * g_settings_new (const gchar *schema_id);
GSettings * g_settings_new_with_path (const gchar *schema, GSettings * g_settings_new_with_path (const gchar *schema_id,
const gchar *path); const gchar *path);
GSettings * g_settings_new_with_backend (const gchar *schema, GSettings * g_settings_new_with_backend (const gchar *schema_id,
GSettingsBackend *backend); GSettingsBackend *backend);
GSettings * g_settings_new_with_backend_and_path (const gchar *schema, GSettings * g_settings_new_with_backend_and_path (const gchar *schema_id,
GSettingsBackend *backend, GSettingsBackend *backend,
const gchar *path); const gchar *path);
GSettings * g_settings_new_full (GSettingsSchema *schema, GSettings * g_settings_new_full (GSettingsSchema *schema,