aboutsummaryrefslogtreecommitdiff
path: root/source/QXmppConfiguration.h
diff options
context:
space:
mode:
Diffstat (limited to 'source/QXmppConfiguration.h')
-rw-r--r--source/QXmppConfiguration.h12
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