From ecb12c2dc5e019406a8a2d57677cc9ac1ac9adb2 Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Fri, 10 Dec 2010 11:35:15 +0000
Subject: improve QXmppPresence documentation

---
 src/QXmppPresence.cpp | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

(limited to 'src/QXmppPresence.cpp')

diff --git a/src/QXmppPresence.cpp b/src/QXmppPresence.cpp
index b5cbae9a..81a47d63 100644
--- a/src/QXmppPresence.cpp
+++ b/src/QXmppPresence.cpp
@@ -29,6 +29,11 @@
 #include <QXmlStreamWriter>
 #include "QXmppConstants.h"
 
+/// Constructs a QXmppPresence.
+///
+/// \param type
+/// \param status
+
 QXmppPresence::QXmppPresence(QXmppPresence::Type type,
                              const QXmppPresence::Status& status)
     : QXmppStanza(),
@@ -39,31 +44,52 @@ QXmppPresence::QXmppPresence(QXmppPresence::Type type,
 
 }
 
+/// Destroys a QXmppPresence.
+
 QXmppPresence::~QXmppPresence()
 {
 
 }
 
+/// Returns the presence type.
+///
+/// You can use this method to determine the action which needs to be
+/// taken in response to receiving the presence. For instance, if the type is
+/// QXmppPresence::Available or QXmppPresence::Unavailable, you could update
+/// the icon representing a contact's availability.
+
 QXmppPresence::Type QXmppPresence::type() const
 {
     return m_type;
 }
 
+/// Sets the presence type.
+///
+/// \param type
+
 void QXmppPresence::setType(QXmppPresence::Type type)
 {
     m_type = type;
 }
 
+/// Returns the presence status.
+
 const QXmppPresence::Status& QXmppPresence::status() const
 {
     return m_status;
 }
 
+/// Returns a reference to the presence status, allowing you to change it.
+
 QXmppPresence::Status& QXmppPresence::status()
 {
     return m_status;
 }
 
+/// Sets the presence status.
+///
+/// \param status
+
 void QXmppPresence::setStatus(const QXmppPresence::Status& status)
 {
     m_status = status;
-- 
cgit v1.2.3