From b04c25917bf5954df0e67855fe5e5bdd657daf9a Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Thu, 15 Apr 2010 08:39:24 +0000
Subject: add code documentation for QXmppRosterIq::Item

---
 source/QXmppRosterIq.cpp | 55 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)

(limited to 'source/QXmppRosterIq.cpp')

diff --git a/source/QXmppRosterIq.cpp b/source/QXmppRosterIq.cpp
index 320cb8bb..ce608aa2 100644
--- a/source/QXmppRosterIq.cpp
+++ b/source/QXmppRosterIq.cpp
@@ -70,52 +70,107 @@ void QXmppRosterIq::toXmlElementFromChild(QXmlStreamWriter *writer) const
     writer->writeEndElement();
 }
 
+/// Returns the bareJid of the roster entry.
+///
+/// \return bareJid as a QString
+///
+
 QString QXmppRosterIq::Item::bareJid() const
 {
     return m_bareJid;
 }
 
+/// Sets the bareJid of the roster entry.
+///
+/// \param bareJid as a QString
+///
+
 void QXmppRosterIq::Item::setBareJid(const QString& str)
 {
     m_bareJid = str;
 }
 
+/// Returns the groups of the roster entry.
+///
+/// \return QSet<QString> list of all the groups
+///
+
 QSet<QString> QXmppRosterIq::Item::groups() const
 {
     return m_groups;
 }
 
+/// Sets the groups of the roster entry.
+///
+/// \param groups list of all the groups as a QSet<QString>
+///
+
 void QXmppRosterIq::Item::setGroups(const QSet<QString>& groups)
 {
     m_groups = groups;
 }
 
+/// Returns the name of the roster entry.
+///
+/// \return name as a QString
+///
+
 QString QXmppRosterIq::Item::name() const
 {
     return m_name;
 }
 
+/// Sets the name of the roster entry.
+///
+/// \param name as a QString
+///
+
 void QXmppRosterIq::Item::setName(const QString& str)
 {
     m_name = str;
 }
 
+/// Returns the subscription status of the roster entry. It is the "ask"
+/// attribute in the Roster IQ stanza. Its value can be "subscribe" or "unsubscribe"
+/// or empty.
+///
+/// \return subscription status as a QString
+///
+///
+
 QString QXmppRosterIq::Item::subscriptionStatus() const
 {
     return m_subscriptionStatus;
 }
 
+/// Sets the subscription status of the roster entry. It is the "ask"
+/// attribute in the Roster IQ stanza. Its value can be "subscribe" or "unsubscribe"
+/// or empty.
+///
+/// \param status as a QString
+///
+
 void QXmppRosterIq::Item::setSubscriptionStatus(const QString& str)
 {
     m_subscriptionStatus = str;
 }
 
+/// Returns the subscription type of the roster entry.
+///
+/// \return QXmppRosterEntry::SubscriptionType
+///
+
 QXmppRosterIq::Item::SubscriptionType
         QXmppRosterIq::Item::subscriptionType() const
 {
     return m_type;
 }
 
+/// Sets the subscription type of the roster entry.
+///
+/// \param type as a QXmppRosterEntry::SubscriptionType
+///
+
 void QXmppRosterIq::Item::setSubscriptionType(SubscriptionType type)
 {
     m_type = type;
-- 
cgit v1.2.3