[next] telepathy-glib: Provide introductory doc-comments for all the new cli-* sections

Simon McVittie smcv at kemper.freedesktop.org
Wed May 2 04:26:11 PDT 2012


Module: telepathy-glib
Branch: next
Commit: c7c73204dd20160db0253da895e8cfb66800e044
URL:    http://cgit.freedesktop.org/telepathy/telepathy-glib/commit/?id=c7c73204dd20160db0253da895e8cfb66800e044

Author: Simon McVittie <simon.mcvittie at collabora.co.uk>
Date:   Tue May  1 14:31:52 2012 +0100

Provide introductory doc-comments for all the new cli-* sections

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=49338
Reviewed-by: Jonny Lamb <jonny.lamb at collabora.co.uk>

---

 telepathy-glib/channel.c      |    4 --
 telepathy-glib/extra-gtkdoc.h |   66 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 66 insertions(+), 4 deletions(-)

diff --git a/telepathy-glib/channel.c b/telepathy-glib/channel.c
index 259ca2e..2a1371e 100644
--- a/telepathy-glib/channel.c
+++ b/telepathy-glib/channel.c
@@ -51,10 +51,6 @@
  *
  * * calling GetChannelType(), GetInterfaces(), GetHandles() automatically
  *
- * This section also documents the auto-generated C wrappers for the
- * Channel D-Bus interface. Of these, in general, only
- * tp_cli_channel_call_close() is useful (the
- * #TpChannel object provides a more convenient API for the rest).
  *
  * Since: 0.7.1
  */
diff --git a/telepathy-glib/extra-gtkdoc.h b/telepathy-glib/extra-gtkdoc.h
index 84a5f12..e9f5324 100644
--- a/telepathy-glib/extra-gtkdoc.h
+++ b/telepathy-glib/extra-gtkdoc.h
@@ -388,6 +388,17 @@
  */
 
 /**
+ * SECTION:cli-channel
+ * @title: Channel interface
+ * @short_description: client-side wrappers for Channel core functionality
+ * @see_also: #TpChannel
+ *
+ * This section documents the auto-generated C wrappers for the
+ * Channel D-Bus interface. These are not generally useful
+ * (the #TpChannel object provides a more convenient API for them).
+ */
+
+/**
  * SECTION:channel-group
  * @title: Group and Conference interfaces on Channels
  * @short_description: client-side wrappers for Group and Conference
@@ -530,6 +541,17 @@
  */
 
 /**
+ * SECTION:cli-connection
+ * @title: Connection interface
+ * @short_description: client-side wrappers for Connection core functionality
+ * @see_also: #TpConnection
+ *
+ * This section documents the auto-generated C wrappers for the
+ * Connection D-Bus interface. These are not generally useful
+ * (the #TpConnection object provides a more convenient API for them).
+ */
+
+/**
  * SECTION:connection-avatars
  * @title: Connection Avatars interface
  * @short_description: client-side wrappers for the Avatars interface
@@ -990,3 +1012,47 @@
  *
  * Since: 0.17.5
  */
+
+/**
+ * SECTION:cli-connection-manager
+ * @title: ConnectionManager interface
+ * @short_description: client-side wrappers for ConnectionManager core
+ *  functionality
+ * @see_also: #TpConnectionManager
+ *
+ * This section documents the auto-generated C wrappers for the
+ * ConnectionManager D-Bus interface.
+ */
+
+/**
+ * SECTION:cli-channel-dispatcher
+ * @title: ChannelDispatcher interface
+ * @short_description: client-side wrappers for ChannelDispatcher core
+ *  functionality
+ * @see_also: #TpChannelDispatcher
+ *
+ * This section documents the auto-generated C wrappers for the
+ * ChannelDispatcher D-Bus interface.
+ */
+
+/**
+ * SECTION:cli-client
+ * @title: Client interface
+ * @short_description: client-side wrappers for Client functionality
+ * @see_also: #TpClient
+ *
+ * This section documents the auto-generated C wrappers for the
+ * Client, Handler, Approver, Observer and other related D-Bus interfaces.
+ * These should normally only be used by the Channel Dispatcher implementation.
+ */
+
+/**
+ * SECTION:cli-account-manager
+ * @title: AccountManager interface
+ * @short_description: client-side wrappers for AccountManager functionality
+ * @see_also: #TpAccountManager
+ *
+ * This section documents the auto-generated C wrappers for the
+ * AccountManager. These are not usually useful, since #TpAccountManager
+ * provides a high-level API.
+ */



More information about the telepathy-commits mailing list