From 7999763cc5239dade9807996895982b99893f90b Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Sat, 11 Dec 2010 19:38:15 +0000
Subject: document QXmppPresence::Status

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

(limited to 'src/QXmppPresence.cpp')

diff --git a/src/QXmppPresence.cpp b/src/QXmppPresence.cpp
index 81a47d63..64ed0d58 100644
--- a/src/QXmppPresence.cpp
+++ b/src/QXmppPresence.cpp
@@ -303,6 +303,8 @@ void QXmppPresence::setTypeFromStr(const QString& str)
     }
 }
 
+/// Constructs a presence status.
+
 QXmppPresence::Status::Status(QXmppPresence::Status::Type type,
                              const QString statusText, int priority) :
                                 m_type(type),
@@ -310,11 +312,15 @@ QXmppPresence::Status::Status(QXmppPresence::Status::Type type,
 {
 }
 
+/// Returns the status type, for instance busy or away.
+
 QXmppPresence::Status::Type QXmppPresence::Status::type() const
 {
     return m_type;
 }
 
+/// Sets the status type.
+
 void QXmppPresence::Status::setType(QXmppPresence::Status::Type type)
 {
     m_type = type;
@@ -396,21 +402,33 @@ QString QXmppPresence::Status::getTypeStr() const
     return text;
 }
 
+/// Returns the status text, a textual description of the user's status.
+
 QString QXmppPresence::Status::statusText() const
 {
     return m_statusText;
 }
 
+/// Sets the status text, a textual description of the user's status.
+///
+/// \param str The status text, for example "Gone fishing".
+
 void QXmppPresence::Status::setStatusText(const QString& str)
 {
     m_statusText = str;
 }
 
+/// Returns the priority level of the resource.
+
 int QXmppPresence::Status::priority() const
 {
     return m_priority;
 }
 
+/// Sets the priority level of the resource.
+///
+/// \param priority
+
 void QXmppPresence::Status::setPriority(int priority)
 {
     m_priority = priority;
-- 
cgit v1.2.3