[devhelp] Settings: more docs



commit 88b3519705caccc3dfbe8f1fb1e0f642728f33db
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sat Apr 28 13:59:11 2018 +0200

    Settings: more docs

 devhelp/dh-settings.c |   21 ++++++++++++++++-----
 1 files changed, 16 insertions(+), 5 deletions(-)
---
diff --git a/devhelp/dh-settings.c b/devhelp/dh-settings.c
index 68e722a..f816804 100644
--- a/devhelp/dh-settings.c
+++ b/devhelp/dh-settings.c
@@ -45,11 +45,22 @@
  * can be changed to expose publicly the #GSettings objects (for that purpose
  * only).
  *
- * If you want to save a setting, but with a different default value than the
- * one provided by the libdevhelp #GSettings schema, the recommended thing to do
- * is to *not* call the bind function provided by #DhSettings for that property,
- * provide your own #GSettings schema with the same key but with a different
- * default value, and call yourself g_settings_bind().
+ * # Different default value
+ *
+ * If you want to save a #DhSettings setting with #GSettings, but with a
+ * different default value than the one provided by the libdevhelp #GSettings
+ * schema, the recommended thing to do is to *not* call the bind function
+ * provided by #DhSettings for that property, provide your own #GSettings schema
+ * with the same key but with a different default value, and call yourself
+ * g_settings_bind().
+ *
+ * # GSettings keys without corresponding properties
+ *
+ * For the following #GSettings keys, the use of #GSettings is mandatory, there
+ * are no corresponding #DhSettings properties (and thus no bind function).
+ *
+ * - `"books-disabled"`: if the use of #GSettings is not wanted, a custom
+ *   #DhBookList can be created instead.
  */
 
 /* API design:


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