From 70c3957a1a90d8d06ed27becd8c2563a781c70b0 Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Wed, 1 Sep 2010 09:03:51 +0000
Subject: document how to use QXmppVCard::photo() as an image

---
 src/QXmppVCard.cpp | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'src/QXmppVCard.cpp')

diff --git a/src/QXmppVCard.cpp b/src/QXmppVCard.cpp
index ee336805..da4ada0a 100644
--- a/src/QXmppVCard.cpp
+++ b/src/QXmppVCard.cpp
@@ -199,6 +199,16 @@ void QXmppVCard::setUrl(const QString& url)
 }
 
 /// Returns the photo's binary contents.
+///
+/// If you want to use the photo as a QImage you can use:
+///
+/// \code
+/// QBuffer buffer;
+/// buffer.setData(myCard.photo());
+/// buffer.open(QIODevice::ReadOnly);
+/// QImageReader imageReader(&buffer);
+/// QImage myImage = imageReader.read();
+/// \endcode
 
 QByteArray QXmppVCard::photo() const
 {
-- 
cgit v1.2.3