From b2f5d20005d01eeb19d7e694038035873625ecc3 Mon Sep 17 00:00:00 2001 From: Jeremy Lainé Date: Sat, 6 Mar 2010 14:44:35 +0000 Subject: touchup documentation --- source/QXmppConfiguration.h | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) (limited to 'source/QXmppConfiguration.h') 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 #include +/// \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: -- cgit v1.2.3