[next] telepathy-glib: debug-client: fix doc
Simon McVittie
smcv at kemper.freedesktop.org
Wed Apr 25 07:26:07 PDT 2012
Module: telepathy-glib
Branch: next
Commit: 07440903a1228b8ad31100f45dde422e7fe59389
URL: http://cgit.freedesktop.org/telepathy/telepathy-glib/commit/?id=07440903a1228b8ad31100f45dde422e7fe59389
Author: Guillaume Desmottes <guillaume.desmottes at collabora.co.uk>
Date: Thu Apr 12 16:38:58 2012 +0200
debug-client: fix doc
---
docs/reference/telepathy-glib-docs.sgml | 1 +
docs/reference/telepathy-glib-sections.txt | 29 +++++++++++++++++++++++++
telepathy-glib/debug-client.c | 32 +++++++++++++++++++++++++--
3 files changed, 59 insertions(+), 3 deletions(-)
diff --git a/docs/reference/telepathy-glib-docs.sgml b/docs/reference/telepathy-glib-docs.sgml
index 7918bb1..e6c2c6b 100644
--- a/docs/reference/telepathy-glib-docs.sgml
+++ b/docs/reference/telepathy-glib-docs.sgml
@@ -98,6 +98,7 @@
<xi:include href="xml/call-content.xml"/>
<xi:include href="xml/call-stream.xml"/>
<xi:include href="xml/call-misc.xml"/>
+ <xi:include href="xml/debug-client.xml"/>
</chapter>
<chapter id="ch-service-dbus">
diff --git a/docs/reference/telepathy-glib-sections.txt b/docs/reference/telepathy-glib-sections.txt
index 4541f8b..c463b03 100644
--- a/docs/reference/telepathy-glib-sections.txt
+++ b/docs/reference/telepathy-glib-sections.txt
@@ -7175,3 +7175,32 @@ tp_base_media_call_channel_get_type
<SUBSECTION Private>
TpBaseMediaCallChannelPrivate
</SECTION>
+
+<SECTION>
+<INCLUDE>telepathy-glib/telepathy-glib.h</INCLUDE>
+<FILE>debug-client</FILE>
+<TITLE>TpDebugClient</TITLE>
+<SUBSECTION>
+TpDebugClient
+TpDebugClientClass
+tp_cli_debug_call_get_messages
+tp_cli_debug_callback_for_get_messages
+tp_cli_debug_connect_to_new_debug_message
+tp_cli_debug_signal_callback_new_debug_message
+tp_debug_client_init_known_interfaces
+tp_debug_client_new
+tp_debug_client_set_enabled_async
+tp_debug_client_set_enabled_finish
+<SUBSECTION Standard>
+TP_DEBUG_CLIENT
+TP_DEBUG_CLIENT_CLASS
+TP_DEBUG_CLIENT_FEATURE_CORE
+TP_DEBUG_CLIENT_GET_CLASS
+TP_IS_DEBUG_CLIENT
+TP_IS_DEBUG_CLIENT_CLASS
+TP_TYPE_DEBUG_CLIENT
+tp_debug_client_get_type
+tp_debug_client_get_feature_quark_core
+<SUBSECTION Private>
+TpDebugClientPrivate
+</SECTION>
diff --git a/telepathy-glib/debug-client.c b/telepathy-glib/debug-client.c
index 45ef935..b2b794a 100644
--- a/telepathy-glib/debug-client.c
+++ b/telepathy-glib/debug-client.c
@@ -60,9 +60,9 @@ struct _TpDebugClientClass {
/**
* TpDebugClient:
*
- * A proxy object for a Telepathy connection manager.
+ * A proxy object for the debug interface of a Telepathy component.
*
- * Since: 0.7.1
+ * Since: 0.UNRELEASED
*/
struct _TpDebugClient {
TpProxy parent;
@@ -74,7 +74,8 @@ struct _TpDebugClientPrivate {
gboolean enabled;
};
-static const TpProxyFeature *tp_debug_client_list_features (TpProxyClass *klass);
+static const TpProxyFeature *tp_debug_client_list_features (
+ TpProxyClass *klass);
static void tp_debug_client_prepare_core (TpDebugClient *self);
static void name_owner_changed_cb (TpDBusDaemon *bus,
const gchar *name,
@@ -259,6 +260,7 @@ tp_debug_client_init_known_interfaces (void)
* @dbus: a D-Bus daemon; may not be %NULL
* @unique_name: the unique name of the process to be debugged; may not be
* %NULL or a well-known name
+ * @error: used to raise an error if @unique_name is not valid
*
* <!-- -->
*
@@ -298,6 +300,19 @@ set_enabled_cb (
g_simple_async_result_complete (result);
}
+/**
+ * tp_debug_client_set_enabled_async:
+ * @self: a #TpDebugClient
+ * @enabled: %TRUE if debug messages should be published on the bus, %FALSE
+ * otherwise
+ * @callback: a callback to call when the request is satisfied
+ * @user_data: data to pass to @callback
+ *
+ * Enable or disable publishing of debug messages on the bus by the component
+ * owning @self's bus name.
+ *
+ * Since: 0.UNRELEASED
+ */
void
tp_debug_client_set_enabled_async (
TpDebugClient *self,
@@ -316,6 +331,17 @@ tp_debug_client_set_enabled_async (
g_value_unset (&v);
}
+/**
+ * tp_debug_client_set_enabled_finish:
+ * @self: a #TpDebugClient
+ * @result: a #GAsyncResult
+ * @error: a #GError to fill
+ *
+ * Finishes tp_debug_client_set_enabled_async().
+ *
+ * Returns: %TRUE, if the operation suceeded, %FALSE otherwise
+ * Since: UNRELEASED
+ */
gboolean
tp_debug_client_set_enabled_finish (
TpDebugClient *self,
More information about the telepathy-commits
mailing list