summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTobias Markmann <tm@ayena.de>2015-10-27 16:53:17 (GMT)
committerKevin Smith <kevin.smith@isode.com>2015-10-30 12:44:47 (GMT)
commit1d921f3d39ed134ca7f1d40011c1a07a5835b73c (patch)
tree1bd90c302d1641f452ed397f930e92bd736c6b09 /Swift/Controllers
parent0f5ef716a50c8d9761cafda12aacf818cdfd6353 (diff)
downloadswift-1d921f3d39ed134ca7f1d40011c1a07a5835b73c.zip
swift-1d921f3d39ed134ca7f1d40011c1a07a5835b73c.tar.bz2
Fix Doxygen issues
Ran ./scons doc=1 with Doxygen 1.8.10 and fix all mentioned errors. Test-Information: Tested building of documentation on OS X 10.10.1 with Doxygen 1.8.10. Change-Id: I136054f457f9b3ff6b269f5ac32bf435450c017c
Diffstat (limited to 'Swift/Controllers')
-rw-r--r--Swift/Controllers/ProfileSettingsProvider.h7
-rw-r--r--Swift/Controllers/Storages/FileStorages.h8
2 files changed, 8 insertions, 7 deletions
diff --git a/Swift/Controllers/ProfileSettingsProvider.h b/Swift/Controllers/ProfileSettingsProvider.h
index 8bbc635..02e1e81 100644
--- a/Swift/Controllers/ProfileSettingsProvider.h
+++ b/Swift/Controllers/ProfileSettingsProvider.h
@@ -1,14 +1,15 @@
/*
- * Copyright (c) 2010-2012 Isode Limited.
+ * Copyright (c) 2010-2015 Isode Limited.
* All rights reserved.
* See the COPYING file for more information.
*/
#pragma once
-#include <Swift/Controllers/Settings/SettingsProvider.h>
#include <Swiften/Base/foreach.h>
+#include <Swift/Controllers/Settings/SettingsProvider.h>
+
namespace Swift {
class ProfileSettingsProvider {
@@ -19,7 +20,7 @@ class ProfileSettingsProvider {
virtual void storeString(const std::string &settingPath, const std::string &settingValue);
virtual int getIntSetting(const std::string& settingPath, int defaultValue);
virtual void storeInt(const std::string& settingPath, int settingValue);
- /** See @SettingsProvider::getIsSettingFinal for discussion of what this means.*/
+ /** See \ref SettingsProvider::getIsSettingFinal for discussion of what this means.*/
virtual bool getIsSettingFinal(const std::string& settingPath);
private:
diff --git a/Swift/Controllers/Storages/FileStorages.h b/Swift/Controllers/Storages/FileStorages.h
index b498a15..195d0fa 100644
--- a/Swift/Controllers/Storages/FileStorages.h
+++ b/Swift/Controllers/Storages/FileStorages.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2010-2013 Isode Limited.
+ * Copyright (c) 2010-2015 Isode Limited.
* All rights reserved.
* See the COPYING file for more information.
*/
@@ -30,9 +30,9 @@ namespace Swift {
* 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
+ * - 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.