From aaa5fc259a7583d1336ee1c56bff13b8d5758694 Mon Sep 17 00:00:00 2001 From: Klaus Basan Date: Fri, 18 Oct 2019 12:10:46 +0200 Subject: [PATCH] Doxygen --- src/blackcore/afv/dto.h | 6 ++++++ src/blackcore/afv/model/afvmapreader.h | 3 +++ src/blackcore/context/contextaudio.h | 1 - src/blackcore/context/contextnetwork.h | 3 +++ src/blackgui/levelmeter.h | 3 +++ src/blacksound/codecs/opusencoder.h | 7 +++++++ 6 files changed, 22 insertions(+), 1 deletion(-) diff --git a/src/blackcore/afv/dto.h b/src/blackcore/afv/dto.h index 20df66fbc..a0f6d42f0 100644 --- a/src/blackcore/afv/dto.h +++ b/src/blackcore/afv/dto.h @@ -182,8 +182,10 @@ namespace BlackCore //! Heartbeat DTO struct HeartbeatDto { + //! Name @{ static QByteArray getDtoName() { return "HeartbeatDto"; } static QByteArray getShortDtoName() { return "H"; } + //! @} std::string callsign; //!< callsign MSGPACK_DEFINE(callsign) @@ -192,8 +194,11 @@ namespace BlackCore //! Heartbeat DTO struct HeartbeatAckDto { + //! Name @{ static QByteArray getDtoName() { return "HeartbeatAckDto"; } static QByteArray getShortDtoName() { return "HA"; } + //! @} + MSGPACK_DEFINE() }; @@ -206,6 +211,7 @@ namespace BlackCore float distanceRatio; // std::string RelayCallsign; //! @} + MSGPACK_DEFINE(id, frequency, distanceRatio/*, RelayCallsign*/) }; diff --git a/src/blackcore/afv/model/afvmapreader.h b/src/blackcore/afv/model/afvmapreader.h index 3c65332b4..8ecebcb2b 100644 --- a/src/blackcore/afv/model/afvmapreader.h +++ b/src/blackcore/afv/model/afvmapreader.h @@ -25,7 +25,10 @@ namespace BlackCore class BLACKCORE_EXPORT CAfvMapReader : public QObject { Q_OBJECT + + //! Map reader properties @{ Q_PROPERTY(CSampleAtcStationModel *atcStationModel READ getAtcStationModel CONSTANT) + //! @} public: //! Ctor diff --git a/src/blackcore/context/contextaudio.h b/src/blackcore/context/contextaudio.h index f0a032b09..e5eacfb45 100644 --- a/src/blackcore/context/contextaudio.h +++ b/src/blackcore/context/contextaudio.h @@ -192,7 +192,6 @@ namespace BlackCore //! .unmute unmute BlackCore::Context::CContextAudio //! .vol .volume volume 0..100 set volume BlackCore::Context::CContextAudio //! - //! \copydoc IContext::parseCommandLine virtual bool parseCommandLine(const QString &commandLine, const BlackMisc::CIdentifier &originator) override; // ------------- DBus --------------- diff --git a/src/blackcore/context/contextnetwork.h b/src/blackcore/context/contextnetwork.h index bbd4a6f26..049344b62 100644 --- a/src/blackcore/context/contextnetwork.h +++ b/src/blackcore/context/contextnetwork.h @@ -365,7 +365,10 @@ namespace BlackCore //! Connect to receive raw fsd messages virtual QMetaObject::Connection connectRawFsdMessageSignal(QObject *receiver, RawFsdMessageReceivedSlot rawFsdMessageReceivedSlot) = 0; + //! Cmd.line arguments static const QList &getCmdLineOptions(); + + //! Client id and key from cmd.line static bool getCmdLineClientIdAndKey(int &id, QString &key); protected: diff --git a/src/blackgui/levelmeter.h b/src/blackgui/levelmeter.h index 662bcde3d..9338428aa 100644 --- a/src/blackgui/levelmeter.h +++ b/src/blackgui/levelmeter.h @@ -30,9 +30,12 @@ namespace BlackGui class BLACKGUI_EXPORT CLevelMeter : public QFrame { Q_OBJECT + + //! Properties @{ Q_PROPERTY(QColor lowColor READ getLowColor WRITE setLowColor) Q_PROPERTY(QColor highColor READ getHighColor WRITE setHighColor) Q_PROPERTY(QColor peakColor READ getPeakColor WRITE setPeakColor) + //! @} public: //! Constructor diff --git a/src/blacksound/codecs/opusencoder.h b/src/blacksound/codecs/opusencoder.h index af19c998f..19006b6ef 100644 --- a/src/blacksound/codecs/opusencoder.h +++ b/src/blacksound/codecs/opusencoder.h @@ -31,6 +31,12 @@ namespace BlackSound //! Dtor ~COpusEncoder(); + //! Non copyable + COpusEncoder(const COpusEncoder &temp_obj) = delete; + + //! Non assignable + COpusEncoder &operator=(const COpusEncoder &temp_obj) = delete; + //! Bit rate void setBitRate(int bitRate); @@ -41,6 +47,7 @@ namespace BlackSound //! Frame count int frameCount(const QVector pcmSamples); + //! Encode QByteArray encode(const QVector pcmSamples, int samplesLength, int *encodedLength); private: