[glib/new-gsettings] Add some more schema docs
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib/new-gsettings] Add some more schema docs
- Date: Wed, 14 Apr 2010 04:25:37 +0000 (UTC)
commit 4bc82beae536922ff56bae4e57261bce32aa2fdb
Author: Matthias Clasen <mclasen redhat com>
Date: Wed Apr 14 00:22:50 2010 -0400
Add some more schema docs
docs/reference/gio/gio-sections.txt | 3 ++-
gio/gsettings.c | 10 +++++-----
gio/gsettings.h | 2 +-
gio/gsettingsschema.c | 32 ++++++++++++++++++++++++++++++++
4 files changed, 40 insertions(+), 7 deletions(-)
---
diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt
index b0a98f1..0deb175 100644
--- a/docs/reference/gio/gio-sections.txt
+++ b/docs/reference/gio/gio-sections.txt
@@ -2080,7 +2080,8 @@ G_TYPE_FILE_DESCRIPTOR_BASED
<FILE>gsettingsbackend</FILE>
<TITLE>GSettingsBackend</TITLE>
GSettingsBackend
-g_settings_backend_get_default
+g_settings_backend_get_with_context
+g_settings_backend_supports_context
g_settings_backend_create_tree
g_settings_backend_read
g_settings_backend_write
diff --git a/gio/gsettings.c b/gio/gsettings.c
index 9266426..7f4dac6 100644
--- a/gio/gsettings.c
+++ b/gio/gsettings.c
@@ -705,7 +705,7 @@ g_settings_set_value (GSettings *settings,
* g_settings_get:
* @settings: a #GSettings object
* @key: the key to get the value for
- * @format: a #GVariant format string
+ * @format_string: a #GVariant format string
* @...: arguments as per @format
*
* Gets the value that is stored at @key in @settings.
@@ -714,7 +714,7 @@ g_settings_set_value (GSettings *settings,
* g_variant_get().
*
* It is a programmer error to pass a @key that isn't valid for
- * @settings or a @format that doesn't match the type of @key according
+ * @settings or a @format_string that doesn't match the type of @key according
* to the schema of @settings.
*
* Since: 2.26
@@ -722,7 +722,7 @@ g_settings_set_value (GSettings *settings,
void
g_settings_get (GSettings *settings,
const gchar *key,
- const gchar *format,
+ const gchar *format_string,
...)
{
GVariant *value;
@@ -730,8 +730,8 @@ g_settings_get (GSettings *settings,
value = g_settings_get_value (settings, key);
- va_start (ap, format);
- g_variant_get_va (value, format, NULL, &ap);
+ va_start (ap, format_string);
+ g_variant_get_va (value, format_string, NULL, &ap);
va_end (ap);
g_variant_unref (value);
diff --git a/gio/gsettings.h b/gio/gsettings.h
index d15baae..bf7649d 100644
--- a/gio/gsettings.h
+++ b/gio/gsettings.h
@@ -67,7 +67,7 @@ void g_settings_apply (GSettin
gboolean g_settings_get_delay_apply (GSettings *settings);
gboolean g_settings_get_has_unapplied (GSettings *settings);
void g_settings_set_delay_apply (GSettings *settings,
- gboolean delay_apply);
+ gboolean delay);
gboolean g_settings_get_locked (GSettings *settings);
void g_settings_lock (GSettings *settings);
diff --git a/gio/gsettingsschema.c b/gio/gsettingsschema.c
index 7e3479c..1cb0136 100644
--- a/gio/gsettingsschema.c
+++ b/gio/gsettingsschema.c
@@ -31,6 +31,38 @@
*
* The #GSettingsSchema class provides schema information (i.e. types,
* default values and descriptions) for keys in settings.
+ *
+ * Schema information is required to use #GSettings.
+ *
+ * The source format for GSettings schemas is an XML format that can
+ * be described with the following DTD:
+ * |[<![CDATA[
+ * <!ELEMENT schemalist (schema*) >
+ * <!ATTLIST schemalist gettext-domain #IMPLIED >
+ *
+ * <!ELEMENT schema (key*) >
+ * <!ATTLIST schema id #REQUIRED
+ * path #IMPLIED
+ * gettext-domain #IMPLIED >
+ *
+ * <!ELEMENT key (default|summary|description|range)* >
+ * <!ATTLIST key name #REQUIRED
+ * type #REQUIRED >
+ *
+ * <!ELEMENT default (#PCDATA) >
+ * <!ATTLIST default l10n #IMPLIED >
+ *
+ * <!ELEMENT summary (#PCDATA) >
+ * <!ELEMENT description (#PCDATA) >
+ * <!ELEMENT range (choice*|(min,max)) >
+ *
+ * <!ELEMENT choice EMPTY >
+ * <!ATTLIST choice value #REQUIRED >
+ *
+ * <!ELEMENT min (#PCDATA) >
+ * <!ELEMENT max (#PCDATA) >
+ * ]]>
+ * ]|
*/
G_DEFINE_TYPE (GSettingsSchema, g_settings_schema, G_TYPE_OBJECT)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]