summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavier Claessens <xavier.claessens@collabora.com>2014-04-14 14:17:45 -0400
committerSimon McVittie <simon.mcvittie@collabora.co.uk>2014-04-17 14:22:30 +0100
commit2e5f4045ad724d95285146726e5c42bfdb846fd7 (patch)
treef04c4187f5d2ac6b2b712e224c6b1ff017ffd3a7
parent69584cd0059d60401ded4f634107a9fb093a830b (diff)
Fix a few outdated doc
-rw-r--r--telepathy-glib/base-connection.c15
-rw-r--r--telepathy-glib/base-contact-list.c28
2 files changed, 11 insertions, 32 deletions
diff --git a/telepathy-glib/base-connection.c b/telepathy-glib/base-connection.c
index 9ac6fbe63..3d284a6e1 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 6fca75d94..196583237 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
*/