aboutsummaryrefslogtreecommitdiff
path: root/source/QXmppConfiguration.h
diff options
context:
space:
mode:
authorJeremy Lainé <jeremy.laine@m4x.org>2010-03-06 14:44:35 +0000
committerJeremy Lainé <jeremy.laine@m4x.org>2010-03-06 14:44:35 +0000
commitb2f5d20005d01eeb19d7e694038035873625ecc3 (patch)
treef6aea608a985ec37288edc38212c0570a60bf2e9 /source/QXmppConfiguration.h
parentac1831936f7858d7f2197ef11dff226ce08d5bb1 (diff)
downloadqxmpp-b2f5d20005d01eeb19d7e694038035873625ecc3.tar.gz
touchup documentation
Diffstat (limited to 'source/QXmppConfiguration.h')
-rw-r--r--source/QXmppConfiguration.h21
1 files changed, 11 insertions, 10 deletions
diff --git a/source/QXmppConfiguration.h b/source/QXmppConfiguration.h
index dec55822..ba9e37e2 100644
--- a/source/QXmppConfiguration.h
+++ b/source/QXmppConfiguration.h
@@ -22,22 +22,23 @@
*/
-/// \class QXmppConfiguration
-///
-/// \brief The QXmppConfiguration is a configuration class. Its object can be passed
-/// to the QXmppClient for connecting the an XMPP server.
-///
-/// It is a container of all the settings, configuration required for connecting to
-/// an XMPP server. E.g. server name, username, port, type of authentication mechanism,
-/// type of security used by stream (encryption) etc.
-///
-
#ifndef QXMPPCONFIGURATION_H
#define QXMPPCONFIGURATION_H
#include <QString>
#include <QNetworkProxy>
+/// \brief The QXmppConfiguration class holds configuration options.
+///
+/// It can be passed to QXmppClient to specify the options when connecting to
+/// an XMPP server.
+///
+/// It is a container of all the settings, configuration required for
+/// connecting to an XMPP server. E.g. server name, username, port, type
+/// of authentication mechanism, type of security used by stream (encryption),
+/// etc..
+///
+
class QXmppConfiguration
{
public: