Swift
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
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
-rw-r--r--Documentation/API/Doxyfile9
-rw-r--r--Documentation/SwiftAPI/Doxyfile8
-rw-r--r--Swift/Controllers/ProfileSettingsProvider.h7
-rw-r--r--Swift/Controllers/Storages/FileStorages.h8
4 files changed, 10 insertions, 22 deletions
diff --git a/Documentation/API/Doxyfile b/Documentation/API/Doxyfile
index dcc6286..84fdaac 100644
--- a/Documentation/API/Doxyfile
+++ b/Documentation/API/Doxyfile
@@ -63,11 +63,10 @@ GENERATE_TESTLIST = YES
63GENERATE_BUGLIST = YES 63GENERATE_BUGLIST = YES
64GENERATE_DEPRECATEDLIST= YES 64GENERATE_DEPRECATEDLIST= YES
65ENABLED_SECTIONS = 65ENABLED_SECTIONS =
66MAX_INITIALIZER_LINES = 30 66MAX_INITIALIZER_LINES = 30
67SHOW_USED_FILES = NO 67SHOW_USED_FILES = NO
68SHOW_DIRECTORIES = NO
69SHOW_FILES = NO 68SHOW_FILES = NO
70SHOW_NAMESPACES = NO 69SHOW_NAMESPACES = NO
71FILE_VERSION_FILTER = 70FILE_VERSION_FILTER =
72#LAYOUT_FILE = 71#LAYOUT_FILE =
73 72
@@ -94,11 +93,10 @@ INPUT = \
94 Swiften/Client/ClientError.h \ 93 Swiften/Client/ClientError.h \
95 Swiften/Client/StanzaChannel.h \ 94 Swiften/Client/StanzaChannel.h \
96 Swiften/Client/NickResolver.h \ 95 Swiften/Client/NickResolver.h \
97 Swiften/Client/Storages.h \ 96 Swiften/Client/Storages.h \
98 Swiften/Client/MemoryStorages.h \ 97 Swiften/Client/MemoryStorages.h \
99 Swiften/Client/FileStorages.h \
100 Swiften/Component/Component.h \ 98 Swiften/Component/Component.h \
101 Swiften/Component/CoreComponent.h \ 99 Swiften/Component/CoreComponent.h \
102 Swiften/Disco \ 100 Swiften/Disco \
103 Swiften/Elements \ 101 Swiften/Elements \
104 Swiften/EventLoop \ 102 Swiften/EventLoop \
@@ -152,11 +150,10 @@ GENERATE_HTML = YES
152HTML_OUTPUT = 150HTML_OUTPUT =
153HTML_FILE_EXTENSION = .html 151HTML_FILE_EXTENSION = .html
154HTML_HEADER = 152HTML_HEADER =
155HTML_FOOTER = 153HTML_FOOTER =
156HTML_STYLESHEET = 154HTML_STYLESHEET =
157HTML_ALIGN_MEMBERS = YES
158HTML_DYNAMIC_SECTIONS = YES 155HTML_DYNAMIC_SECTIONS = YES
159GENERATE_DOCSET = YES 156GENERATE_DOCSET = YES
160DOCSET_FEEDNAME = "Swiften API Documentation" 157DOCSET_FEEDNAME = "Swiften API Documentation"
161DOCSET_BUNDLE_ID = im.swift.Swiften 158DOCSET_BUNDLE_ID = im.swift.Swiften
162GENERATE_HTMLHELP = YES 159GENERATE_HTMLHELP = YES
@@ -171,11 +168,10 @@ TOC_EXPAND = NO
171#QHP_NAMESPACE = im.swift.Swiften 168#QHP_NAMESPACE = im.swift.Swiften
172#QHP_VIRTUAL_FOLDER = doc 169#QHP_VIRTUAL_FOLDER = doc
173#QHG_LOCATION = 170#QHG_LOCATION =
174DISABLE_INDEX = NO 171DISABLE_INDEX = NO
175ENUM_VALUES_PER_LINE = 4 172ENUM_VALUES_PER_LINE = 4
176GENERATE_TREEVIEW = YES
177TREEVIEW_WIDTH = 250 173TREEVIEW_WIDTH = 250
178FORMULA_FONTSIZE = 10 174FORMULA_FONTSIZE = 10
179 175
180#--------------------------------------------------------------------------- 176#---------------------------------------------------------------------------
181# configuration options related to the LaTeX output 177# configuration options related to the LaTeX output
@@ -214,12 +210,10 @@ MAN_LINKS = NO
214#--------------------------------------------------------------------------- 210#---------------------------------------------------------------------------
215# configuration options related to the XML output 211# configuration options related to the XML output
216#--------------------------------------------------------------------------- 212#---------------------------------------------------------------------------
217GENERATE_XML = NO 213GENERATE_XML = NO
218XML_OUTPUT = xml 214XML_OUTPUT = xml
219XML_SCHEMA =
220XML_DTD =
221XML_PROGRAMLISTING = YES 215XML_PROGRAMLISTING = YES
222 216
223#--------------------------------------------------------------------------- 217#---------------------------------------------------------------------------
224# configuration options for the AutoGen Definitions output 218# configuration options for the AutoGen Definitions output
225#--------------------------------------------------------------------------- 219#---------------------------------------------------------------------------
@@ -260,11 +254,10 @@ PERL_PATH = /usr/bin/perl
260#--------------------------------------------------------------------------- 254#---------------------------------------------------------------------------
261CLASS_DIAGRAMS = YES 255CLASS_DIAGRAMS = YES
262MSCGEN_PATH = 256MSCGEN_PATH =
263HIDE_UNDOC_RELATIONS = YES 257HIDE_UNDOC_RELATIONS = YES
264HAVE_DOT = YES 258HAVE_DOT = YES
265DOT_FONTNAME = FreeSans
266DOT_FONTPATH = 259DOT_FONTPATH =
267CLASS_GRAPH = YES 260CLASS_GRAPH = YES
268COLLABORATION_GRAPH = YES 261COLLABORATION_GRAPH = YES
269GROUP_GRAPHS = YES 262GROUP_GRAPHS = YES
270UML_LOOK = NO 263UML_LOOK = NO
@@ -285,6 +278,6 @@ DOT_MULTI_TARGETS = NO
285GENERATE_LEGEND = YES 278GENERATE_LEGEND = YES
286DOT_CLEANUP = YES 279DOT_CLEANUP = YES
287#--------------------------------------------------------------------------- 280#---------------------------------------------------------------------------
288# Configuration::additions related to the search engine 281# Configuration::additions related to the search engine
289#--------------------------------------------------------------------------- 282#---------------------------------------------------------------------------
290SEARCHENGINE = YES 283SEARCHENGINE = NO
diff --git a/Documentation/SwiftAPI/Doxyfile b/Documentation/SwiftAPI/Doxyfile
index a4ada4a..f092c99 100644
--- a/Documentation/SwiftAPI/Doxyfile
+++ b/Documentation/SwiftAPI/Doxyfile
@@ -63,11 +63,10 @@ GENERATE_TESTLIST = YES
63GENERATE_BUGLIST = YES 63GENERATE_BUGLIST = YES
64GENERATE_DEPRECATEDLIST= YES 64GENERATE_DEPRECATEDLIST= YES
65ENABLED_SECTIONS = 65ENABLED_SECTIONS =
66MAX_INITIALIZER_LINES = 30 66MAX_INITIALIZER_LINES = 30
67SHOW_USED_FILES = NO 67SHOW_USED_FILES = NO
68SHOW_DIRECTORIES = NO
69SHOW_FILES = NO 68SHOW_FILES = NO
70SHOW_NAMESPACES = NO 69SHOW_NAMESPACES = NO
71FILE_VERSION_FILTER = 70FILE_VERSION_FILTER =
72#LAYOUT_FILE = 71#LAYOUT_FILE =
73 72
@@ -153,11 +152,10 @@ GENERATE_HTML = YES
153HTML_OUTPUT = 152HTML_OUTPUT =
154HTML_FILE_EXTENSION = .html 153HTML_FILE_EXTENSION = .html
155HTML_HEADER = 154HTML_HEADER =
156HTML_FOOTER = 155HTML_FOOTER =
157HTML_STYLESHEET = 156HTML_STYLESHEET =
158HTML_ALIGN_MEMBERS = YES
159HTML_DYNAMIC_SECTIONS = YES 157HTML_DYNAMIC_SECTIONS = YES
160GENERATE_DOCSET = YES 158GENERATE_DOCSET = YES
161DOCSET_FEEDNAME = "Swift XMPP Client Documentation" 159DOCSET_FEEDNAME = "Swift XMPP Client Documentation"
162DOCSET_BUNDLE_ID = im.swift.Swiften 160DOCSET_BUNDLE_ID = im.swift.Swiften
163GENERATE_HTMLHELP = YES 161GENERATE_HTMLHELP = YES
@@ -172,11 +170,10 @@ TOC_EXPAND = NO
172#QHP_NAMESPACE = im.swift.Swiften 170#QHP_NAMESPACE = im.swift.Swiften
173#QHP_VIRTUAL_FOLDER = doc 171#QHP_VIRTUAL_FOLDER = doc
174#QHG_LOCATION = 172#QHG_LOCATION =
175DISABLE_INDEX = NO 173DISABLE_INDEX = NO
176ENUM_VALUES_PER_LINE = 4 174ENUM_VALUES_PER_LINE = 4
177GENERATE_TREEVIEW = YES
178TREEVIEW_WIDTH = 250 175TREEVIEW_WIDTH = 250
179FORMULA_FONTSIZE = 10 176FORMULA_FONTSIZE = 10
180 177
181#--------------------------------------------------------------------------- 178#---------------------------------------------------------------------------
182# configuration options related to the LaTeX output 179# configuration options related to the LaTeX output
@@ -215,12 +212,10 @@ MAN_LINKS = NO
215#--------------------------------------------------------------------------- 212#---------------------------------------------------------------------------
216# configuration options related to the XML output 213# configuration options related to the XML output
217#--------------------------------------------------------------------------- 214#---------------------------------------------------------------------------
218GENERATE_XML = NO 215GENERATE_XML = NO
219XML_OUTPUT = xml 216XML_OUTPUT = xml
220XML_SCHEMA =
221XML_DTD =
222XML_PROGRAMLISTING = YES 217XML_PROGRAMLISTING = YES
223 218
224#--------------------------------------------------------------------------- 219#---------------------------------------------------------------------------
225# configuration options for the AutoGen Definitions output 220# configuration options for the AutoGen Definitions output
226#--------------------------------------------------------------------------- 221#---------------------------------------------------------------------------
@@ -261,11 +256,10 @@ PERL_PATH = /usr/bin/perl
261#--------------------------------------------------------------------------- 256#---------------------------------------------------------------------------
262CLASS_DIAGRAMS = YES 257CLASS_DIAGRAMS = YES
263MSCGEN_PATH = 258MSCGEN_PATH =
264HIDE_UNDOC_RELATIONS = YES 259HIDE_UNDOC_RELATIONS = YES
265HAVE_DOT = YES 260HAVE_DOT = YES
266DOT_FONTNAME =
267DOT_FONTPATH = 261DOT_FONTPATH =
268CLASS_GRAPH = YES 262CLASS_GRAPH = YES
269COLLABORATION_GRAPH = YES 263COLLABORATION_GRAPH = YES
270GROUP_GRAPHS = YES 264GROUP_GRAPHS = YES
271UML_LOOK = NO 265UML_LOOK = NO
@@ -286,6 +280,6 @@ DOT_MULTI_TARGETS = NO
286GENERATE_LEGEND = YES 280GENERATE_LEGEND = YES
287DOT_CLEANUP = YES 281DOT_CLEANUP = YES
288#--------------------------------------------------------------------------- 282#---------------------------------------------------------------------------
289# Configuration::additions related to the search engine 283# Configuration::additions related to the search engine
290#--------------------------------------------------------------------------- 284#---------------------------------------------------------------------------
291SEARCHENGINE = YES 285SEARCHENGINE = NO
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
12namespace Swift { 13namespace Swift {
13 14
14class ProfileSettingsProvider { 15class 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 */