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/QXmppMessage.h | |
| parent | d410cf9b263816d6951f9393476216710354f51d (diff) | |
| download | qxmpp-9c08abcff13bb568aa0825b67ac0cdf66b756798.tar.gz | |
improve code documentation
Diffstat (limited to 'source/QXmppMessage.h')
| -rw-r--r-- | source/QXmppMessage.h | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/source/QXmppMessage.h b/source/QXmppMessage.h index 08751821..60bbad60 100644 --- a/source/QXmppMessage.h +++ b/source/QXmppMessage.h @@ -28,6 +28,11 @@ #include <QDateTime> #include "QXmppStanza.h" +/// \brief The QXmppMessage class represents an XMPP message. +/// +/// \ingroup Stanzas +/// + class QXmppMessage : public QXmppStanza { public: @@ -85,11 +90,13 @@ public: void toXml(QXmlStreamWriter *writer) const; // deprecated accessors, use the form without "get" instead + /// \cond QXmppMessage::Type Q_DECL_DEPRECATED getType() const; QXmppMessage::State Q_DECL_DEPRECATED getState() const; QString Q_DECL_DEPRECATED getBody() const; QString Q_DECL_DEPRECATED getSubject() const; QString Q_DECL_DEPRECATED getThread() const; + /// \endcond private: QString getTypeStr() const; |