telepathy-qt: Contact: Add documentation for clientTypes

[Dario Freddi]

Module: telepathy-qt
Branch: master
Commit: f4e6d194141ef9f8fb53d6e27a008010c8cd6752
URL:    http://cgit.freedesktop.org/telepathy/telepathy-qt/commit/?id=f4e6d194141ef9f8fb53d6e27a008010c8cd6752

Author: Dario Freddi <dario.freddi at collabora.com>
Date:   Thu Jul  5 13:22:16 2012 +0200

Contact: Add documentation for clientTypes

---

 TelepathyQt/contact.cpp |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)

diff --git a/TelepathyQt/contact.cpp b/TelepathyQt/contact.cpp
index d73ae2c..d33b0a2 100644
--- a/TelepathyQt/contact.cpp
+++ b/TelepathyQt/contact.cpp
@@ -929,6 +929,16 @@ PendingOperation *Contact::removeFromGroup(const QString &group)
 }
 
 /**
+ * Return the client types of this contact, if known.
+ *
+ * Client types are represented using the values documented by the XMPP registrar, with some additional
+ * types. A contact can set one or more client types, or can simply advertise itself as unknown - in this
+ * case, an empty list is returned.
+ *
+ * This method requires FeatureClientTypes to be ready.
+ *
+ * \return A list of the client types advertised by this contact.
+ * \sa requestClientTypes, clientTypesUpdated
  */
 QStringList Contact::clientTypes() const
 {