[dconf/wip/0-25-1: 7/10] docs: add new APIs



commit 870a2c5afb858d060eeeb0689c6e4ff1dd32d582
Author: Allison Ryan Lortie <desrt desrt ca>
Date:   Wed Dec 16 10:38:22 2015 -0500

    docs: add new APIs
    
    ...and other various cleanups.

 client/dconf-client.c   |   17 +++++++++++++++++
 docs/dconf-docs.xml     |   20 ++++++++++++++++++++
 docs/dconf-sections.txt |    3 +++
 3 files changed, 40 insertions(+), 0 deletions(-)
---
diff --git a/client/dconf-client.c b/client/dconf-client.c
index f71a263..45288fc 100644
--- a/client/dconf-client.c
+++ b/client/dconf-client.c
@@ -246,6 +246,21 @@ dconf_client_read (DConfClient *client,
 }
 
 /**
+ * DConfReadFlags:
+ * @DCONF_READ_FLAGS_NONE: no flags
+ * @DCONF_READ_DEFAULT_VALUE: read the default value, ignoring any
+ *   values in writable databases or any queued changes.  This is
+ *   effectively equivalent to asking what value would be read after a
+ *   reset was written for the key in question.
+ * @DCONF_READ_USER_VALUE: read the user value, ignoring any system
+ *   databases, including ignoring locks.  It is even possible to read
+ *   "invisible" values in the user database in this way, which would
+ *   have normally been ignored because of locks.
+ *
+ * Since: 0.26
+ */
+
+/**
  * dconf_client_read_full:
  * @client: a #DConfClient
  * @key: the key to read the default value of
@@ -335,6 +350,8 @@ dconf_client_list (DConfClient *client,
  * The returned list will be %NULL-terminated.
  *
  * Returns: an array of strings, never %NULL.
+ *
+ * Since: 0.26
  */
 gchar **
 dconf_client_list_locks (DConfClient *client,
diff --git a/docs/dconf-docs.xml b/docs/dconf-docs.xml
index 31af766..324cdac 100644
--- a/docs/dconf-docs.xml
+++ b/docs/dconf-docs.xml
@@ -37,5 +37,25 @@
     <xi:include href='xml/api-index-deprecated.xml'><xi:fallback /></xi:include>
   </index>
 
+  <index id='api-index-0.16' role='0.16'>
+    <title>Index of new symbols in 0.16</title>
+    <xi:include href='xml/api-index-0.16.xml'/>
+  </index>
+
+  <index id='api-index-0.18' role='0.18'>
+    <title>Index of new symbols in 0.18</title>
+    <xi:include href='xml/api-index-0.18.xml'/>
+  </index>
+
+  <index id='api-index-0.20' role='0.20'>
+    <title>Index of new symbols in 0.20</title>
+    <xi:include href='xml/api-index-0.20.xml'/>
+  </index>
+
+  <index id='api-index-0.26' role='0.26'>
+    <title>Index of new symbols in 0.26</title>
+    <xi:include href='xml/api-index-0.26.xml'/>
+  </index>
+
   <xi:include href='xml/annotation-glossary.xml'/>
 </book>
diff --git a/docs/dconf-sections.txt b/docs/dconf-sections.txt
index e6ad847..878c6b9 100644
--- a/docs/dconf-sections.txt
+++ b/docs/dconf-sections.txt
@@ -11,7 +11,10 @@ dconf_error_quark
 DConfClient
 dconf_client_new
 dconf_client_read
+DConfReadFlags
+dconf_client_read_full
 dconf_client_list
+dconf_client_list_locks
 dconf_client_is_writable
 dconf_client_write_fast
 dconf_client_write_sync


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