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 | |
| 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
| -rw-r--r-- | Documentation/API/Doxyfile | 9 | ||||
| -rw-r--r-- | Documentation/SwiftAPI/Doxyfile | 8 | ||||
| -rw-r--r-- | Swift/Controllers/ProfileSettingsProvider.h | 7 | ||||
| -rw-r--r-- | Swift/Controllers/Storages/FileStorages.h | 8 |
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 @@ -59,19 +59,18 @@ SORT_BRIEF_DOCS = NO SORT_GROUP_NAMES = NO SORT_BY_SCOPE_NAME = NO GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES GENERATE_DEPRECATEDLIST= YES ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = NO -SHOW_DIRECTORIES = NO SHOW_FILES = NO SHOW_NAMESPACES = NO FILE_VERSION_FILTER = #LAYOUT_FILE = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- QUIET = YES @@ -90,19 +89,18 @@ INPUT = \ Swiften/Base \ Swiften/Chat \ Swiften/Client/Client.h \ Swiften/Client/CoreClient.h \ Swiften/Client/ClientError.h \ Swiften/Client/StanzaChannel.h \ Swiften/Client/NickResolver.h \ Swiften/Client/Storages.h \ Swiften/Client/MemoryStorages.h \ - Swiften/Client/FileStorages.h \ Swiften/Component/Component.h \ Swiften/Component/CoreComponent.h \ Swiften/Disco \ Swiften/Elements \ Swiften/EventLoop \ Swiften/JID \ Swiften/MUC \ Swiften/Presence \ Swiften/Queries \ @@ -148,38 +146,36 @@ IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- GENERATE_HTML = YES HTML_OUTPUT = HTML_FILE_EXTENSION = .html HTML_HEADER = HTML_FOOTER = HTML_STYLESHEET = -HTML_ALIGN_MEMBERS = YES HTML_DYNAMIC_SECTIONS = YES GENERATE_DOCSET = YES DOCSET_FEEDNAME = "Swiften API Documentation" DOCSET_BUNDLE_ID = im.swift.Swiften GENERATE_HTMLHELP = YES CHM_FILE = HHC_LOCATION = GENERATE_CHI = NO CHM_INDEX_ENCODING = BINARY_TOC = NO TOC_EXPAND = NO #GENERATE_QHP = NO #QCH_FILE = #QHP_NAMESPACE = im.swift.Swiften #QHP_VIRTUAL_FOLDER = doc #QHG_LOCATION = DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 4 -GENERATE_TREEVIEW = YES TREEVIEW_WIDTH = 250 FORMULA_FONTSIZE = 10 #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- GENERATE_LATEX = NO LATEX_OUTPUT = LATEX_CMD_NAME = latex @@ -210,20 +206,18 @@ GENERATE_MAN = NO MAN_OUTPUT = MAN_EXTENSION = .3 MAN_LINKS = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- GENERATE_XML = NO XML_OUTPUT = xml -XML_SCHEMA = -XML_DTD = XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- # configuration options related to the Perl module output @@ -256,19 +250,18 @@ EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- CLASS_DIAGRAMS = YES MSCGEN_PATH = HIDE_UNDOC_RELATIONS = YES HAVE_DOT = YES -DOT_FONTNAME = FreeSans DOT_FONTPATH = CLASS_GRAPH = YES COLLABORATION_GRAPH = YES GROUP_GRAPHS = YES UML_LOOK = NO TEMPLATE_RELATIONS = YES INCLUDE_GRAPH = NO INCLUDED_BY_GRAPH = NO CALL_GRAPH = NO @@ -281,10 +274,10 @@ DOTFILE_DIRS = DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 DOT_TRANSPARENT = NO DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES DOT_CLEANUP = YES #--------------------------------------------------------------------------- # Configuration::additions related to the search engine #--------------------------------------------------------------------------- -SEARCHENGINE = YES +SEARCHENGINE = NO diff --git a/Documentation/SwiftAPI/Doxyfile b/Documentation/SwiftAPI/Doxyfile index a4ada4a..f092c99 100644 --- a/Documentation/SwiftAPI/Doxyfile +++ b/Documentation/SwiftAPI/Doxyfile @@ -59,19 +59,18 @@ SORT_BRIEF_DOCS = NO SORT_GROUP_NAMES = NO SORT_BY_SCOPE_NAME = NO GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES GENERATE_DEPRECATEDLIST= YES ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = NO -SHOW_DIRECTORIES = NO SHOW_FILES = NO SHOW_NAMESPACES = NO FILE_VERSION_FILTER = #LAYOUT_FILE = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- QUIET = YES @@ -149,38 +148,36 @@ IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- GENERATE_HTML = YES HTML_OUTPUT = HTML_FILE_EXTENSION = .html HTML_HEADER = HTML_FOOTER = HTML_STYLESHEET = -HTML_ALIGN_MEMBERS = YES HTML_DYNAMIC_SECTIONS = YES GENERATE_DOCSET = YES DOCSET_FEEDNAME = "Swift XMPP Client Documentation" DOCSET_BUNDLE_ID = im.swift.Swiften GENERATE_HTMLHELP = YES CHM_FILE = HHC_LOCATION = GENERATE_CHI = NO CHM_INDEX_ENCODING = BINARY_TOC = NO TOC_EXPAND = NO #GENERATE_QHP = NO #QCH_FILE = #QHP_NAMESPACE = im.swift.Swiften #QHP_VIRTUAL_FOLDER = doc #QHG_LOCATION = DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 4 -GENERATE_TREEVIEW = YES TREEVIEW_WIDTH = 250 FORMULA_FONTSIZE = 10 #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- GENERATE_LATEX = NO LATEX_OUTPUT = LATEX_CMD_NAME = latex @@ -211,20 +208,18 @@ GENERATE_MAN = NO MAN_OUTPUT = MAN_EXTENSION = .3 MAN_LINKS = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- GENERATE_XML = NO XML_OUTPUT = xml -XML_SCHEMA = -XML_DTD = XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- # configuration options related to the Perl module output @@ -257,19 +252,18 @@ EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- CLASS_DIAGRAMS = YES MSCGEN_PATH = HIDE_UNDOC_RELATIONS = YES HAVE_DOT = YES -DOT_FONTNAME = DOT_FONTPATH = CLASS_GRAPH = YES COLLABORATION_GRAPH = YES GROUP_GRAPHS = YES UML_LOOK = NO TEMPLATE_RELATIONS = YES INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES CALL_GRAPH = YES @@ -282,10 +276,10 @@ DOTFILE_DIRS = DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 DOT_TRANSPARENT = NO DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES DOT_CLEANUP = YES #--------------------------------------------------------------------------- # Configuration::additions related to the search engine #--------------------------------------------------------------------------- -SEARCHENGINE = YES +SEARCHENGINE = 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,31 +1,32 @@ /* - * 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 { public: ProfileSettingsProvider(const std::string& profile, SettingsProvider* provider); virtual ~ProfileSettingsProvider(); virtual std::string getStringSetting(const std::string &settingPath); 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: std::string profileSettingPath(const std::string &settingPath); SettingsProvider* provider_; std::string profile_; }; } 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,11 +1,11 @@ /* - * Copyright (c) 2010-2013 Isode Limited. + * Copyright (c) 2010-2015 Isode Limited. * All rights reserved. * See the COPYING file for more information. */ #pragma once #include <boost/filesystem/path.hpp> #include <Swiften/Client/Storages.h> @@ -24,21 +24,21 @@ namespace Swift { */ 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 + * - 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, CryptoProvider*); ~FileStorages(); virtual VCardStorage* getVCardStorage() const; |