diff options
| author | Jeremy Lainé <jeremy.laine@m4x.org> | 2010-07-18 12:06:08 +0000 |
|---|---|---|
| committer | Jeremy Lainé <jeremy.laine@m4x.org> | 2010-07-18 12:06:08 +0000 |
| commit | 9c08abcff13bb568aa0825b67ac0cdf66b756798 (patch) | |
| tree | 22525f62e30cd59a2ee7c0736ba88030349cbfff /source/QXmppPresence.h | |
| parent | d410cf9b263816d6951f9393476216710354f51d (diff) | |
| download | qxmpp-9c08abcff13bb568aa0825b67ac0cdf66b756798.tar.gz | |
improve code documentation
Diffstat (limited to 'source/QXmppPresence.h')
| -rw-r--r-- | source/QXmppPresence.h | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/source/QXmppPresence.h b/source/QXmppPresence.h index 17c804a7..dce46413 100644 --- a/source/QXmppPresence.h +++ b/source/QXmppPresence.h @@ -27,6 +27,9 @@ #include "QXmppStanza.h" +/// \brief The QXmppPresence class represents an XMPP presence stanza. +/// +/// \ingroup Stanzas class QXmppPresence : public QXmppStanza { public: @@ -71,12 +74,12 @@ public: void parse(const QDomElement &element); void toXml(QXmlStreamWriter *writer) const; -// deprecated accessors, use the form without "get" instead -// obsolete start + // deprecated accessors, use the form without "get" instead + /// \cond int Q_DECL_DEPRECATED getPriority() const; QString Q_DECL_DEPRECATED getStatusText() const; QXmppPresence::Status::Type Q_DECL_DEPRECATED getType() const; -// obsolete end + /// \endcond private: QString getTypeStr() const; @@ -101,12 +104,12 @@ public: void parse(const QDomElement &element); void toXml(QXmlStreamWriter *writer) const; -// deprecated accessors, use the form without "get" instead -// obsolete start + // deprecated accessors, use the form without "get" instead + /// \cond QXmppPresence::Type Q_DECL_DEPRECATED getType() const; QXmppPresence::Status Q_DECL_DEPRECATED & getStatus(); const QXmppPresence::Status Q_DECL_DEPRECATED & getStatus() const; -// obsolete end + /// \endcond private: QString getTypeStr() const; |