[glib/new-gsettings] Documentation fixes
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib/new-gsettings] Documentation fixes
- Date: Fri, 16 Apr 2010 21:53:47 +0000 (UTC)
commit 97e34bd9fba0279f1bff6fd16ced347996540baf
Author: Matthias Clasen <mclasen redhat com>
Date: Fri Apr 16 17:51:59 2010 -0400
Documentation fixes
docs/reference/gio/Makefile.am | 3 +++
docs/reference/gio/gsettings-schema-convert.xml | 4 +++-
gio/gsettings.c | 9 +++++----
gio/gsettings.h | 4 ++--
gio/gsettingsbackend.c | 4 ++--
5 files changed, 15 insertions(+), 9 deletions(-)
---
diff --git a/docs/reference/gio/Makefile.am b/docs/reference/gio/Makefile.am
index a171c2c..66e686a 100644
--- a/docs/reference/gio/Makefile.am
+++ b/docs/reference/gio/Makefile.am
@@ -26,6 +26,7 @@ IGNORE_HFILES= \
fen-node.h \
gasynchelper.h \
gcontenttypeprivate.h \
+ gdelayedsettingsbackend.h \
gdummyfile.h \
gfamdirectorymonitor.h \
gfamfilemonitor.h \
@@ -37,6 +38,7 @@ IGNORE_HFILES= \
gio.h \
gioalias.h \
gioalias.h \
+ gkeyfilesettingsbackend.h \
gioenumtypes.h \
giomodule-priv.h \
glocaldirectorymonitor.h \
@@ -49,6 +51,7 @@ IGNORE_HFILES= \
glocalvfs.h \
gnativevolumemonitor.h \
gnetworkingprivate.h \
+ gnullsettingsbackend.h \
gpollfilemonitor.h \
gsettingsbackendinternal.h \
gthreadedresolver.h \
diff --git a/docs/reference/gio/gsettings-schema-convert.xml b/docs/reference/gio/gsettings-schema-convert.xml
index 0998aef..837db40 100644
--- a/docs/reference/gio/gsettings-schema-convert.xml
+++ b/docs/reference/gio/gsettings-schema-convert.xml
@@ -77,11 +77,13 @@ is not explicitly specified, a GConf schema will be converted
into a simple Gsettings schema, and a simple GSettings schema
will be converted into XML.
</para></listitem>
+</varlistentry>
<varlistentry>
<term><option>-i <replaceable>ID</replaceable></option>, <option>--schema-id=<replaceable>ID</replaceable></option></term>
<listitem><para>
-Use <replaceable>ID</replaceable> as the schema id in the generated GSettings schema.
+Use <replaceable>ID</replaceable> as the schema id in the generated
+GSettings schema.
</para></listitem>
</varlistentry>
diff --git a/gio/gsettings.c b/gio/gsettings.c
index 969e035..a78536a 100644
--- a/gio/gsettings.c
+++ b/gio/gsettings.c
@@ -795,6 +795,7 @@ g_settings_get_value (GSettings *settings,
* @settings: a #GSettings object
* @key: the name of the key to set
* @value: a #GVariant of the correct type
+ * @returns: %TRUE if setting succeeded, %FALSE if the key was not writable
*
* Sets @key in @settings to @value.
*
@@ -834,7 +835,7 @@ g_settings_set_value (GSettings *settings,
* g_settings_get:
* @settings: a #GSettings object
* @key: the key to get the value for
- * @format_string: a #GVariant format string
+ * @format: a #GVariant format string
* @...: arguments as per @format
*
* Gets the value that is stored at @key in @settings.
@@ -851,7 +852,7 @@ g_settings_set_value (GSettings *settings,
void
g_settings_get (GSettings *settings,
const gchar *key,
- const gchar *format_string,
+ const gchar *format,
...)
{
GVariant *value;
@@ -859,8 +860,8 @@ g_settings_get (GSettings *settings,
value = g_settings_get_value (settings, key);
- va_start (ap, format_string);
- g_variant_get_va (value, format_string, NULL, &ap);
+ va_start (ap, format);
+ g_variant_get_va (value, format, NULL, &ap);
va_end (ap);
g_variant_unref (value);
diff --git a/gio/gsettings.h b/gio/gsettings.h
index ff3f348..d6beb6d 100644
--- a/gio/gsettings.h
+++ b/gio/gsettings.h
@@ -85,11 +85,11 @@ GVariant * g_settings_get_value (GSettin
gboolean g_settings_set (GSettings *settings,
const gchar *key,
- const gchar *format_string,
+ const gchar *format,
...);
void g_settings_get (GSettings *settings,
const gchar *key,
- const gchar *format_string,
+ const gchar *format,
...);
gint g_settings_get_int (GSettings *settings,
diff --git a/gio/gsettingsbackend.c b/gio/gsettingsbackend.c
index aecc4a7..c279063 100644
--- a/gio/gsettingsbackend.c
+++ b/gio/gsettingsbackend.c
@@ -272,7 +272,7 @@ g_settings_backend_keys_changed (GSettingsBackend *backend,
}
/**
- * g_settings_backend_keys_changed:
+ * g_settings_backend_path_changed:
* @backend: a #GSettingsBackend implementation
* @path: the path containing the changes
* @origin_tag: the origin tag
@@ -341,7 +341,7 @@ g_settings_backend_writable_changed (GSettingsBackend *backend,
}
/**
- * g_settings_backend_writable_changed:
+ * g_settings_backend_path_writable_changed:
* @backend: a #GSettingsBackend implementation
* @path: the name of the path
*
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]