summaryrefslogtreecommitdiff
path: root/common
diff options
context:
space:
mode:
authorRyan Lortie <desrt@desrt.ca>2010-08-03 20:58:35 -0400
committerRyan Lortie <desrt@desrt.ca>2010-08-03 21:03:00 -0400
commit4f72d7e55ac02f0d3c0a5a73b415578e6c68ffa7 (patch)
tree33903ebaaab5a84d039f5ea7eed3a01867acb904 /common
parent9dd9bcfc132980f0056f8bfc31669029d90860d9 (diff)
downloaddconf-4f72d7e55ac02f0d3c0a5a73b415578e6c68ffa7.tar.gz
More cleanups and gtk-doc fill-in
Diffstat (limited to 'common')
-rw-r--r--common/dconf-paths.c14
1 files changed, 14 insertions, 0 deletions
diff --git a/common/dconf-paths.c b/common/dconf-paths.c
index 8a63704..1278d64 100644
--- a/common/dconf-paths.c
+++ b/common/dconf-paths.c
@@ -22,6 +22,20 @@
#include "dconf-paths.h"
+/**
+ * SECTION:paths
+ * @title: DConf Paths
+ * @short_description: utility functions to validate dconf paths
+ *
+ * Various places in the dconf API speak of "paths", "keys", "dirs" and
+ * relative versions of each of these. This file contains functions to
+ * check if a given string is a valid member of each of these classes
+ * and to report errors when a string is not.
+ *
+ * See each function in this section for a precise description of what
+ * makes a string a valid member of a given class.
+ **/
+
#define vars gchar c, l
#define DCONF_ERROR 0