Attachment 60852 Details for Bug 49338 – 15/15] Provide introductory doc-comments for all the new cli-* sections

[patch] 15/15] Provide introductory doc-comments for all the new cli-* sections

0015-Provide-introductory-doc-comments-for-all-the-new-cl.patch (text/plain), 3.61 KB, created by Simon McVittie on 2012-05-01 06:49:15 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Simon McVittie

Created: 2012-05-01 06:49:15 UTC

Size: 3.61 KB

patch

obsolete

>From 0b7569e53595455ca31a703b5fc986874f79c3c9 Mon Sep 17 00:00:00 2001
>From: Simon McVittie <simon.mcvittie@collabora.co.uk>
>Date: Tue, 1 May 2012 14:31:52 +0100
>Subject: [PATCH 15/15] Provide introductory doc-comments for all the new
> cli-* sections
>
>---
> 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.
>+ */
>-- 
>1.7.10
>

Actions: View | Splinter Review

Attachments on bug 49338: 60836 | 60837 | 60840 | 60841 | 60842 | 60843 | 60844 | 60845 | 60846 | 60847 | 60848 | 60849 | 60850 | 60851 | 60852

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.