diff options
| author | Jeremy Lainé <jeremy.laine@m4x.org> | 2010-12-10 10:17:53 +0000 |
|---|---|---|
| committer | Jeremy Lainé <jeremy.laine@m4x.org> | 2010-12-10 10:17:53 +0000 |
| commit | 0bd87948e195ac7f220fd9864fb6a99abeeb0d80 (patch) | |
| tree | 690395d3e8b4834650d8fa4979f3a9cc670aae6d /src | |
| parent | 2f3f64ea9b1bc8156d57c3172588ec014863fdda (diff) | |
| download | qxmpp-0bd87948e195ac7f220fd9864fb6a99abeeb0d80.tar.gz | |
improve documentation
Diffstat (limited to 'src')
| -rw-r--r-- | src/QXmppPubSubIq.h | 3 | ||||
| -rw-r--r-- | src/QXmppRosterIq.cpp | 6 | ||||
| -rw-r--r-- | src/QXmppRosterIq.h | 2 |
3 files changed, 10 insertions, 1 deletions
diff --git a/src/QXmppPubSubIq.h b/src/QXmppPubSubIq.h index e42bf711..2ce6b2fb 100644 --- a/src/QXmppPubSubIq.h +++ b/src/QXmppPubSubIq.h @@ -57,6 +57,7 @@ private: class QXmppPubSubIq : public QXmppIq { public: + /// This enum is used to describe a publish-subscribe query type. enum QueryType { AffiliationsQuery, @@ -85,7 +86,9 @@ public: QString subscriptionId() const; void setSubscriptionId(const QString &id); + /// \cond static bool isPubSubIq(const QDomElement &element); + /// \endcond protected: /// \cond diff --git a/src/QXmppRosterIq.cpp b/src/QXmppRosterIq.cpp index b9961b9b..d8872696 100644 --- a/src/QXmppRosterIq.cpp +++ b/src/QXmppRosterIq.cpp @@ -29,11 +29,17 @@ #include "QXmppConstants.h" #include "QXmppUtils.h" +/// Adds an item to the roster IQ. +/// +/// \param item + void QXmppRosterIq::addItem(const Item& item) { m_items.append(item); } +/// Returns the roster IQ's items. + QList<QXmppRosterIq::Item> QXmppRosterIq::items() const { return m_items; diff --git a/src/QXmppRosterIq.h b/src/QXmppRosterIq.h index b50c860b..bb8caf72 100644 --- a/src/QXmppRosterIq.h +++ b/src/QXmppRosterIq.h @@ -98,11 +98,11 @@ public: void addItem(const Item&); QList<Item> items() const; + /// \cond static bool isRosterIq(const QDomElement &element); // deprecated in release 0.2.0 // deprecated accessors, use the form without "get" instead - /// \cond QList<Item> Q_DECL_DEPRECATED getItems() const; /// \endcond |