From a4d292ecb0a3459825e81a2b6d81df7a6d6635fb Mon Sep 17 00:00:00 2001
From: Linus Jahn <lnj@kaidan.im>
Date: Tue, 4 Feb 2020 16:11:24 +0100
Subject: Fix undocumented Q_PROPERTies

---
 src/base/QXmppLogger.cpp | 10 ----------
 src/base/QXmppLogger.h   | 17 ++++++++++++++++-
 src/base/QXmppStun.cpp   |  3 ---
 src/base/QXmppStun.h     |  4 ++++
 4 files changed, 20 insertions(+), 14 deletions(-)

(limited to 'src/base')

diff --git a/src/base/QXmppLogger.cpp b/src/base/QXmppLogger.cpp
index 8162d118..54c096dc 100644
--- a/src/base/QXmppLogger.cpp
+++ b/src/base/QXmppLogger.cpp
@@ -145,9 +145,6 @@ QXmppLogger *QXmppLogger::getLogger()
     return m_logger;
 }
 
-/// Returns the handler for logging messages.
-///
-
 QXmppLogger::LoggingType QXmppLogger::loggingType()
 {
     return d->loggingType;
@@ -165,9 +162,6 @@ void QXmppLogger::setLoggingType(QXmppLogger::LoggingType type)
     }
 }
 
-/// Returns the types of messages to log.
-///
-
 QXmppLogger::MessageTypes QXmppLogger::messageTypes()
 {
     return d->messageTypes;
@@ -232,10 +226,6 @@ void QXmppLogger::updateCounter(const QString &counter, qint64 amount)
     Q_UNUSED(amount);
 }
 
-/// Returns the path to which logging messages should be written.
-///
-/// \sa loggingType()
-
 QString QXmppLogger::logFilePath()
 {
     return d->logFilePath;
diff --git a/src/base/QXmppLogger.h b/src/base/QXmppLogger.h
index 4513b59a..a1b62b5b 100644
--- a/src/base/QXmppLogger.h
+++ b/src/base/QXmppLogger.h
@@ -37,16 +37,21 @@
 
 class QXmppLoggerPrivate;
 
+///
 /// \brief The QXmppLogger class represents a sink for logging messages.
 ///
 /// \ingroup Core
-
+///
 class QXMPP_EXPORT QXmppLogger : public QObject
 {
     Q_OBJECT
     Q_FLAGS(MessageType MessageTypes)
+
+    /// The path to which logging messages should be written
     Q_PROPERTY(QString logFilePath READ logFilePath WRITE setLogFilePath)
+    /// The handler for logging messages
     Q_PROPERTY(LoggingType loggingType READ loggingType WRITE setLoggingType)
+    /// The types of messages to log
     Q_PROPERTY(MessageTypes messageTypes READ messageTypes WRITE setMessageTypes)
 
 public:
@@ -76,12 +81,22 @@ public:
 
     static QXmppLogger *getLogger();
 
+    // documentation needs to be here, see https://stackoverflow.com/questions/49192523/
+    /// Returns the handler for logging messages.
     QXmppLogger::LoggingType loggingType();
     void setLoggingType(QXmppLogger::LoggingType type);
 
+    // documentation needs to be here, see https://stackoverflow.com/questions/49192523/
+    ///
+    /// Returns the path to which logging messages should be written.
+    ///
+    /// \sa loggingType()
+    ///
     QString logFilePath();
     void setLogFilePath(const QString &path);
 
+    // documentation needs to be here, see https://stackoverflow.com/questions/49192523/
+    /// Returns the types of messages to log.
     QXmppLogger::MessageTypes messageTypes();
     void setMessageTypes(QXmppLogger::MessageTypes types);
 
diff --git a/src/base/QXmppStun.cpp b/src/base/QXmppStun.cpp
index 703ca962..636afc38 100644
--- a/src/base/QXmppStun.cpp
+++ b/src/base/QXmppStun.cpp
@@ -2568,9 +2568,6 @@ bool QXmppIceConnection::isConnected() const
     return true;
 }
 
-/// Returns the ICE gathering state, that is the discovery of
-/// local candidates.
-
 QXmppIceConnection::GatheringState QXmppIceConnection::gatheringState() const
 {
     return d->gatheringState;
diff --git a/src/base/QXmppStun.h b/src/base/QXmppStun.h
index 6b66aad4..c801e4af 100644
--- a/src/base/QXmppStun.h
+++ b/src/base/QXmppStun.h
@@ -241,6 +241,7 @@ private:
 class QXMPP_EXPORT QXmppIceConnection : public QXmppLoggable
 {
     Q_OBJECT
+    /// The ICE gathering state, that is the discovery of local candidates
     Q_PROPERTY(QXmppIceConnection::GatheringState gatheringState READ gatheringState NOTIFY gatheringStateChanged)
 
 public:
@@ -274,6 +275,9 @@ public:
     bool bind(const QList<QHostAddress> &addresses);
     bool isConnected() const;
 
+    // documentation needs to be here, see https://stackoverflow.com/questions/49192523/
+    /// Returns the ICE gathering state, that is the discovery of local
+    /// candidates.
     GatheringState gatheringState() const;
 
 signals:
-- 
cgit v1.2.3