Swiftdiff options
| author | Remko Tronçon <git@el-tramo.be> | 2010-10-25 19:21:10 (GMT) |
|---|---|---|
| committer | Remko Tronçon <git@el-tramo.be> | 2010-10-25 19:35:08 (GMT) |
| commit | 09ea1261f5da1fb63307e67d994bee617c09a481 (patch) | |
| tree | 5a489d8cde5b74c2c0a6290d35b6c4523129f174 /Swiften/Client/Client.h | |
| parent | 96c5a881b2768057f8189030b543fefa2835e782 (diff) | |
| download | swift-contrib-09ea1261f5da1fb63307e67d994bee617c09a481.zip swift-contrib-09ea1261f5da1fb63307e67d994bee617c09a481.tar.bz2 | |
Updated doxygen.
Diffstat (limited to 'Swiften/Client/Client.h')
| -rw-r--r-- | Swiften/Client/Client.h | 26 |
1 files changed, 16 insertions, 10 deletions
diff --git a/Swiften/Client/Client.h b/Swiften/Client/Client.h index eb3fc09..47a276a 100644 --- a/Swiften/Client/Client.h +++ b/Swiften/Client/Client.h @@ -29,12 +29,16 @@ namespace Swift { * * Besides connecting to an XMPP server, this class also provides interfaces for * performing most tasks on the XMPP network. - * - * \param storages The interfaces for storing cache information etc. If this is NULL, - * all data will be stored in memory (and be lost on shutdown) */ class Client : public CoreClient { public: + /** + * Constructs a client for the given JID with the given password. + * + * \param storages The interfaces for storing cache information etc. If + * this is NULL, + * all data will be stored in memory (and be lost on shutdown) + */ Client(const JID& jid, const String& password, Storages* storages = NULL); ~Client(); @@ -46,16 +50,18 @@ namespace Swift { */ void setSoftwareVersion(const String& name, const String& version); - /** + /** * Returns a representation of the roster. * - * The roster is initially empty. To populate it, call requestRoster(), which - * will request the roster from the server. When the roster has been requested, - * it will also be kept up to date when it is updated on the server side. + * The roster is initially empty. To populate it, call requestRoster(), + * which will request the roster from the server. When the roster has + * been requested, it will also be kept up to date when it is updated on + * the server side. * - * This pointer remains the same across the lifetime of Client. All changes - * to the roster (e.g. after the initial roster request, or after subsequent - * roster updates) are notified through the XMPPRoster's signals. + * This pointer remains the same across the lifetime of Client. All + * changes to the roster (e.g. after the initial roster request, or after + * subsequent roster updates) are notified through the XMPPRoster's + * signals. * * \see requestRoster() */ |