Swiftdiff options
| author | Remko Tronçon <git@el-tramo.be> | 2010-10-25 19:51:38 (GMT) |
|---|---|---|
| committer | Remko Tronçon <git@el-tramo.be> | 2010-10-25 19:51:38 (GMT) |
| commit | 81b22e10e305c9a356a26d8ea087de04a66e75fb (patch) | |
| tree | c7b470dce1bdb75540b075c3c336a8c6894ab791 /Swiften/Client | |
| parent | 09ea1261f5da1fb63307e67d994bee617c09a481 (diff) | |
| download | swift-contrib-81b22e10e305c9a356a26d8ea087de04a66e75fb.zip swift-contrib-81b22e10e305c9a356a26d8ea087de04a66e75fb.tar.bz2 | |
More documentation.
Diffstat (limited to 'Swiften/Client')
| -rw-r--r-- | Swiften/Client/FileStorages.h | 17 | ||||
| -rw-r--r-- | Swiften/Client/MemoryStorages.h | 4 | ||||
| -rw-r--r-- | Swiften/Client/Storages.h | 4 |
3 files changed, 25 insertions, 0 deletions
diff --git a/Swiften/Client/FileStorages.h b/Swiften/Client/FileStorages.h index f8c3162..451105f 100644 --- a/Swiften/Client/FileStorages.h +++ b/Swiften/Client/FileStorages.h @@ -16,8 +16,25 @@ namespace Swift { class CapsFileStorage; class JID; + /** + * A storages implementation that stores all controller data on disk. + */ class FileStorages : public Storages { public: + /** + * Creates the storages interface. + * + * All data will be stored relative to a base directory, and + * for some controllers, in a subdirectory for the given profile. + * The data is stored in the following places: + * - Avatars: <basedir>/avatars + * - VCards: <basedir>/<profile>/vcards + * - Entity capabilities: <basedir>/caps + * + * \param baseDir the base dir to store data relative to + * \param jid the subdir in which profile-specific data will be stored. + * The bare JID will be used as the subdir name. + */ FileStorages(const boost::filesystem::path& baseDir, const JID& jid); ~FileStorages(); diff --git a/Swiften/Client/MemoryStorages.h b/Swiften/Client/MemoryStorages.h index 13f41d1..67025cd 100644 --- a/Swiften/Client/MemoryStorages.h +++ b/Swiften/Client/MemoryStorages.h @@ -11,6 +11,10 @@ namespace Swift { class VCardMemoryStorage; + /** + * An implementation of Storages for storing all + * controller data in memory. + */ class MemoryStorages : public Storages { public: MemoryStorages(); diff --git a/Swiften/Client/Storages.h b/Swiften/Client/Storages.h index 6f286ca..e62f0a9 100644 --- a/Swiften/Client/Storages.h +++ b/Swiften/Client/Storages.h @@ -11,6 +11,10 @@ namespace Swift { class AvatarStorage; class CapsStorage; + /** + * An interface to hold storage classes for different + * controllers. + */ class Storages { public: virtual ~Storages() {} |