[Pkg-telepathy-commits] [telepathy-glib-1] 180/212: Fix a few outdated doc

Simon McVittie smcv at debian.org
Wed May 14 12:09:13 UTC 2014


This is an automated email from the git hooks/post-receive script.

smcv pushed a commit to branch debian
in repository telepathy-glib-1.

commit 5c792276f68b8fb7334c7648a31709827c52cd89
Author: Xavier Claessens <xavier.claessens at collabora.com>
Date:   Mon Apr 14 14:17:45 2014 -0400

    Fix a few outdated doc
    
    Reviewed-by: Simon McVittie <simon.mcvittie at collabora.co.uk>
    Bug: https://bugs.freedesktop.org/show_bug.cgi?id=77189
---
 telepathy-glib/base-connection.c   | 15 +++++----------
 telepathy-glib/base-contact-list.c | 28 ++++++----------------------
 2 files changed, 11 insertions(+), 32 deletions(-)

diff --git a/telepathy-glib/base-connection.c b/telepathy-glib/base-connection.c
index 9ac6fbe..3d284a6 100644
--- a/telepathy-glib/base-connection.c
+++ b/telepathy-glib/base-connection.c
@@ -22,17 +22,12 @@
 /**
  * SECTION:base-connection
  * @title: TpBaseConnection
- * @short_description: base class for #TpSvcConnection implementations
- * @see_also: #TpBaseConnectionManager, #TpSvcConnection
+ * @short_description: base class for core Connection D-Bus interfaces
+ *  implementation
+ * @see_also: #TpBaseConnectionManager, #TpBaseContactList, #TpPresenceMixin
  *
- * This base class makes it easier to write #TpSvcConnection implementations
+ * This base class makes it easier to write Connection implementations
  * by managing connection status, channel managers and handle tracking.
- * A subclass should often not need to implement any of the Connection
- * methods itself.
- *
- * However, methods may be reimplemented if needed: for instance, Gabble
- * overrides RequestHandles so it can validate MUC rooms, which must be done
- * asynchronously.
  */
 
 /**
@@ -166,7 +161,7 @@
 /**
  * TpBaseConnection:
  *
- * Data structure representing a generic #TpSvcConnection implementation.
+ * Data structure representing a generic connection implementation.
  *
  */
 
diff --git a/telepathy-glib/base-contact-list.c b/telepathy-glib/base-contact-list.c
index 6fca75d..1965832 100644
--- a/telepathy-glib/base-contact-list.c
+++ b/telepathy-glib/base-contact-list.c
@@ -51,14 +51,9 @@
  *
  * Connection managers should subclass #TpBaseContactList, implementing the
  * virtual methods for core functionality in #TpBaseContactListClass.
- * Then, in the connection manager's #TpBaseConnection subclass:
- *
- * <itemizedlist>
- *  <listitem>
- *   <para>in the #TpBaseConnectionClass.fill_contact_attributes
- *    implementation, call tp_base_contact_list_fill_contact_attributes()
- *    and do not chain up if it returns %TRUE:
- *    </para>
+ * Then, in the #TpBaseConnectionClass.fill_contact_attributes implementation,
+ * call tp_base_contact_list_fill_contact_attributes() and do not chain up if it
+ * returns %TRUE:
  * |[
  * // ...
  * if (!tp_strdiff (dbus_interface, MY_IFACE_CONNECTION_INTERFACE_HATS))
@@ -76,22 +71,11 @@
  * ((TpBaseConnectionClass *) my_connection_parent_class)->
  *     fill_contact_attributes (self, dbus_interface, contact, attributes);
  * ]|
- *  </listitem>
- *  <listitem>
- *   <para>include %TP_IFACE_CONNECTION_INTERFACE_CONTACT_LIST1 in
- *    the output of
- *    #TpBaseConnectionClass.get_interfaces_always_present</para>
- *  </listitem>
- * </itemizedlist>
- *
- * To support user-defined contact groups too, additionally implement
- * %TP_TYPE_CONTACT_GROUP_LIST in the #TpBaseContactList subclass, add the
- * %TP_IFACE_CONNECTION_INTERFACE_CONTACT_GROUPS1 interface to the output of
- * #TpBaseConnectionClass.get interfaces_always_present.
  *
  * Optionally, one or more of the #TP_TYPE_MUTABLE_CONTACT_LIST,
- * #TP_TYPE_MUTABLE_CONTACT_GROUP_LIST, and #TP_TYPE_BLOCKABLE_CONTACT_LIST
- * GObject interfaces may also be implemented, as appropriate to the protocol.
+ * #TP_TYPE_CONTACT_GROUP_LIST, #TP_TYPE_MUTABLE_CONTACT_GROUP_LIST, and
+ * #TP_TYPE_BLOCKABLE_CONTACT_LIST GObject interfaces may also be implemented,
+ * as appropriate to the protocol.
  *
  * Since: 0.13.0
  */

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-telepathy/telepathy-glib-1.git



More information about the Pkg-telepathy-commits mailing list