aboutsummaryrefslogtreecommitdiff
path: root/src/QXmppDialback.h
diff options
context:
space:
mode:
authorJeremy Lainé <jeremy.laine@m4x.org>2010-12-10 10:03:42 +0000
committerJeremy Lainé <jeremy.laine@m4x.org>2010-12-10 10:03:42 +0000
commitd083da28479cfd39f77ab37d8ec4260afd19c7fb (patch)
tree929500dd35f7f7fa16c05c4b7e17f19ffaceb062 /src/QXmppDialback.h
parent11e2742230c8fcb5f642b45ca5d5e050d61382ad (diff)
downloadqxmpp-d083da28479cfd39f77ab37d8ec4260afd19c7fb.tar.gz
improve documentation
Diffstat (limited to 'src/QXmppDialback.h')
-rw-r--r--src/QXmppDialback.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/src/QXmppDialback.h b/src/QXmppDialback.h
index 183c3913..8fb0bde6 100644
--- a/src/QXmppDialback.h
+++ b/src/QXmppDialback.h
@@ -34,9 +34,12 @@
class QXmppDialback : public QXmppStanza
{
public:
+ /// This enum is used to describe a dialback command.
enum Command {
- Result,
- Verify,
+ Result, ///< A dialback command between the originating server
+ ///< and the receiving server.
+ Verify, ///< A dialback command between the receiving server
+ ///< and the authoritative server.
};
QXmppDialback();
@@ -53,9 +56,9 @@ public:
/// \cond
void parse(const QDomElement &element);
void toXml(QXmlStreamWriter *writer) const;
- /// \endcond
static bool isDialback(const QDomElement &element);
+ /// \endcond
private:
Command m_command;