document how to use QXmppVCard::photo() as an image

1 files changed, 10 insertions, 0 deletions

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
 {