From 1d921f3d39ed134ca7f1d40011c1a07a5835b73c Mon Sep 17 00:00:00 2001
From: Tobias Markmann <tm@ayena.de>
Date: Tue, 27 Oct 2015 17:53:17 +0100
Subject: 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

diff --git a/Documentation/API/Doxyfile b/Documentation/API/Doxyfile
index dcc6286..84fdaac 100644
--- a/Documentation/API/Doxyfile
+++ b/Documentation/API/Doxyfile
@@ -65,7 +65,6 @@ 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    = 
@@ -96,7 +95,6 @@ INPUT                  = \
 	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 \
@@ -154,7 +152,6 @@ 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"
@@ -173,7 +170,6 @@ TOC_EXPAND             = NO
 #QHG_LOCATION           = 
 DISABLE_INDEX          = NO
 ENUM_VALUES_PER_LINE   = 4
-GENERATE_TREEVIEW      = YES
 TREEVIEW_WIDTH         = 250
 FORMULA_FONTSIZE       = 10
 
@@ -216,8 +212,6 @@ MAN_LINKS              = NO
 #---------------------------------------------------------------------------
 GENERATE_XML           = NO
 XML_OUTPUT             = xml
-XML_SCHEMA             = 
-XML_DTD                = 
 XML_PROGRAMLISTING     = YES
 
 #---------------------------------------------------------------------------
@@ -262,7 +256,6 @@ CLASS_DIAGRAMS         = YES
 MSCGEN_PATH            = 
 HIDE_UNDOC_RELATIONS   = YES
 HAVE_DOT               = YES
-DOT_FONTNAME           = FreeSans
 DOT_FONTPATH           = 
 CLASS_GRAPH            = YES
 COLLABORATION_GRAPH    = YES
@@ -287,4 +280,4 @@ 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
@@ -65,7 +65,6 @@ 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    = 
@@ -155,7 +154,6 @@ 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"
@@ -174,7 +172,6 @@ TOC_EXPAND             = NO
 #QHG_LOCATION           = 
 DISABLE_INDEX          = NO
 ENUM_VALUES_PER_LINE   = 4
-GENERATE_TREEVIEW      = YES
 TREEVIEW_WIDTH         = 250
 FORMULA_FONTSIZE       = 10
 
@@ -217,8 +214,6 @@ MAN_LINKS              = NO
 #---------------------------------------------------------------------------
 GENERATE_XML           = NO
 XML_OUTPUT             = xml
-XML_SCHEMA             = 
-XML_DTD                = 
 XML_PROGRAMLISTING     = YES
 
 #---------------------------------------------------------------------------
@@ -263,7 +258,6 @@ CLASS_DIAGRAMS         = YES
 MSCGEN_PATH            = 
 HIDE_UNDOC_RELATIONS   = YES
 HAVE_DOT               = YES
-DOT_FONTNAME           = 
 DOT_FONTPATH           = 
 CLASS_GRAPH            = YES
 COLLABORATION_GRAPH    = YES
@@ -288,4 +282,4 @@ 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,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. 
-- 
cgit v0.10.2-6-g49f6