From a495abf8ea86c57fc3e1c1c1450c76936fff8404 Mon Sep 17 00:00:00 2001
From: Tobias Markmann <tm@ayena.de>
Date: Wed, 27 Jul 2016 16:56:23 +0200
Subject: Fix Doxygen warnings
This fixes Doxygen warnings about missing parameter
documentation or documentation of non-existing parameters.
Test-Information:
Ran ./scons doc=1 without warnings with Doxygen 1.8.11.
Change-Id: I360d042e5c80f418e7574a26fa1283a82fc504d4
diff --git a/Swift/Controllers/UIInterfaces/ChatWindow.h b/Swift/Controllers/UIInterfaces/ChatWindow.h
index 3aa1c7e..8ee083d 100644
--- a/Swift/Controllers/UIInterfaces/ChatWindow.h
+++ b/Swift/Controllers/UIInterfaces/ChatWindow.h
@@ -199,7 +199,6 @@ namespace Swift {
/**
* Set an alert on the window.
* @param alertText Description of alert (required).
- * @param buttonText Button text to use (optional, no button is shown if empty).
* @return A handle to the alert message.
*/
virtual AlertID addAlert(const std::string& alertText) = 0;
diff --git a/Swiften/Client/Client.cpp b/Swiften/Client/Client.cpp
index 48576d4..8642a4e 100644
--- a/Swiften/Client/Client.cpp
+++ b/Swiften/Client/Client.cpp
@@ -6,32 +6,34 @@
#include <Swiften/Client/Client.h>
-#include <Swiften/Queries/Responders/SoftwareVersionResponder.h>
-#include <Swiften/Roster/XMPPRosterImpl.h>
-#include <Swiften/Roster/XMPPRosterController.h>
-#include <Swiften/Presence/PresenceOracle.h>
-#include <Swiften/Presence/StanzaChannelPresenceSender.h>
-#include <Swiften/Presence/DirectedPresenceSender.h>
-#include <Swiften/MUC/MUCRegistry.h>
-#include <Swiften/MUC/MUCManager.h>
-#include <Swiften/PubSub/PubSubManagerImpl.h>
-#include <Swiften/Client/MemoryStorages.h>
-#include <Swiften/VCards/VCardManager.h>
-#include <Swiften/VCards/VCardManager.h>
#include <Swiften/Avatars/AvatarManagerImpl.h>
+#include <Swiften/Base/SafeString.h>
+#include <Swiften/Client/ClientBlockListManager.h>
+#include <Swiften/Client/ClientSession.h>
+#include <Swiften/Client/MemoryStorages.h>
+#include <Swiften/Client/NickManagerImpl.h>
+#include <Swiften/Client/NickResolver.h>
#include <Swiften/Disco/CapsManager.h>
-#include <Swiften/Disco/EntityCapsManager.h>
#include <Swiften/Disco/ClientDiscoManager.h>
-#include <Swiften/Client/NickResolver.h>
-#include <Swiften/Presence/SubscriptionManager.h>
-#include <Swiften/TLS/BlindCertificateTrustChecker.h>
-#include <Swiften/Client/NickManagerImpl.h>
-#include <Swiften/Client/ClientSession.h>
+#include <Swiften/Disco/EntityCapsManager.h>
+#include <Swiften/FileTransfer/FileTransferManagerImpl.h>
#include <Swiften/Jingle/JingleSessionManager.h>
+#include <Swiften/MUC/MUCManager.h>
+#include <Swiften/MUC/MUCRegistry.h>
#include <Swiften/Network/NetworkFactories.h>
-#include <Swiften/FileTransfer/FileTransferManagerImpl.h>
+#include <Swiften/Presence/DirectedPresenceSender.h>
+#include <Swiften/Presence/PresenceOracle.h>
+#include <Swiften/Presence/StanzaChannelPresenceSender.h>
+#include <Swiften/Presence/SubscriptionManager.h>
+#include <Swiften/PubSub/PubSubManagerImpl.h>
+#include <Swiften/Queries/Responders/SoftwareVersionResponder.h>
+#include <Swiften/Roster/XMPPRosterController.h>
+#include <Swiften/Roster/XMPPRosterImpl.h>
+#include <Swiften/TLS/BlindCertificateTrustChecker.h>
+#include <Swiften/VCards/VCardManager.h>
+#include <Swiften/VCards/VCardManager.h>
#include <Swiften/Whiteboard/WhiteboardSessionManager.h>
-#include <Swiften/Client/ClientBlockListManager.h>
+
#ifndef SWIFT_EXPERIMENTAL_FT
#include <Swiften/FileTransfer/UnitTest/DummyFileTransferManager.h>
#endif
diff --git a/Swiften/Client/Client.h b/Swiften/Client/Client.h
index af7da5d..5b11688 100644
--- a/Swiften/Client/Client.h
+++ b/Swiften/Client/Client.h
@@ -7,38 +7,38 @@
#pragma once
#include <Swiften/Base/API.h>
-#include <Swiften/Base/SafeString.h>
#include <Swiften/Client/CoreClient.h>
namespace Swift {
- class SoftwareVersionResponder;
+ class AvatarManager;
class BlindCertificateTrustChecker;
- class XMPPRoster;
- class XMPPRosterImpl;
+ class CapsManager;
+ class ClientBlockListManager;
+ class ClientDiscoManager;
+ class DirectedPresenceSender;
+ class EntityCapsManager;
+ class EntityCapsProvider;
+ class FileTransferManager;
+ class FileTransferManager;
+ class JingleSessionManager;
class MUCManager;
- class XMPPRosterController;
+ class MUCRegistry;
+ class MemoryStorages;
+ class NickManager;
+ class NickResolver;
class PresenceOracle;
class PresenceSender;
- class DirectedPresenceSender;
+ class PubSubManager;
+ class SafeString;
+ class SoftwareVersionResponder;
class StanzaChannelPresenceSender;
- class MUCRegistry;
class Storages;
- class MemoryStorages;
- class VCardManager;
- class AvatarManager;
- class CapsManager;
- class EntityCapsManager;
- class EntityCapsProvider;
- class NickResolver;
class SubscriptionManager;
- class ClientDiscoManager;
- class NickManager;
- class FileTransferManager;
- class JingleSessionManager;
- class FileTransferManager;
+ class VCardManager;
class WhiteboardSessionManager;
- class ClientBlockListManager;
- class PubSubManager;
+ class XMPPRoster;
+ class XMPPRosterController;
+ class XMPPRosterImpl;
/**
* Provides the core functionality for writing XMPP client software.
@@ -51,6 +51,11 @@ namespace Swift {
/**
* Constructs a client for the given JID with the given password.
*
+ * \param jid The JID to be used for the login. If only a bare
+ * JID is give the server will be asked to generate a resource.
+ * \param password The password used for login given as a \ref SafeString.
+ * \param networkFactories The network factories that are used
+ * to handle any network related tasks.
* \param storages The interfaces for storing cache information etc. If
* this is NULL,
* all data will be stored in memory (and be lost on shutdown)
diff --git a/Swiften/Disco/ClientDiscoManager.h b/Swiften/Disco/ClientDiscoManager.h
index fe68dd7..595beeb 100644
--- a/Swiften/Disco/ClientDiscoManager.h
+++ b/Swiften/Disco/ClientDiscoManager.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2010-2013 Isode Limited.
+ * Copyright (c) 2010-2016 Isode Limited.
* All rights reserved.
* See the COPYING file for more information.
*/
@@ -36,6 +36,7 @@ namespace Swift {
* \param iqRouter the router on which requests will be answered
* \param presenceSender the presence sender to which all outgoing presence
* (with caps information) will be sent.
+ * \param crypto the crypto provider used for cryptographic hash computations.
*/
ClientDiscoManager(IQRouter* iqRouter, PresenceSender* presenceSender, CryptoProvider* crypto);
~ClientDiscoManager();
diff --git a/Swiften/EventLoop/EventLoop.h b/Swiften/EventLoop/EventLoop.h
index 282de15..06b9fbb 100644
--- a/Swiften/EventLoop/EventLoop.h
+++ b/Swiften/EventLoop/EventLoop.h
@@ -30,13 +30,13 @@ namespace Swift {
/**
* The \ref postEvent method allows events to be added to the event queue of the \ref EventLoop.
- * An optional \ref EventOwner can be passed, allowing later removal of events that have not yet been
+ * An optional \ref EventOwner can be passed as \p owner, allowing later removal of events that have not yet been
* executed using the \ref removeEventsFromOwner method.
*/
void postEvent(boost::function<void ()> event, std::shared_ptr<EventOwner> owner = std::shared_ptr<EventOwner>());
/**
- * The \ref removeEventsFromOwner method removes all events from the specified \ref owner from the
+ * The \ref removeEventsFromOwner method removes all events from the specified \p owner from the
* event queue.
*/
void removeEventsFromOwner(std::shared_ptr<EventOwner> owner);
--
cgit v0.10.2-6-g49f6