[glib] Document new API



commit a6caaebea7261601fb4f9f57bb8aeadf38e5e499
Author: Matthias Clasen <mclasen redhat com>
Date:   Tue Feb 8 10:05:00 2011 -0500

    Document new API

 gio/gmemorysettingsbackend.c |   13 +++++++++++++
 gio/gnullsettingsbackend.c   |   13 +++++++++++++
 2 files changed, 26 insertions(+), 0 deletions(-)
---
diff --git a/gio/gmemorysettingsbackend.c b/gio/gmemorysettingsbackend.c
index 5d747b5..14e3fcd 100644
--- a/gio/gmemorysettingsbackend.c
+++ b/gio/gmemorysettingsbackend.c
@@ -174,6 +174,19 @@ g_memory_settings_backend_class_init (GMemorySettingsBackendClass *class)
   object_class->finalize = g_memory_settings_backend_finalize;
 }
 
+/**
+ * g_memory_settings_backend_new:
+ *
+ * Creates a memory-backed #GSettingsBackend.
+ *
+ * This backend allows changes to settings, but does not write them
+ * to any backing storage, so the next time you run your application,
+ * the memory backend will start out with the default values again.
+ *
+ * Returns: (transfer full): a newly created #GSettingsBackend
+ *
+ * Since: 2.28
+ */
 GSettingsBackend *
 g_memory_settings_backend_new (void)
 {
diff --git a/gio/gnullsettingsbackend.c b/gio/gnullsettingsbackend.c
index d994f08..523f074 100644
--- a/gio/gnullsettingsbackend.c
+++ b/gio/gnullsettingsbackend.c
@@ -119,6 +119,19 @@ g_null_settings_backend_class_init (GNullSettingsBackendClass *class)
   backend_class->get_permission = g_null_settings_backend_get_permission;
 }
 
+/**
+ * g_null_settings_backend_new:
+ *
+ *
+ * Creates a readonly #GSettingsBackend.
+ *
+ * This backend does not allow changes to settings, so all settings
+ * will always have their default values.
+ *
+ * Returns: (transfer full): a newly created #GSettingsBackend
+ *
+ * Since: 2.28
+ */
 GSettingsBackend *
 g_null_settings_backend_new (void)
 {



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]