diff options
| author | Manjeet Dahiya <manjeetdahiya@gmail.com> | 2010-02-12 04:37:18 +0000 |
|---|---|---|
| committer | Manjeet Dahiya <manjeetdahiya@gmail.com> | 2010-02-12 04:37:18 +0000 |
| commit | 903de5cfd0195333e2c34333567b88af6b8cea68 (patch) | |
| tree | b969d5501846081437e1512b16fbb9a39bc1f7e9 /source/QXmppConfiguration.h | |
| parent | 4f56a0356be963bd6dbc0c44069ebb60aabe26be (diff) | |
| download | qxmpp-903de5cfd0195333e2c34333567b88af6b8cea68.tar.gz | |
documentation updates
Diffstat (limited to 'source/QXmppConfiguration.h')
| -rw-r--r-- | source/QXmppConfiguration.h | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/source/QXmppConfiguration.h b/source/QXmppConfiguration.h index d9ff059c..291af31b 100644 --- a/source/QXmppConfiguration.h +++ b/source/QXmppConfiguration.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2008-2009 Manjeet Dahiya + * Copyright (C) 2008-2010 Manjeet Dahiya * * Author: * Manjeet Dahiya @@ -22,6 +22,16 @@ */ +/// \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 |