From 97eb8880a883b2eeab0df98d2a81da5337232c01 Mon Sep 17 00:00:00 2001 From: Klaus Basan Date: Sun, 20 Oct 2019 02:57:28 +0200 Subject: [PATCH] Doxygen, style --- src/blackcore/afv/audio/callsigndelaycache.cpp | 6 ++---- src/blackcore/afv/audio/callsigndelaycache.h | 15 +++++++++++++-- src/blackmisc/network/external/qjsonwebtoken.h | 6 +++--- 3 files changed, 18 insertions(+), 9 deletions(-) diff --git a/src/blackcore/afv/audio/callsigndelaycache.cpp b/src/blackcore/afv/audio/callsigndelaycache.cpp index 0f7851828..588eb11ed 100644 --- a/src/blackcore/afv/audio/callsigndelaycache.cpp +++ b/src/blackcore/afv/audio/callsigndelaycache.cpp @@ -27,8 +27,7 @@ namespace BlackCore void CallsignDelayCache::underflow(const QString &callsign) { - if (!successfulTransmissionsCache.contains(callsign)) - return; + if (!successfulTransmissionsCache.contains(callsign)) return; successfulTransmissionsCache[callsign] = 0; increaseDelayMs(callsign); @@ -36,8 +35,7 @@ namespace BlackCore void CallsignDelayCache::success(const QString &callsign) { - if (!successfulTransmissionsCache.contains(callsign)) - return; + if (!successfulTransmissionsCache.contains(callsign)) return; successfulTransmissionsCache[callsign]++; if (successfulTransmissionsCache[callsign] > 5) diff --git a/src/blackcore/afv/audio/callsigndelaycache.h b/src/blackcore/afv/audio/callsigndelaycache.h index a0bdd9ccb..9ae8f4ce8 100644 --- a/src/blackcore/afv/audio/callsigndelaycache.h +++ b/src/blackcore/afv/audio/callsigndelaycache.h @@ -8,8 +8,8 @@ //! \file -#ifndef CALLSIGNDELAYCACHE_H -#define CALLSIGNDELAYCACHE_H +#ifndef BLACKORE_AFV_AUDIO_CALLSIGNDELAYCACHE_H +#define BLACKORE_AFV_AUDIO_CALLSIGNDELAYCACHE_H #include #include @@ -24,13 +24,24 @@ namespace BlackCore class CallsignDelayCache { public: + //! Initialize void initialise(const QString &callsign); + + //! Callsign index int get(const QString &callsign); + + //! Underflow void underflow(const QString &callsign); + + //! Success void success(const QString &callsign); + + //! Delay plus/minus @{ void increaseDelayMs(const QString &callsign); void decreaseDelayMs(const QString &callsign); + //! @} + //! Singleton static CallsignDelayCache &instance(); private: diff --git a/src/blackmisc/network/external/qjsonwebtoken.h b/src/blackmisc/network/external/qjsonwebtoken.h index c04baef60..c3ab6ca29 100644 --- a/src/blackmisc/network/external/qjsonwebtoken.h +++ b/src/blackmisc/network/external/qjsonwebtoken.h @@ -114,7 +114,7 @@ public: /** \brief Sets the JWT *header* from a QString. - \param jdocHeader JWT *header* as a QString. + \param strHeader JWT *header* as a QString. \return true if the header was set, false if the header was not set. This method checks for a valid header format and returns false if the header is invalid. @@ -144,7 +144,7 @@ public: /** \brief Sets the JWT *payload* from a QJsonDocument. - \param jdocHeader JWT *payload* as a QJsonDocument. + \param jdocPayload JWT *payload* as a QJsonDocument. \return true if the payload was set, false if the payload was not set. This method checks for a valid payload format and returns false if the payload is invalid. @@ -155,7 +155,7 @@ public: /** \brief Sets the JWT *payload* from a QString. - \param jdocHeader JWT *payload* as a QString. + \param strPayload JWT *payload* as a QString. \return true if the payload was set, false if the payload was not set. This method checks for a valid payload format and returns false if the payload is invalid.