Swiftdiff options
| author | Tobias Markmann <tm@ayena.de> | 2015-10-27 16:53:17 (GMT) |
|---|---|---|
| committer | Kevin Smith <kevin.smith@isode.com> | 2015-10-30 12:44:47 (GMT) |
| commit | 1d921f3d39ed134ca7f1d40011c1a07a5835b73c (patch) | |
| tree | 1bd90c302d1641f452ed397f930e92bd736c6b09 /Swift/Controllers | |
| parent | 0f5ef716a50c8d9761cafda12aacf818cdfd6353 (diff) | |
| download | swift-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.h | 7 | ||||
| -rw-r--r-- | Swift/Controllers/Storages/FileStorages.h | 8 |
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,27 +1,28 @@ | |||
| 1 | /* | 1 | /* |
| 2 | * Copyright (c) 2010-2012 Isode Limited. | 2 | * Copyright (c) 2010-2015 Isode Limited. |
| 3 | * All rights reserved. | 3 | * All rights reserved. |
| 4 | * See the COPYING file for more information. | 4 | * See the COPYING file for more information. |
| 5 | */ | 5 | */ |
| 6 | 6 | ||
| 7 | #pragma once | 7 | #pragma once |
| 8 | 8 | ||
| 9 | #include <Swift/Controllers/Settings/SettingsProvider.h> | ||
| 10 | #include <Swiften/Base/foreach.h> | 9 | #include <Swiften/Base/foreach.h> |
| 11 | 10 | ||
| 11 | #include <Swift/Controllers/Settings/SettingsProvider.h> | ||
| 12 | |||
| 12 | namespace Swift { | 13 | namespace Swift { |
| 13 | 14 | ||
| 14 | class ProfileSettingsProvider { | 15 | class ProfileSettingsProvider { |
| 15 | public: | 16 | public: |
| 16 | ProfileSettingsProvider(const std::string& profile, SettingsProvider* provider); | 17 | ProfileSettingsProvider(const std::string& profile, SettingsProvider* provider); |
| 17 | virtual ~ProfileSettingsProvider(); | 18 | virtual ~ProfileSettingsProvider(); |
| 18 | virtual std::string getStringSetting(const std::string &settingPath); | 19 | virtual std::string getStringSetting(const std::string &settingPath); |
| 19 | virtual void storeString(const std::string &settingPath, const std::string &settingValue); | 20 | virtual void storeString(const std::string &settingPath, const std::string &settingValue); |
| 20 | virtual int getIntSetting(const std::string& settingPath, int defaultValue); | 21 | virtual int getIntSetting(const std::string& settingPath, int defaultValue); |
| 21 | virtual void storeInt(const std::string& settingPath, int settingValue); | 22 | virtual void storeInt(const std::string& settingPath, int settingValue); |
| 22 | /** See @SettingsProvider::getIsSettingFinal for discussion of what this means.*/ | 23 | /** See \ref SettingsProvider::getIsSettingFinal for discussion of what this means.*/ |
| 23 | virtual bool getIsSettingFinal(const std::string& settingPath); | 24 | virtual bool getIsSettingFinal(const std::string& settingPath); |
| 24 | 25 | ||
| 25 | private: | 26 | private: |
| 26 | std::string profileSettingPath(const std::string &settingPath); | 27 | std::string profileSettingPath(const std::string &settingPath); |
| 27 | SettingsProvider* provider_; | 28 | SettingsProvider* provider_; |
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,7 +1,7 @@ | |||
| 1 | /* | 1 | /* |
| 2 | * Copyright (c) 2010-2013 Isode Limited. | 2 | * Copyright (c) 2010-2015 Isode Limited. |
| 3 | * All rights reserved. | 3 | * All rights reserved. |
| 4 | * See the COPYING file for more information. | 4 | * See the COPYING file for more information. |
| 5 | */ | 5 | */ |
| 6 | 6 | ||
| 7 | #pragma once | 7 | #pragma once |
| @@ -28,13 +28,13 @@ namespace Swift { | |||
| 28 | * Creates the storages interface. | 28 | * Creates the storages interface. |
| 29 | * | 29 | * |
| 30 | * All data will be stored relative to a base directory, and | 30 | * All data will be stored relative to a base directory, and |
| 31 | * for some controllers, in a subdirectory for the given profile. | 31 | * for some controllers, in a subdirectory for the given profile. |
| 32 | * The data is stored in the following places: | 32 | * The data is stored in the following places: |
| 33 | * - Avatars: <basedir>/avatars | 33 | * - Avatars: $basedir/avatars |
| 34 | * - VCards: <basedir>/<profile>/vcards | 34 | * - VCards: $basedir/$profile/vcards |
| 35 | * - Entity capabilities: <basedir>/caps | 35 | * - Entity capabilities: $basedir/caps |
| 36 | * | 36 | * |
| 37 | * \param baseDir the base dir to store data relative to | 37 | * \param baseDir the base dir to store data relative to |
| 38 | * \param jid the subdir in which profile-specific data will be stored. | 38 | * \param jid the subdir in which profile-specific data will be stored. |
| 39 | * The bare JID will be used as the subdir name. | 39 | * The bare JID will be used as the subdir name. |
| 40 | */ | 40 | */ |