diff options
Diffstat (limited to 'src/base/QXmppLogger.h')
| -rw-r--r-- | src/base/QXmppLogger.h | 17 |
1 files changed, 16 insertions, 1 deletions
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); |
