summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'Swiften/Client/FileStorages.h')
-rw-r--r--Swiften/Client/FileStorages.h17
1 files changed, 17 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();