[dconf] gtk-doc cleanups
- From: Ryan Lortie <ryanl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [dconf] gtk-doc cleanups
- Date: Fri, 11 Jun 2010 17:19:17 +0000 (UTC)
commit 6a1e24460e76f168fa40a84cafbc6a3e374c32bf
Author: Ryan Lortie <desrt desrt ca>
Date: Fri Jun 11 12:40:56 2010 -0400
gtk-doc cleanups
client/dconf-client.c | 37 ++++++++++++++++++++++---------------
client/dconf-client.h | 12 ++++++------
common/dconf-paths.c | 12 ++++++------
configure.ac | 1 -
docs/Makefile.am | 13 ++++++++++---
docs/sources/client | 1 -
docs/sources/common | 1 -
7 files changed, 44 insertions(+), 33 deletions(-)
---
diff --git a/client/dconf-client.c b/client/dconf-client.c
index 88b8189..fdc33d2 100644
--- a/client/dconf-client.c
+++ b/client/dconf-client.c
@@ -244,12 +244,17 @@ dconf_client_class_init (DConfClientClass *class)
/**
* dconf_client_new:
* @context: the context string (must by %NULL for now)
+ * @will_write: %TRUE if you intend to use the client to write
* @watch_func: the function to call when changes occur
* @user_data: the user_data to pass to @watch_func
* @notify: the function to free @user_data when no longer needed
- * @returns: a new #DConfClient
+ * Returns: a new #DConfClient
*
* Creates a new #DConfClient for the given context.
+ *
+ * If @will_write is %FALSE then you will not be able to use the created
+ * client to write. The benefit of this is that when combined with
+ * @watch_func being %NULL, no connection to D-Bus is required.
**/
DConfClient *
dconf_client_new (const gchar *context,
@@ -273,7 +278,7 @@ dconf_client_new (const gchar *context,
* dconf_client_read:
* @client: a #DConfClient
* @key: a valid dconf key
- * @returns: the value corresponding to @key, or %NULL if there is none
+ * Returns: the value corresponding to @key, or %NULL if there is none
*
* Reads the value named by @key from dconf. If no such value exists,
* %NULL is returned.
@@ -289,7 +294,7 @@ dconf_client_read (DConfClient *client,
* dconf_client_read_default:
* @client: a #DConfClient
* @key: a valid dconf key
- * @returns: the default value corresponding to @key, or %NULL if there
+ * Returns: the default value corresponding to @key, or %NULL if there
* is none
*
* Reads the value named by @key from any existing default/mandatory
@@ -307,7 +312,7 @@ dconf_client_read_default (DConfClient *client,
* dconf_client_read_no_default:
* @client: a #DConfClient
* @key: a valid dconf key
- * @returns: the user value corresponding to @key, or %NULL if there is
+ * Returns: the user value corresponding to @key, or %NULL if there is
* none
*
* Reads the value named by @key as set by the user, ignoring any
@@ -380,19 +385,20 @@ dconf_client_call_sync (DConfClient *client,
* dconf_client_write:
* @client: a #DConfClient
* @key: a dconf key
- * @value (allow-none): a #GVariant, or %NULL
- * @sequence: (out) (allow-none): the sequence number of this write
+ * @value: (allow-none): a #GVariant, or %NULL
+ * @tag: (out) (allow-none): the tag from this write
* @cancellable: a #GCancellable, or %NULL
* @error: a pointer to a #GError, or %NULL
- * @returns: %TRUE if the write is successful
+ * Returns: %TRUE if the write is successful
*
* Write a value to the given @key, or reset @key to its default value.
*
* If @value is %NULL then @key is reset to its default value (which may
* be completely unset), otherwise @value becomes the new value.
*
- * If @sequence is non-%NULL then it is set to the sequence number of
- * this write. The sequence number is unique to this process.
+ * If @tag is non-%NULL then it is set to the unique tag associated with
+ * this write. This is the same tag that appears in change
+ * notifications.
**/
gboolean
dconf_client_write (DConfClient *client,
@@ -414,7 +420,7 @@ dconf_client_write (DConfClient *client,
* dconf_client_write_async:
* @client: a #DConfClient
* @key: a dconf key
- * @value (allow-none): a #GVariant, or %NULL
+ * @value: (allow-none): a #GVariant, or %NULL
* @cancellable: a #GCancellable, or %NULL
* @callback: the function to call when complete
* @user_data: the user data for @callback
@@ -444,7 +450,8 @@ dconf_client_write_async (DConfClient *client,
/**
* dconf_client_write_finish:
* @client: a #DConfClient
- * @sequence: (out) (allow-none): the sequence number of this write
+ * @result: the #GAsyncResult passed to the #GAsyncReadyCallback
+ * @tag: (out) (allow-none): the tag from this write
* @error: a pointer to a #GError, or %NULL
*
* Collects the result from a prior call to dconf_client_write_async().
@@ -465,7 +472,7 @@ dconf_client_write_finish (DConfClient *client,
* @client: a #DConfClient
* @dir: a dconf dir
* @length: the number of items that were returned
- * @returns: (array length=length): the paths located directly below @dir
+ * Returns: (array length=length): the paths located directly below @dir
*
* Lists the keys and dirs located directly below @dir.
*
@@ -474,10 +481,10 @@ dconf_client_write_finish (DConfClient *client,
**/
gchar **
dconf_client_list (DConfClient *client,
- const gchar *prefix,
+ const gchar *dir,
gsize *length)
{
- return dconf_engine_list (client->engine, prefix, NULL, length);
+ return dconf_engine_list (client->engine, dir, NULL, length);
}
/**
@@ -487,7 +494,7 @@ dconf_client_list (DConfClient *client,
* @locked: %TRUE to lock, %FALSE to unlock
* @cancellable: a #GCancellable, or %NULL
* @error: a pointer to a #GError, or %NULL
- * @returns: %TRUE if setting the lock was successful
+ * Returns: %TRUE if setting the lock was successful
*
* Marks a dconf path as being locked.
*
diff --git a/client/dconf-client.h b/client/dconf-client.h
index f6e8f95..ba79044 100644
--- a/client/dconf-client.h
+++ b/client/dconf-client.h
@@ -65,17 +65,17 @@ GVariant * dconf_client_read_no_default (DConfCl
const gchar *key);
gchar ** dconf_client_list (DConfClient *client,
- const gchar *prefix,
+ const gchar *dir,
gsize *length);
gboolean dconf_client_is_writable (DConfClient *client,
- const gchar *prefix,
+ const gchar *path,
GError **error);
gboolean dconf_client_write (DConfClient *client,
const gchar *key,
GVariant *value,
- gchar **sequence,
+ gchar **tag,
GCancellable *cancellable,
GError **error);
void dconf_client_write_async (DConfClient *client,
@@ -86,7 +86,7 @@ void dconf_client_write_async (DConfCl
gpointer user_data);
gboolean dconf_client_write_finish (DConfClient *client,
GAsyncResult *result,
- gchar **sequence,
+ gchar **tag,
GError **error);
gboolean dconf_client_set_locked (DConfClient *client,
@@ -108,7 +108,7 @@ gboolean dconf_client_write_many (DConfCl
const gchar *prefix,
const gchar * const *keys,
GVariant **values,
- gchar **sequence,
+ gchar **tag,
GCancellable *cancellable,
GError **error);
void dconf_client_write_many_async (DConfClient *client,
@@ -120,7 +120,7 @@ void dconf_client_write_many_async (DConfCl
gpointer user_data);
gboolean dconf_client_write_many_finish (DConfClient *client,
GAsyncResult *result,
- gchar **sequence,
+ gchar **tag,
GError **error);
gboolean dconf_client_watch (DConfClient *client,
diff --git a/common/dconf-paths.c b/common/dconf-paths.c
index 20d5798..de1e837 100644
--- a/common/dconf-paths.c
+++ b/common/dconf-paths.c
@@ -53,7 +53,7 @@
/**
* dconf_is_path:
* @string: a string
- * @returns: %TRUE if @string is a path
+ * Returns: %TRUE if @string is a path
*
* Checks if @string is a valid dconf path. dconf keys must start with
* '/' and not contain '//'.
@@ -70,7 +70,7 @@ dconf_is_path (const gchar *string)
/**
* dconf_is_key:
* @string: a string
- * @returns: %TRUE if @string is a key
+ * Returns: %TRUE if @string is a key
*
* Checks if @string is a valid dconf key. dconf keys must start with
* '/', not contain '//' and not end with '/'.
@@ -91,7 +91,7 @@ dconf_is_key (const gchar *string)
/**
* dconf_is_dir:
* @string: a string
- * @returns: %TRUE if @string is a dir
+ * Returns: %TRUE if @string is a dir
*
* Checks if @string is a valid dconf dir. dconf dirs must start and
* end with '/' and not contain '//'.
@@ -113,7 +113,7 @@ dconf_is_dir (const gchar *string)
/**
* dconf_is_rel:
* @string: a string
- * @returns: %TRUE if @string is a relative path
+ * Returns: %TRUE if @string is a relative path
*
* Checks if @string is a valid dconf relative path. A relative path is
* a string that, when concatenated to a dir, forms a valid dconf path.
@@ -132,7 +132,7 @@ dconf_is_rel (const gchar *string)
/**
* dconf_is_rel_key:
* @string: a string
- * @returns: %TRUE if @string is a relative key
+ * Returns: %TRUE if @string is a relative key
*
* Checks if @string is a valid dconf relative key. A relative key is a
* string that, when concatenated to a dir, forms a valid dconf key.
@@ -152,7 +152,7 @@ dconf_is_rel_key (const gchar *string)
/**
* dconf_is_rel_dir:
* @string: a string
- * @returns: %TRUE if @string is a relative dir
+ * Returns: %TRUE if @string is a relative dir
*
* Checks if @string is a valid dconf relative dir. A relative dir is a
* string that, when appended to a dir, forms a valid dconf dir. This
diff --git a/configure.ac b/configure.ac
index b4f9a07..29d4770 100644
--- a/configure.ac
+++ b/configure.ac
@@ -31,7 +31,6 @@ AC_OUTPUT([
service/Makefile
bin/Makefile
tests/Makefile
- docs/sources/Makefile
docs/Makefile
Makefile
])
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 80f140b..0b5b91e 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,16 +1,23 @@
include gtk-doc.make
-SUBDIRS = sources
-
DOC_MODULE = dconf
DOC_MAIN_SGML_FILE = dconf-docs.xml
-DOC_SOURCE_DIR = sources
+DOC_SOURCE_DIR = ..
MKDB_OPTIONS = --output-format=xml
INCLUDES = $(gio_CFLAGS)
GTKDOC_LIBS = $(gio_LIBS) ../client/libdconf.la
+IGNORE_HFILES = \
+ dconf-engine.h \
+ dconf-resetlist.h \
+ dconf-readtype.h \
+ dconf-rebuilder.h \
+ gvdb-builder.h \
+ gvdb-reader.h \
+ gvdb-format.h
+
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
