diff --git a/samples/afvclient/afvclientbridge.h b/samples/afvclient/afvclientbridge.h index 591f2f507..873633d57 100644 --- a/samples/afvclient/afvclientbridge.h +++ b/samples/afvclient/afvclientbridge.h @@ -19,7 +19,8 @@ class CAfvClientBridge : public QObject { Q_OBJECT - //! Bridge properties @{ + //! Bridge properties + //! @{ Q_PROPERTY(double inputVolumePeakVU READ getInputVolumePeakVU NOTIFY inputVolumePeakVU) Q_PROPERTY(double outputVolumePeakVU READ getOutputVolumePeakVU NOTIFY outputVolumePeakVU) Q_PROPERTY(BlackCore::Afv::Clients::CAfvClient::ConnectionStatus connectionStatus READ getConnectionStatus NOTIFY connectionStatusChanged) @@ -31,7 +32,8 @@ public: //! Ctor CAfvClientBridge(BlackCore::Afv::Clients::CAfvClient *afvClient, QObject *parent = nullptr); - //! VU values, 0..1 @{ + //! VU values, 0..1 + //! @{ double getInputVolumePeakVU() const { return m_afvClient->getInputVolumePeakVU(); } double getOutputVolumePeakVU() const { return m_afvClient->getOutputVolumePeakVU(); } //! @} @@ -42,7 +44,8 @@ public: return m_afvClient->getConnectionStatus(); } - //! Callsigns currently received @{ + //! Callsigns currently received + //! @{ QString getReceivingCallsignsCom1() { return m_afvClient->getReceivingCallsignsStringCom1(); } QString getReceivingCallsignsCom2() { return m_afvClient->getReceivingCallsignsStringCom2(); } //! @} @@ -57,7 +60,8 @@ public: //! \copydoc BlackCore::Afv::Clients::CAfvClient::disconnectFrom Q_INVOKABLE void disconnectFrom() { m_afvClient->disconnectFrom(); } - //! Audio devices @{ + //! Audio devices + //! @{ Q_INVOKABLE QStringList availableInputDevices() const { return m_afvClient->availableInputDevices(); } Q_INVOKABLE QStringList availableOutputDevices() const { return m_afvClient->availableOutputDevices(); } //! @} @@ -83,7 +87,8 @@ public: //! \copydoc BlackCore::Afv::Clients::CAfvClient::setPtt Q_INVOKABLE void setPtt(bool active) { m_afvClient->setPtt(active); } - //! Loopback @{ + //! Loopback + //! @{ Q_INVOKABLE void setLoopBack(bool on) { m_afvClient->setLoopBack(on); } Q_INVOKABLE bool isLoopback() const { return m_afvClient->isLoopback(); } //! @} @@ -108,7 +113,8 @@ signals: //! PTT status in this particular AFV client void ptt(bool active, BlackMisc::Audio::PTTCOM pttcom, const BlackMisc::CIdentifier &identifier); - //! VU levels @{ + //! VU levels + //! @{ void inputVolumePeakVU(double value); void outputVolumePeakVU(double value); //! @} diff --git a/src/blackcore/afv/audio/callsigndelaycache.h b/src/blackcore/afv/audio/callsigndelaycache.h index 9ae8f4ce8..401cdc9f7 100644 --- a/src/blackcore/afv/audio/callsigndelaycache.h +++ b/src/blackcore/afv/audio/callsigndelaycache.h @@ -36,7 +36,8 @@ namespace BlackCore //! Success void success(const QString &callsign); - //! Delay plus/minus @{ + //! Delay plus/minus + //! @{ void increaseDelayMs(const QString &callsign); void decreaseDelayMs(const QString &callsign); //! @} diff --git a/src/blackcore/afv/audio/callsignsampleprovider.h b/src/blackcore/afv/audio/callsignsampleprovider.h index 7c37a7e1c..3f744974d 100644 --- a/src/blackcore/afv/audio/callsignsampleprovider.h +++ b/src/blackcore/afv/audio/callsignsampleprovider.h @@ -62,7 +62,8 @@ namespace BlackCore //! Clean void clear(); - //! Add samples @{ + //! Add samples + //! @{ void addOpusSamples(const IAudioDto &audioDto, float distanceRatio); void addSilentSamples(const IAudioDto &audioDto); //! @} diff --git a/src/blackcore/afv/audio/input.h b/src/blackcore/afv/audio/input.h index 82b65f354..08f0dcdc8 100644 --- a/src/blackcore/afv/audio/input.h +++ b/src/blackcore/afv/audio/input.h @@ -96,7 +96,8 @@ namespace BlackCore this->stop(); } - //! Number of encoded bytes @{ + //! Number of encoded bytes + //! @{ int opusBytesEncoded() const { return m_opusBytesEncoded; } void setOpusBytesEncoded(int opusBytesEncoded) { m_opusBytesEncoded = opusBytesEncoded; } //! @} @@ -113,7 +114,8 @@ namespace BlackCore // bool setVolume(double volume); /* disabled as not needed - //! The device's volume 0..1 @{ + //! The device's volume 0..1 + //! @{ double getDeviceInputVolume() const; bool setDeviceInputVolume(double volume); //! @} diff --git a/src/blackcore/afv/audio/output.h b/src/blackcore/afv/audio/output.h index 3c6eea54d..6bf0af1b7 100644 --- a/src/blackcore/afv/audio/output.h +++ b/src/blackcore/afv/audio/output.h @@ -90,7 +90,8 @@ namespace BlackCore const BlackMisc::Audio::CAudioDeviceInfo &device() const { return m_device; } /* disabled as not used - //! The device's volume 0..1 @{ + //! The device's volume 0..1 + //! @{ double getDeviceOutputVolume() const; bool setDeviceOutputVolume(double volume); //! @} diff --git a/src/blackcore/afv/audio/receiversampleprovider.h b/src/blackcore/afv/audio/receiversampleprovider.h index 0cfd2e949..ad77196eb 100644 --- a/src/blackcore/afv/audio/receiversampleprovider.h +++ b/src/blackcore/afv/audio/receiversampleprovider.h @@ -60,7 +60,8 @@ namespace BlackCore //! Volume double volume() const { return 1.0; } - //! Mute @{ + //! Mute + //! @{ bool getMute() const { return m_mute; } void setMute(bool value); //! @} @@ -68,7 +69,8 @@ namespace BlackCore //! \copydoc BlackSound::SampleProvider::ISampleProvider::readSamples virtual int readSamples(QVector &samples, qint64 count) override; - //! Add samples @{ + //! Add samples + //! @{ void addOpusSamples(const IAudioDto &audioDto, uint frequency, float distanceRatio); void addSilentSamples(const IAudioDto &audioDto, uint frequency, float distanceRatio); //! @} diff --git a/src/blackcore/afv/clients/afvclient.h b/src/blackcore/afv/clients/afvclient.h index 0234df0bd..2f080e734 100644 --- a/src/blackcore/afv/clients/afvclient.h +++ b/src/blackcore/afv/clients/afvclient.h @@ -49,7 +49,8 @@ namespace BlackCore { Q_OBJECT - //! AFV client properties @{ + //! AFV client properties + //! @{ Q_PROPERTY(double inputVolumePeakVU READ getInputVolumePeakVU NOTIFY inputVolumePeakVU) Q_PROPERTY(double outputVolumePeakVU READ getOutputVolumePeakVU NOTIFY outputVolumePeakVU) Q_PROPERTY(BlackCore::Afv::Clients::CAfvClient::ConnectionStatus connectionStatus READ getConnectionStatus NOTIFY connectionStatusChanged) @@ -100,7 +101,8 @@ namespace BlackCore void disconnectFromAndStop() { this->disconnectFrom(true); } //! @} - //! Audio devices @{ + //! Audio devices + //! @{ Q_INVOKABLE QStringList availableInputDevices() const; Q_INVOKABLE QStringList availableOutputDevices() const; //! @} @@ -121,7 +123,8 @@ namespace BlackCore void setMuted(bool mute); //! @} - //! Start/stop client @{ + //! Start/stop client + //! @{ void startAudio(); void startAudio(const BlackMisc::Audio::CAudioDeviceInfo &inputDevice, const BlackMisc::Audio::CAudioDeviceInfo &outputDevice); Q_INVOKABLE void startAudio(const QString &inputDeviceName, const QString &outputDeviceName); @@ -134,7 +137,8 @@ namespace BlackCore bool isComUnitIntegrated() const { return m_integratedComUnit; } /* NOT used - //! The device's volume 0..1 @{ + //! The device's volume 0..1 + //! @{ double getDeviceInputVolume() const; bool setDeviceInputVolume(double volume); double getDeviceOutputVolume() const; @@ -302,7 +306,8 @@ namespace BlackCore //! PTT status in this particular AFV client void ptt(bool active, BlackMisc::Audio::PTTCOM pttcom, const BlackMisc::CIdentifier &identifier); - //! VU levels @{ + //! VU levels + //! @{ void inputVolumePeakVU(double value); void outputVolumePeakVU(double value); //! @} diff --git a/src/blackcore/afv/connection/apiserverconnection.h b/src/blackcore/afv/connection/apiserverconnection.h index 7a47836b1..be376f836 100644 --- a/src/blackcore/afv/connection/apiserverconnection.h +++ b/src/blackcore/afv/connection/apiserverconnection.h @@ -83,7 +83,8 @@ namespace BlackCore //! Get the URL const QString &getUrl() const { return m_addressUrl; } - //! User data @{ + //! User data + //! @{ const QString &getUserName() const { return m_username; } const QString &getPassword() const { return m_password; } const QString &getClient() const { return m_client; } diff --git a/src/blackcore/afv/connection/clientconnection.h b/src/blackcore/afv/connection/clientconnection.h index 40dd6e34a..0a0f58005 100644 --- a/src/blackcore/afv/connection/clientconnection.h +++ b/src/blackcore/afv/connection/clientconnection.h @@ -58,7 +58,8 @@ namespace BlackCore //! Is alive? bool isVoiceServerAlive() const { return m_connection.isVoiceServerAlive(); } - //! Receiving audio? @{ + //! Receiving audio? + //! @{ void setReceiveAudio(bool value) { m_connection.setReceiveAudio(value); } bool receiveAudio() const { return m_connection.isReceivingAudio(); } bool receiveAudioDto() const { return m_receiveAudioDto; } @@ -97,7 +98,8 @@ namespace BlackCore //! Authenticated since when qint64 secondsSinceAuthentication() const { return m_connection.secondsSinceAuthentication(); } - //! User data @{ + //! User data + //! @{ const QString &getUserName() const { return m_connection.getUserName(); } const QString &getCallsign() const { return m_connection.getCallsign(); } const QString &getPassword() const { static const QString e; return m_apiServerConnection ? m_apiServerConnection->getPassword() : e; } diff --git a/src/blackcore/afv/connection/clientconnectiondata.h b/src/blackcore/afv/connection/clientconnectiondata.h index 47638c93f..20dabbf09 100644 --- a/src/blackcore/afv/connection/clientconnectiondata.h +++ b/src/blackcore/afv/connection/clientconnectiondata.h @@ -40,17 +40,20 @@ namespace BlackCore //! Time since authentication qint64 secondsSinceAuthentication() const; - //! Servers alive @{ + //! Servers alive + //! @{ bool isVoiceServerAlive() const; bool isDataServerAlive() const; //! @} - //! Is connected? @{ + //! Is connected? + //! @{ bool isConnected() const { return m_connected; } void setConnected(bool connected) { m_connected = connected; } //! @} - //! Receiving audio? @{ + //! Receiving audio? + //! @{ bool isReceivingAudio() const { return m_receiveAudio; } void setReceiveAudio(bool receive) { m_receiveAudio = receive; } //! @} @@ -58,22 +61,26 @@ namespace BlackCore //! Crypto channels for voice and data void createCryptoChannels(); - //! Tokens @{ + //! Tokens + //! @{ const PostCallsignResponseDto &getTokens() const { return m_tokens; } void setTokens(const PostCallsignResponseDto &dto) { m_tokens = dto; } //! @} - //! Callsign @{ + //! Callsign + //! @{ const QString &getCallsign() const { return m_callsign; } void setCallsign(const QString &callsign) { m_callsign = callsign; } //! @} - //! Uername @{ + //! Uername + //! @{ const QString &getUserName() const { return m_userName; } void setUserName(const QString &un) { m_userName = un; } //! @} - //! Timestamps @{ + //! Timestamps + //! @{ void setTsAuthenticatedToNow(); void setTsHeartbeatToNow(); //! @} diff --git a/src/blackcore/afv/crypto/cryptodtochannel.h b/src/blackcore/afv/crypto/cryptodtochannel.h index ec5af5ba6..974de58e3 100644 --- a/src/blackcore/afv/crypto/cryptodtochannel.h +++ b/src/blackcore/afv/crypto/cryptodtochannel.h @@ -36,7 +36,8 @@ namespace BlackCore //! Ctor CCryptoDtoChannel(const CryptoDtoChannelConfigDto &channelConfig, int receiveSequenceHistorySize = 10); - //! Transmit key @{ + //! Transmit key + //! @{ QByteArray getTransmitKey(CryptoDtoMode mode); QByteArray getTransmitKey(CryptoDtoMode mode, uint &sequenceToSend); //! @} diff --git a/src/blackcore/afv/crypto/cryptodtoserializer.h b/src/blackcore/afv/crypto/cryptodtoserializer.h index 0d1427191..fdb418483 100644 --- a/src/blackcore/afv/crypto/cryptodtoserializer.h +++ b/src/blackcore/afv/crypto/cryptodtoserializer.h @@ -141,17 +141,20 @@ namespace BlackCore return {}; } - //! Header data @{ + //! Header data + //! @{ quint16 m_headerLength; CryptoDtoHeaderDto m_header; //! @} - //! Name data @{ + //! Name data + //! @{ quint16 m_dtoNameLength; QByteArray m_dtoNameBuffer; //! @} - //! Data @{ + //! Data + //! @{ quint16 m_dataLength; QByteArray m_dataBuffer; //! @} diff --git a/src/blackcore/afv/dto.h b/src/blackcore/afv/dto.h index 7610393bc..d0346c9ef 100644 --- a/src/blackcore/afv/dto.h +++ b/src/blackcore/afv/dto.h @@ -27,7 +27,8 @@ namespace BlackCore //! Channel config DTO struct CryptoDtoChannelConfigDto { - //! Properties @{ + //! Properties + //! @{ QString channelTag; QByteArray aeadReceiveKey; QByteArray aeadTransmitKey; @@ -61,7 +62,8 @@ namespace BlackCore //! Voice server DTO struct VoiceServerConnectionDataDto { - //! Properties @{ + //! Properties + //! @{ QString addressIpV4; // Example: 123.123.123.123:50000 QString addressIpV6; // Example: 123.123.123.123:50000 CryptoDtoChannelConfigDto channelConfig; @@ -91,7 +93,8 @@ namespace BlackCore //! Callsign DTO struct PostCallsignResponseDto { - //! Properties @{ + //! Properties + //! @{ // DataServerConnectionDataDto DataServer; VoiceServerConnectionDataDto VoiceServer; bool isValid = false; @@ -120,7 +123,8 @@ namespace BlackCore //! Transceiver DTO struct TransceiverDto { - //! Properties @{ + //! Properties + //! @{ quint16 id; quint32 frequencyHz; double LatDeg = 0.0; @@ -160,7 +164,8 @@ namespace BlackCore //! Station DTO struct StationDto { - //! Properties @{ + //! Properties + //! @{ QUuid id; QString name; quint32 frequencyHz; @@ -182,7 +187,8 @@ namespace BlackCore //! Heartbeat DTO struct HeartbeatDto { - //! Name @{ + //! Name + //! @{ static QByteArray getDtoName() { return "HeartbeatDto"; } static QByteArray getShortDtoName() { return "H"; } //! @} @@ -194,7 +200,8 @@ namespace BlackCore //! Heartbeat DTO struct HeartbeatAckDto { - //! Name @{ + //! Name + //! @{ static QByteArray getDtoName() { return "HeartbeatAckDto"; } static QByteArray getShortDtoName() { return "HA"; } //! @} @@ -205,7 +212,8 @@ namespace BlackCore //! Receive transceiver DTO struct RxTransceiverDto { - //! Properties @{ + //! Properties + //! @{ uint16_t id; uint32_t frequency; float distanceRatio; @@ -240,12 +248,14 @@ namespace BlackCore //! AudioTxOnTransceiversDto struct AudioTxOnTransceiversDto { - //! Names @{ + //! Names + //! @{ static QByteArray getDtoName() { return "AudioTxOnTransceiversDto"; } static QByteArray getShortDtoName() { return "AT"; } //! @} - //! Properties @{ + //! Properties + //! @{ std::string callsign; uint sequenceCounter; std::vector audio; @@ -258,12 +268,14 @@ namespace BlackCore //! AudioRxOnTransceiversDto struct AudioRxOnTransceiversDto { - //! Names @{ + //! Names + //! @{ static QByteArray getDtoName() { return "AudioRxOnTransceiversDto"; } static QByteArray getShortDtoName() { return "AR"; } //! @} - //! Properties @{ + //! Properties + //! @{ std::string callsign; uint sequenceCounter; std::vector audio; diff --git a/src/blackcore/afv/model/afvmapreader.h b/src/blackcore/afv/model/afvmapreader.h index 8ecebcb2b..00e0db466 100644 --- a/src/blackcore/afv/model/afvmapreader.h +++ b/src/blackcore/afv/model/afvmapreader.h @@ -26,7 +26,8 @@ namespace BlackCore { Q_OBJECT - //! Map reader properties @{ + //! Map reader properties + //! @{ Q_PROPERTY(CSampleAtcStationModel *atcStationModel READ getAtcStationModel CONSTANT) //! @} diff --git a/src/blackcore/afv/model/atcstationmodel.h b/src/blackcore/afv/model/atcstationmodel.h index 64064b727..ce993882f 100644 --- a/src/blackcore/afv/model/atcstationmodel.h +++ b/src/blackcore/afv/model/atcstationmodel.h @@ -35,7 +35,8 @@ namespace BlackCore //! Ctor CSampleAtcStation(const QString &callsign, const BlackCore::Afv::TransceiverDto &transceiver); - //! Getter @{ + //! Getter + //! @{ const QString &callsign() const { return m_callsign; } QString formattedFrequency() const; double latitude() const; diff --git a/src/blackcore/airspacemonitor.h b/src/blackcore/airspacemonitor.h index c56c9f38e..c100466c5 100644 --- a/src/blackcore/airspacemonitor.h +++ b/src/blackcore/airspacemonitor.h @@ -167,7 +167,8 @@ namespace BlackCore }; Q_DECLARE_FLAGS(MatchingReadiness, MatchingReadinessFlag) - //! As string @{ + //! As string + //! @{ static const QString &enumFlagToString(MatchingReadinessFlag r); static QString enumToString(MatchingReadiness r); //! @} diff --git a/src/blackcore/application.h b/src/blackcore/application.h index b6bd84b53..7c96ad0c6 100644 --- a/src/blackcore/application.h +++ b/src/blackcore/application.h @@ -317,7 +317,6 @@ namespace BlackCore //! cmd line arguments as string virtual QString cmdLineArgumentsAsString(bool withExecutable = true); - //! @} //! Simulate a crash //! \private only for testing purposes @@ -382,16 +381,18 @@ namespace BlackCore //! Get the facade CCoreFacade *getCoreFacade() { return m_coreFacade.data(); } - //! Local or DBus application? @{ + //! Local or DBus application? + //! @{ bool isLocalContext() const; bool isDBusContext() const; //! @} //! Get the facade + //! @{ const CCoreFacade *getCoreFacade() const { return m_coreFacade.data(); } //! @} - //! \name Direct access to contexts if a CCoreFacade has been initialized + //! Direct access to contexts if a CCoreFacade has been initialized //! @{ const Context::IContextNetwork *getIContextNetwork() const; const Context::IContextAudio *getIContextAudio() const; diff --git a/src/blackcore/context/contextapplicationimpl.h b/src/blackcore/context/contextapplicationimpl.h index 68d549ff7..c1fe66f75 100644 --- a/src/blackcore/context/contextapplicationimpl.h +++ b/src/blackcore/context/contextapplicationimpl.h @@ -46,8 +46,8 @@ namespace BlackCore friend class IContextApplication; public slots: - //! @{ //! \publicsection + //! @{ virtual void changeSettings(const BlackMisc::CValueCachePacket &settings, const BlackMisc::CIdentifier &origin) override; virtual BlackMisc::CValueCachePacket getAllSettings() const override; virtual QStringList getUnsavedSettingsKeys() const override; diff --git a/src/blackcore/context/contextapplicationproxy.h b/src/blackcore/context/contextapplicationproxy.h index 67127d89d..de4072cb4 100644 --- a/src/blackcore/context/contextapplicationproxy.h +++ b/src/blackcore/context/contextapplicationproxy.h @@ -49,8 +49,8 @@ namespace BlackCore virtual ~CContextApplicationProxy() override {} public slots: - //! @{ //! \publicsection + //! @{ virtual void changeSettings(const BlackMisc::CValueCachePacket &settings, const BlackMisc::CIdentifier &origin) override; virtual BlackMisc::CValueCachePacket getAllSettings() const override; virtual QStringList getUnsavedSettingsKeys() const override; diff --git a/src/blackcore/context/contextaudio.h b/src/blackcore/context/contextaudio.h index d91037f09..cef196ad5 100644 --- a/src/blackcore/context/contextaudio.h +++ b/src/blackcore/context/contextaudio.h @@ -144,13 +144,15 @@ namespace BlackCore //! Graceful shutdown void gracefulShutdown(); - //! Enable/disable @{ + //! Enable/disable + //! @{ void enableVoiceClient() { this->initVoiceClient(); } void enableVoiceClientAndStart(); void disableVoiceClient() { this->terminateVoiceClient(); } //! @} - //! Receive/transmit @{ + //! Receive/transmit + //! @{ void setRxTx(bool rx1, bool tx1, bool rx2, bool tx2); void getRxTx(bool &rx1, bool &tx1, bool &rx2, bool &tx2) const; //! @} @@ -291,7 +293,8 @@ namespace BlackCore * Workaround those must be invisible for DBus * - //! VU levels @{ + //! VU levels + //! @{ void inputVolumePeakVU (double value); void outputVolumePeakVU(double value); //! @} diff --git a/src/blackcore/context/contextownaircraftimpl.h b/src/blackcore/context/contextownaircraftimpl.h index f6cf10459..45cdb4edf 100644 --- a/src/blackcore/context/contextownaircraftimpl.h +++ b/src/blackcore/context/contextownaircraftimpl.h @@ -240,7 +240,8 @@ namespace BlackCore //! \ingroup crosscontextfunction void xCtxChangedSimulatorStatus(int status); - //! Actions @{ + //! Actions + //! @{ void actionToggleTransponder(bool keydown); void actionIdent(bool keydown); //! @} diff --git a/src/blackcore/fsd/atcdataupdate.h b/src/blackcore/fsd/atcdataupdate.h index 7c9d427cd..79be5b241 100644 --- a/src/blackcore/fsd/atcdataupdate.h +++ b/src/blackcore/fsd/atcdataupdate.h @@ -37,7 +37,8 @@ namespace BlackCore //! Construct from tokens static AtcDataUpdate fromTokens(const QStringList &tokens); - //! Properties @{ + //! Properties + //! @{ int m_frequencykHz = 0.0; BlackMisc::Network::CFacilityType m_facility; int m_visibleRange = 0.0; diff --git a/src/blackcore/fsd/clientidentification.h b/src/blackcore/fsd/clientidentification.h index dae9a1d35..29f57d35d 100644 --- a/src/blackcore/fsd/clientidentification.h +++ b/src/blackcore/fsd/clientidentification.h @@ -37,7 +37,8 @@ namespace BlackCore //! PDU identifier static QString pdu() { return "$ID"; } - //! Properties @{ + //! Properties + //! @{ std::uint16_t m_clientId = 0; QString m_clientName; int m_clientVersionMajor = BlackConfig::CBuildConfig::getVersion().majorVersion(); diff --git a/src/blackcore/fsd/clientquery.h b/src/blackcore/fsd/clientquery.h index 907c0b2b1..0a2885c34 100644 --- a/src/blackcore/fsd/clientquery.h +++ b/src/blackcore/fsd/clientquery.h @@ -39,7 +39,8 @@ namespace BlackCore //! PDU identifier static QString pdu() { return "$CQ"; } - //! Properties @{ + //! Properties + //! @{ ClientQueryType m_queryType = ClientQueryType::Unknown; QStringList m_queryData; //! @} diff --git a/src/blackcore/fsd/clientresponse.h b/src/blackcore/fsd/clientresponse.h index 283c2bc77..5c595e9e0 100644 --- a/src/blackcore/fsd/clientresponse.h +++ b/src/blackcore/fsd/clientresponse.h @@ -37,7 +37,8 @@ namespace BlackCore //! PDU identifier static QString pdu() { return "$CR"; } - //! Properties @{ + //! Properties + //! @{ ClientQueryType m_queryType {}; QStringList m_responseData; //! @} diff --git a/src/blackcore/fsd/enums.h b/src/blackcore/fsd/enums.h index 8a12ae8c1..5174e23d2 100644 --- a/src/blackcore/fsd/enums.h +++ b/src/blackcore/fsd/enums.h @@ -174,7 +174,8 @@ namespace BlackCore AircraftConfig = (1 << 8) }; - //! Operators @{ + //! Operators + //! @{ inline Capabilities operator | (Capabilities lhs, Capabilities rhs) { return static_cast(static_cast(lhs) | static_cast(rhs)); diff --git a/src/blackcore/fsd/flightplan.h b/src/blackcore/fsd/flightplan.h index d68e73528..e837ee33f 100644 --- a/src/blackcore/fsd/flightplan.h +++ b/src/blackcore/fsd/flightplan.h @@ -37,7 +37,8 @@ namespace BlackCore //! PDU identifier static QString pdu() { return "$FP"; } - //! Properties @{ + //! Properties + //! @{ FlightType m_flightType {}; QString m_aircraftIcaoType; int m_trueCruisingSpeed = 0; @@ -53,7 +54,7 @@ namespace BlackCore QString m_altAirport; QString m_remarks; QString m_route; - //! @ + //! @} protected: FlightPlan(); diff --git a/src/blackcore/fsd/fsdclient.h b/src/blackcore/fsd/fsdclient.h index 2e936ca7a..9ac38cc53 100644 --- a/src/blackcore/fsd/fsdclient.h +++ b/src/blackcore/fsd/fsdclient.h @@ -47,7 +47,8 @@ #include -//! Protocol version @{ +//! Protocol version +//! @{ #define PROTOCOL_REVISION_CLASSIC 9 #define PROTOCOL_REVISION_VATSIM_ATC 10 #define PROTOCOL_REVISION_VATSIM_AUTH 100 @@ -139,12 +140,14 @@ namespace BlackCore //! \threadsafe PilotRating getPilotRating() const { QReadLocker l(&m_lockUserClientBuffered); return m_pilotRating; } - //! Connenct/disconnect @{ + //! Connenct/disconnect + //! @{ void connectToServer(); void disconnectFromServer(); //! @} - //! Interim positions @{ + //! Interim positions + //! @{ void addInterimPositionReceiver(const BlackMisc::Aviation::CCallsign &receiver) { m_interimPositionReceivers.push_back(receiver); } void removeInterimPositionReceiver(const BlackMisc::Aviation::CCallsign &receiver) { m_interimPositionReceivers.remove(receiver); } //! @} @@ -169,19 +172,22 @@ namespace BlackCore void sendPlaneInfoRequestFsinn(const BlackMisc::Aviation::CCallsign &callsign); //! @} - //! Interim pos.receivers @{ + //! Interim pos.receivers + //! @{ BlackMisc::Aviation::CCallsignSet getInterimPositionReceivers() const; void setInterimPositionReceivers(const BlackMisc::Aviation::CCallsignSet &interimPositionReceivers); //! @} - //! Connection status @{ + //! Connection status + //! @{ BlackMisc::Network::CConnectionStatus getConnectionStatus() const { QReadLocker l(&m_lockConnectionStatus); return m_connectionStatus; } bool isConnected() const { return this->getConnectionStatus().isConnected(); } bool isDisconnected() const { return this->getConnectionStatus().isDisconnected(); } bool isPendingConnection() const; //! @} - //! Statistics enable functions @{ + //! Statistics enable functions + //! @{ bool setStatisticsEnable(bool enabled) { m_statistics = enabled; return enabled; } bool isStatisticsEnabled() const { return m_statistics; } //! @} @@ -199,7 +205,8 @@ namespace BlackCore void gracefulShutdown(); signals: - //! Client responses received @{ + //! Client responses received + //! @{ void atcDataUpdateReceived(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::PhysicalQuantities::CFrequency &freq, const BlackMisc::Geo::CCoordinateGeodetic &pos, const BlackMisc::PhysicalQuantities::CLength &range); void deleteAtcReceived(const QString &cid); @@ -269,7 +276,8 @@ namespace BlackCore void sendQueuedMessage(); //! @} - //! Increase the statistics value for given identifier @{ + //! Increase the statistics value for given identifier + //! @{ int increaseStatisticsValue(const QString &identifier, const QString &appendix = {}); int increaseStatisticsValue(const QString &identifier, int value); //! @} @@ -295,7 +303,8 @@ namespace BlackCore this->sendMessageString(messageToFSDString(message)); } - //! Unit test/debug functions @{ + //! Unit test/debug functions + //! @{ void sendFsdMessage(const QString &message); void setUnitTestMode(bool on) { m_unitTestMode = on; } //! @} @@ -346,7 +355,8 @@ namespace BlackCore // Type to string const QString &messageTypeToString(MessageType mt) const; - //! Handle response tokens @{ + //! Handle response tokens + //! @{ void handleAtcDataUpdate(const QStringList &tokens); void handleAuthChallenge(const QStringList &tokens); void handleAuthResponse(const QStringList &tokens); @@ -418,7 +428,8 @@ namespace BlackCore //! Emit raw FSD message (mostly for debugging) void emitRawFsdMessage(const QString &fsdMessage, bool isSent); - //! Additional offset time @{ + //! Additional offset time + //! @{ qint64 getAdditionalOffsetTime() const; void setAdditionalOffsetTime(qint64 addOffset); //! @} @@ -426,7 +437,8 @@ namespace BlackCore //! Save the statistics bool saveNetworkStatistics(const QString &server); - //! Timers @{ + //! Timers + //! @{ void startPositionTimers(); void stopPositionTimers(); //! @} diff --git a/src/blackcore/fsd/fsdidentification.h b/src/blackcore/fsd/fsdidentification.h index 2759d41e2..2c1d8254d 100644 --- a/src/blackcore/fsd/fsdidentification.h +++ b/src/blackcore/fsd/fsdidentification.h @@ -33,7 +33,8 @@ namespace BlackCore //! PDU identifier static QString pdu() { return "$DI"; } - //! Properties @{ + //! Properties + //! @{ QString m_serverVersion; QString m_initialChallenge; //! @} diff --git a/src/blackcore/fsd/interimpilotdataupdate.h b/src/blackcore/fsd/interimpilotdataupdate.h index 3d7d8d7ef..296171111 100644 --- a/src/blackcore/fsd/interimpilotdataupdate.h +++ b/src/blackcore/fsd/interimpilotdataupdate.h @@ -35,7 +35,8 @@ namespace BlackCore //! PDU identifier static QString pdu() { return "#SB"; } - //! Properties @{ + //! Properties + //! @{ double m_latitude = 0.0; double m_longitude = 0.0; int m_altitudeTrue = 0.0; diff --git a/src/blackcore/fsd/pilotdataupdate.h b/src/blackcore/fsd/pilotdataupdate.h index 620a38691..1a0432b77 100644 --- a/src/blackcore/fsd/pilotdataupdate.h +++ b/src/blackcore/fsd/pilotdataupdate.h @@ -36,7 +36,8 @@ namespace BlackCore //! PDU identifier static QString pdu() { return "@"; } - //! Properties @{ + //! Properties + //! @{ BlackMisc::Aviation::CTransponder::TransponderMode m_transponderMode = BlackMisc::Aviation::CTransponder::StateStandby; int m_transponderCode = 0; PilotRating m_rating = PilotRating::Unknown; diff --git a/src/blackcore/fsd/planeinforequestfsinn.h b/src/blackcore/fsd/planeinforequestfsinn.h index 6c16fe482..9ee9eb802 100644 --- a/src/blackcore/fsd/planeinforequestfsinn.h +++ b/src/blackcore/fsd/planeinforequestfsinn.h @@ -38,7 +38,8 @@ namespace BlackCore //! PDU identifier static QString pdu() { return QStringLiteral("#SB"); } - //! Properties @{ + //! Properties + //! @{ QString m_airlineIcao; QString m_aircraftIcao; QString m_aircraftIcaoCombinedType; diff --git a/src/blackcore/fsd/planeinformation.h b/src/blackcore/fsd/planeinformation.h index 043481ff7..399bd0dad 100644 --- a/src/blackcore/fsd/planeinformation.h +++ b/src/blackcore/fsd/planeinformation.h @@ -34,7 +34,8 @@ namespace BlackCore //! PDU identifier static QString pdu() { return "#SB"; } - //! Properties @{ + //! Properties + //! @{ QString m_aircraft; QString m_airline; QString m_livery; diff --git a/src/blackcore/fsd/planeinformationfsinn.h b/src/blackcore/fsd/planeinformationfsinn.h index e016e0d6f..092711d82 100644 --- a/src/blackcore/fsd/planeinformationfsinn.h +++ b/src/blackcore/fsd/planeinformationfsinn.h @@ -38,7 +38,8 @@ namespace BlackCore //! PDU identifier static QString pdu() { return "#SB"; } - //! Properties @{ + //! Properties + //! @{ QString m_airlineIcao; QString m_aircraftIcao; QString m_aircraftIcaoCombinedType; diff --git a/src/blackcore/fsd/revbclientparts.h b/src/blackcore/fsd/revbclientparts.h index 1cd930f8d..da0d36d81 100644 --- a/src/blackcore/fsd/revbclientparts.h +++ b/src/blackcore/fsd/revbclientparts.h @@ -38,17 +38,19 @@ namespace BlackCore //! PDU identifier static QString pdu() { return "-MD"; } - //! Properties @{ + //! Properties + //! @{ ClientQueryType m_queryType = ClientQueryType::Unknown; QStringList m_queryData; //! @} - //! Properties @{ + //! Properties + //! @{ QString m_partsval1; QString m_partsval2; QString m_partsval3; - //! @ + //! @} private: RevBClientParts(); diff --git a/src/blackcore/fsd/serializer.cpp b/src/blackcore/fsd/serializer.cpp index c453fc332..9cba8273f 100644 --- a/src/blackcore/fsd/serializer.cpp +++ b/src/blackcore/fsd/serializer.cpp @@ -21,7 +21,8 @@ namespace BlackCore { namespace Fsd { - //! private @{ + //! private + //! @{ namespace Private { diff --git a/src/blackcore/fsd/servererror.h b/src/blackcore/fsd/servererror.h index 06bd8ac3f..90c4b9636 100644 --- a/src/blackcore/fsd/servererror.h +++ b/src/blackcore/fsd/servererror.h @@ -37,12 +37,14 @@ namespace BlackCore //! PDU identifier static QString pdu() { return "$ER"; } - //! Getter @{ + //! Getter + //! @{ const QString &getCausingParameter() const { static const QString n("no details"); return m_causingParameter.isEmpty() ? n : m_causingParameter; } const QString &getDescription() const { static const QString n("no description"); return m_description.isEmpty() ? n : m_description; } //! @} - //! Properties @{ + //! Properties + //! @{ ServerErrorCode m_errorNumber {}; QString m_causingParameter; QString m_description; diff --git a/src/blackcore/simulator.h b/src/blackcore/simulator.h index 8f8566fd0..edac99407 100644 --- a/src/blackcore/simulator.h +++ b/src/blackcore/simulator.h @@ -420,7 +420,7 @@ namespace BlackCore BlackMisc::Network::IClientProvider *clientProvider, QObject *parent = nullptr); - //! \name When swift DB data are read + //! When swift DB data are read //! @{ virtual void onSwiftDbAllDataRead(); virtual void onSwiftDbModelMatchingEntitiesRead(); @@ -442,7 +442,7 @@ namespace BlackCore //! Max.airports in range int maxAirportsInRange() const; - //! \name Connected with remote aircraft provider signals + //! Connected with remote aircraft provider signals //! @{ //! Recalculate the rendered aircraft, this happens when restrictions are applied (max. aircraft, range) virtual void onRecalculatedRenderedAircraft(const BlackMisc::Simulation::CAirspaceAircraftSnapshot &snapshot); @@ -735,7 +735,8 @@ namespace BlackCore //! ISimulatorVirtual destructor virtual ~ISimulatorFactory() {} - //! Not copyable @{ + //! Not copyable + //! @{ ISimulatorFactory(const ISimulatorFactory &) = delete; ISimulatorFactory &operator=(const ISimulatorFactory &) = delete; //! @} diff --git a/src/blackcore/webdataservices.h b/src/blackcore/webdataservices.h index 0c6c17876..665611b9b 100644 --- a/src/blackcore/webdataservices.h +++ b/src/blackcore/webdataservices.h @@ -532,7 +532,9 @@ namespace BlackCore // 1) simple signature // 2) fired directly after read, no need to wait for other entities - //! \name Simplified read signals @{ + //! \name Simplified read signals + //! @{ + //! All swift DB data have been read void swiftDbAllDataRead(); diff --git a/src/blackcore/webdataservicesms.h b/src/blackcore/webdataservicesms.h index 68b4b0362..dabb195f2 100644 --- a/src/blackcore/webdataservicesms.h +++ b/src/blackcore/webdataservicesms.h @@ -30,7 +30,8 @@ namespace BlackCore //! Ctor Q_INVOKABLE MSWebServices() {} - //! Functions calling the web services @{ + //! Functions calling the web services + //! @{ Q_INVOKABLE int countAircraftIcaoCodesForDesignator(const QString &designator) const; Q_INVOKABLE int countAirlineIcaoCodesForDesignator(const QString &designator) const; //! @} diff --git a/src/blackgui/components/audioadvanceddistributedcomponent.h b/src/blackgui/components/audioadvanceddistributedcomponent.h index 447968c25..5cbfd2cb6 100644 --- a/src/blackgui/components/audioadvanceddistributedcomponent.h +++ b/src/blackgui/components/audioadvanceddistributedcomponent.h @@ -45,7 +45,8 @@ namespace BlackGui //! Audio enable/disable void toggleAudioEnableDisable(); - //! Start/stop button @{ + //! Start/stop button + //! @{ void setButtons(); void setButtons(int delayMs); //! @} diff --git a/src/blackgui/components/audiodevicevolumesetupcomponent.h b/src/blackgui/components/audiodevicevolumesetupcomponent.h index 9394af0a0..25d450322 100644 --- a/src/blackgui/components/audiodevicevolumesetupcomponent.h +++ b/src/blackgui/components/audiodevicevolumesetupcomponent.h @@ -42,17 +42,20 @@ namespace BlackGui //! Destructor virtual ~CAudioDeviceVolumeSetupComponent() override; - //! Get input and output volume values @{ + //! Get input and output volume values + //! @{ int getInValue(int from = BlackMisc::Audio::CSettings::InMin, int to = BlackMisc::Audio::CSettings::InMax) const; int getOutValue(int from = BlackMisc::Audio::CSettings::OutMin, int to = BlackMisc::Audio::CSettings::OutMax) const; //! @} - //! Set input and output volume values @{ + //! Set input and output volume values + //! @{ void setInValue(int value, int from = BlackMisc::Audio::CSettings::InMin, int to = BlackMisc::Audio::CSettings::InMax); void setOutValue(int value, int from = BlackMisc::Audio::CSettings::OutMin, int to = BlackMisc::Audio::CSettings::OutMax); //! @} - //! Set input and output level values 0..1 @{ + //! Set input and output level values 0..1 + //! @{ void setInLevel(double value); void setOutLevel(double value); //! @} @@ -127,7 +130,8 @@ namespace BlackGui BlackMisc::Audio::CAudioDeviceInfo getSelectedInputDevice() const; BlackMisc::Audio::CAudioDeviceInfo getSelectedOutputDevice() const; - //! Transmit and receive state @{ + //! Transmit and receive state + //! @{ void setTransmitReceiveInUi(bool tx1, bool rec1, bool tx2, bool rec2, bool integrated); void setTransmitReceiveInUiFromVoiceClient(); //! @} diff --git a/src/blackgui/components/cgsourceselector.h b/src/blackgui/components/cgsourceselector.h index 716c0b111..368f0a93d 100644 --- a/src/blackgui/components/cgsourceselector.h +++ b/src/blackgui/components/cgsourceselector.h @@ -32,7 +32,8 @@ namespace BlackGui //! Dtor virtual ~CCGSourceSelector() override; - //! Get/set value @{ + //! Get/set value + //! @{ BlackMisc::Simulation::Settings::CSimulatorSettings::CGSource getValue() const; void setValue(const BlackMisc::Simulation::Settings::CSimulatorSettings &settings); void setValue(BlackMisc::Simulation::Settings::CSimulatorSettings::CGSource source); diff --git a/src/blackgui/components/cockpitcomcomponent.h b/src/blackgui/components/cockpitcomcomponent.h index 094ec38d6..ee7ae372d 100644 --- a/src/blackgui/components/cockpitcomcomponent.h +++ b/src/blackgui/components/cockpitcomcomponent.h @@ -57,7 +57,8 @@ namespace BlackGui //! \copydoc BlackGui::Components::CTransponderModeSelector::transponderStateIdentEnded void transponderStateIdentEnded(); - //! Request COM text messages @{ + //! Request COM text messages + //! @{ void requestCom1TextMessage(); void requestCom2TextMessage(); //! @} diff --git a/src/blackgui/components/cockpitcomponent.h b/src/blackgui/components/cockpitcomponent.h index 28b8ce88f..899c6abb3 100644 --- a/src/blackgui/components/cockpitcomponent.h +++ b/src/blackgui/components/cockpitcomponent.h @@ -64,7 +64,8 @@ namespace BlackGui //! Toggle area on show/hide details void toggleShowHideDetails(bool show, bool considerCurrentSize); - //! Request text message COM1 @{ + //! Request text message COM1 + //! @{ void onRequestTextMessageCom1(); void onRequestTextMessageCom2(); //! @} diff --git a/src/blackgui/components/dbmappingcomponentaware.h b/src/blackgui/components/dbmappingcomponentaware.h index e7bf92602..2b319f48b 100644 --- a/src/blackgui/components/dbmappingcomponentaware.h +++ b/src/blackgui/components/dbmappingcomponentaware.h @@ -44,7 +44,8 @@ namespace BlackGui //! Copy assignment operator CDbMappingComponentAware &operator =(const CDbMappingComponentAware &) = default; - //! Overlay messages @{ + //! Overlay messages + //! @{ bool showMappingComponentOverlayMessage(const BlackMisc::CStatusMessage &message, int timeoutMs = -1); bool showMappingComponentOverlayHtmlMessage(const BlackMisc::CStatusMessage &message, int timeoutMs = -1); //! @} diff --git a/src/blackgui/components/networkdetailscomponent.h b/src/blackgui/components/networkdetailscomponent.h index 539143ed6..5012cddd7 100644 --- a/src/blackgui/components/networkdetailscomponent.h +++ b/src/blackgui/components/networkdetailscomponent.h @@ -87,7 +87,8 @@ namespace BlackGui //! Reset state void resetState(); - //! Selected server @{ + //! Selected server + //! @{ bool isVatsimServerSelected() const; bool isOtherServerSelected() const; //! @} diff --git a/src/blackgui/components/settingstextmessagestyle.h b/src/blackgui/components/settingstextmessagestyle.h index 766707b4e..a77189dd7 100644 --- a/src/blackgui/components/settingstextmessagestyle.h +++ b/src/blackgui/components/settingstextmessagestyle.h @@ -44,7 +44,8 @@ namespace BlackGui //! Style void setStyle(const QString &style) { m_style = style; } - //! Font size @{ + //! Font size + //! @{ void fontSizeMinus(); void fontSizePlus(); //! @} diff --git a/src/blackgui/components/textmessagecomponent.h b/src/blackgui/components/textmessagecomponent.h index bc881d1c5..8359c914e 100644 --- a/src/blackgui/components/textmessagecomponent.h +++ b/src/blackgui/components/textmessagecomponent.h @@ -55,7 +55,8 @@ namespace BlackGui //! \remark takes the messages, turns it into a ".msg" command, and emits it bool handleGlobalCommandLineText(const QString &commandLine, const BlackMisc::CIdentifier &originator); - //! Font size @{ + //! Font size + //! @{ void fontSizeMinus(); void fontSizePlus(); //! @} @@ -167,7 +168,8 @@ namespace BlackGui //! Network connected? bool isNetworkConnected() const; - //! Show current frequencies @{ + //! Show current frequencies + //! @{ void showCurrentFrequenciesFromCockpit(); void showCurrentFrequenciesFromCockpit(const BlackMisc::Simulation::CSimulatedAircraft &ownAircraft); //! @} diff --git a/src/blackgui/dockwidget.h b/src/blackgui/dockwidget.h index d68f814f8..7530614a6 100644 --- a/src/blackgui/dockwidget.h +++ b/src/blackgui/dockwidget.h @@ -151,7 +151,8 @@ namespace BlackGui //! Top level has changed for given widget void widgetTopLevelChanged(CDockWidget *, bool topLevel); - //! Font size signals @{ + //! Font size signals + //! @{ void fontSizePlus(); void fontSizeMinus(); //! @} diff --git a/src/blackgui/editors/cockpitcomform.h b/src/blackgui/editors/cockpitcomform.h index 7a378f4ee..0d7d4e689 100644 --- a/src/blackgui/editors/cockpitcomform.h +++ b/src/blackgui/editors/cockpitcomform.h @@ -81,7 +81,8 @@ namespace BlackGui //! GUI values changed void changedCockpitValues(const BlackMisc::Simulation::CSimulatedAircraft &aircraft); - //! Request COM text messages @{ + //! Request COM text messages + //! @{ void requestCom1TextMessage(); void requestCom2TextMessage(); //! @} diff --git a/src/blackgui/editors/matchingform.h b/src/blackgui/editors/matchingform.h index 985ca5ee7..d3b6720e2 100644 --- a/src/blackgui/editors/matchingform.h +++ b/src/blackgui/editors/matchingform.h @@ -71,10 +71,11 @@ namespace BlackGui //! Airline group changed void onAirlineGroupChanged(); - //! Reset @{ + //! Reset + //! @{ void resetByAlgorithm(); void resetAll(); - //! } + //! @} //! Directory browser void fileDialog(); diff --git a/src/blackgui/editors/ownmodelsetform.h b/src/blackgui/editors/ownmodelsetform.h index 066ea9add..9bc779b2b 100644 --- a/src/blackgui/editors/ownmodelsetform.h +++ b/src/blackgui/editors/ownmodelsetform.h @@ -81,9 +81,9 @@ namespace BlackGui bool hasDistributorPreferences() const; //! \name Form functions, here not used - //! \@{ + //! @{ virtual void setReadOnly(bool readOnly) override { Q_UNUSED(readOnly); } - //! \@} + //! @} signals: //! Simulator changed diff --git a/src/blackgui/editors/pbhsform.h b/src/blackgui/editors/pbhsform.h index 2b01adec2..8eb64b935 100644 --- a/src/blackgui/editors/pbhsform.h +++ b/src/blackgui/editors/pbhsform.h @@ -88,7 +88,8 @@ namespace BlackGui //! Get heading angle double getHeadingAngleDegrees() const; - //! Values changed from UI @{ + //! Values changed from UI + //! @{ void bankSliderChanged(int value); void pitchSliderChanged(int value); void headingSliderChanged(int value); diff --git a/src/blackgui/editors/situationform.h b/src/blackgui/editors/situationform.h index 2c32af801..d5736b90c 100644 --- a/src/blackgui/editors/situationform.h +++ b/src/blackgui/editors/situationform.h @@ -86,7 +86,8 @@ namespace BlackGui //! Get pressure at mean sea level double getBarometricPressureMslMillibar() const; - //! Values changed from UI @{ + //! Values changed from UI + //! @{ void bankSliderChanged(int value); void pitchSliderChanged(int value); void headingSliderChanged(int value); diff --git a/src/blackgui/guiapplication.h b/src/blackgui/guiapplication.h index c777f95df..e404e5a9c 100644 --- a/src/blackgui/guiapplication.h +++ b/src/blackgui/guiapplication.h @@ -155,7 +155,8 @@ namespace BlackGui //! Add a splash screen based on resource, empty means remove splash screen void splashScreen(const QPixmap &pixmap); - //! Display splash screen messages if screen is available and visible @{ + //! Display splash screen messages if screen is available and visible + //! @{ void displaySplashMessage(const BlackMisc::CStatusMessage &msg); void displaySplashMessages(const BlackMisc::CStatusMessageList &msgs); //! @} @@ -244,7 +245,8 @@ namespace BlackGui //! Toggle stay on top bool toggleStayOnTop(); - //! Window to front/back @{ + //! Window to front/back + //! @{ void windowToFront(); void windowToBack(); void windowToFrontBackToggle(); diff --git a/src/blackgui/guiutility.h b/src/blackgui/guiutility.h index 2e65d5cae..b7fdaee1c 100644 --- a/src/blackgui/guiutility.h +++ b/src/blackgui/guiutility.h @@ -85,7 +85,8 @@ namespace BlackGui //! Orientation as string static const QString &orientationAsString(Qt::ScreenOrientation orientation); - //! QRect, QSize as string @{ + //! QRect, QSize as string + //! @{ static const QString rectAsString(const QRect &rect); static const QString rectAsString(const QRectF &rect); static const QString sizeAsString(const QSize &size); @@ -215,7 +216,8 @@ namespace BlackGui //! Is top level window? static bool isTopLevelWindow(QWidget *widget); - //! Check window type @{ + //! Check window type + //! @{ static bool isQMainWindow(const QWidget *widget); static bool isDialog(const QWidget *widget); //! @} diff --git a/src/blackgui/levelmeter.h b/src/blackgui/levelmeter.h index adb54e899..4e658c765 100644 --- a/src/blackgui/levelmeter.h +++ b/src/blackgui/levelmeter.h @@ -31,7 +31,8 @@ namespace BlackGui { Q_OBJECT - //! Properties @{ + //! 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) @@ -53,7 +54,8 @@ namespace BlackGui //! Values void levelChanged(double level); - //! Color properties @{ + //! Color properties + //! @{ const QColor &getLowColor() const { return m_lowColor; } const QColor &getHighColor() const { return m_highColor; } const QColor &getPeakColor() const { return m_peakColor; } diff --git a/src/blackgui/menus/fontmenus.h b/src/blackgui/menus/fontmenus.h index cbcf2a153..13e3b3c06 100644 --- a/src/blackgui/menus/fontmenus.h +++ b/src/blackgui/menus/fontmenus.h @@ -47,7 +47,8 @@ namespace BlackGui QList getShortcuts() const; signals: - //! Font size signals @{ + //! Font size signals + //! @{ void fontSizePlus(); void fontSizeMinus(); //! @} diff --git a/src/blackgui/menus/menuaction.h b/src/blackgui/menus/menuaction.h index c65b6521d..4af1310c0 100644 --- a/src/blackgui/menus/menuaction.h +++ b/src/blackgui/menus/menuaction.h @@ -218,7 +218,7 @@ namespace BlackGui static const QString &pathDockWidgetNested() { static const QString p("DockWidget.Nested"); return p; } //! @} - //! \name Predefined sub sub menus + //! Predefined sub sub menus //! @{ static const CMenuAction &subMenuDatabase(); static const CMenuAction &subMenuSimulator(); diff --git a/src/blackgui/models/columnformatters.h b/src/blackgui/models/columnformatters.h index e31f96d17..01974d88c 100644 --- a/src/blackgui/models/columnformatters.h +++ b/src/blackgui/models/columnformatters.h @@ -145,7 +145,8 @@ namespace BlackGui //! \copydoc CDefaultFormatter::decorationRole virtual BlackMisc::CVariant decorationRole(const BlackMisc::CVariant &dataCVariant) const override; - //! Width/height @{ + //! Width/height + //! @{ int getMaxWidth() const { return m_maxWidth; } int getMaxHeight() const { return m_maxHeight; } void setMaxWidth(int w) { m_maxWidth = w; } diff --git a/src/blackgui/models/columns.h b/src/blackgui/models/columns.h index 910adc90d..c7700a2ec 100644 --- a/src/blackgui/models/columns.h +++ b/src/blackgui/models/columns.h @@ -219,7 +219,8 @@ namespace BlackGui //! Clear void clear() { m_columns.clear(); } - //! Set columns @{ + //! Set columns + //! @{ void setColumns(const QList &columns) { m_columns = columns; } void setColumns(const CColumns &columns) { m_columns = columns.m_columns; } //! @} diff --git a/src/blackgui/views/atcstationtreeview.h b/src/blackgui/views/atcstationtreeview.h index f9d1c7302..4d573b2e6 100644 --- a/src/blackgui/views/atcstationtreeview.h +++ b/src/blackgui/views/atcstationtreeview.h @@ -109,7 +109,8 @@ namespace BlackGui //! Restore state void restoreState(); - //! Tune in/invoke @{ + //! Tune in/invoke + //! @{ void tuneInAtcCom1(); void tuneInAtcCom2(); void requestTextMessage(); diff --git a/src/blackgui/views/simulatedaircraftview.h b/src/blackgui/views/simulatedaircraftview.h index f80ac5f63..e7a2973c2 100644 --- a/src/blackgui/views/simulatedaircraftview.h +++ b/src/blackgui/views/simulatedaircraftview.h @@ -89,12 +89,14 @@ namespace BlackGui //! Follow in simulator void requestFollowInSimulator(); - //! Enable/disable parts @{ + //! Enable/disable parts + //! @{ void requestEnableParts(); void requestDisableParts(); //! @} - //! Enable/disable parts @{ + //! Enable/disable parts + //! @{ void request0PitchOnGround(); void requestNullPitchOnGround(); //! @} diff --git a/src/blackgui/views/viewbase.h b/src/blackgui/views/viewbase.h index 4aa7ac002..9bf8fe123 100644 --- a/src/blackgui/views/viewbase.h +++ b/src/blackgui/views/viewbase.h @@ -504,7 +504,8 @@ namespace BlackGui //! Settings have been changed void settingsChanged(); - //! \name Change selection modes @{ + //! Change selection modes + //! @{ void setMultiSelection(); void setExtendedSelection(); void setSingleSelection(); @@ -518,7 +519,8 @@ namespace BlackGui //! \remark Default implementation, can be overridden with specifi implementation virtual QString getRememberedLastJsonDirectory() const; - //! Clipboard cut/copy/paste @{ + //! Clipboard cut/copy/paste + //! @{ virtual void copy() = 0; virtual void cut() = 0; virtual void paste() = 0; diff --git a/src/blackmisc/audio/audiodeviceinfolist.h b/src/blackmisc/audio/audiodeviceinfolist.h index 3ffcf28c8..40ab7fec4 100644 --- a/src/blackmisc/audio/audiodeviceinfolist.h +++ b/src/blackmisc/audio/audiodeviceinfolist.h @@ -86,7 +86,8 @@ namespace BlackMisc //! Has same devices bool hasSameDevices(const CAudioDeviceInfoList &compareDevices) const; - //! Lists of all available devices @{ + //! Lists of all available devices + //! @{ static CAudioDeviceInfoList allInputDevices(); static CAudioDeviceInfoList allOutputDevices(); static CAudioDeviceInfoList allDevices(); diff --git a/src/blackmisc/audio/audiosettings.h b/src/blackmisc/audio/audiosettings.h index 0382c014a..8d42a2995 100644 --- a/src/blackmisc/audio/audiosettings.h +++ b/src/blackmisc/audio/audiosettings.h @@ -30,14 +30,16 @@ namespace BlackMisc class BLACKMISC_EXPORT CSettings : public CValueObject { public: - //! Ranges for audio @{ + //! Ranges for audio + //! @{ static constexpr int InMax = 100; static constexpr int InMin = 0; static constexpr int OutMax = 100; static constexpr int OutMin = 0; //! @} - //! Make sure the volume is within the range @{ + //! Make sure the volume is within the range + //! @{ static int fixOutVolume(int v); static int fixInVolume(int v); //! @} @@ -57,7 +59,8 @@ namespace BlackMisc //! Set notification void setNotification(CNotificationSounds::Notification notification) { m_notification = static_cast(notification); } - //! Simplified functions @{ + //! Simplified functions + //! @{ bool textMessagePrivate() const { return this->isNotificationFlagSet(CNotificationSounds::NotificationTextMessagePrivate); } bool textMessageSupervisor() const { return this->isNotificationFlagSet(CNotificationSounds::NotificationTextMessageSupervisor); } bool textCallsignMentioned() const { return this->isNotificationFlagSet(CNotificationSounds::NotificationTextCallsignMentioned); } diff --git a/src/blackmisc/aviation/aircraftsituation.h b/src/blackmisc/aviation/aircraftsituation.h index 1958d0db2..ab5c8080c 100644 --- a/src/blackmisc/aviation/aircraftsituation.h +++ b/src/blackmisc/aviation/aircraftsituation.h @@ -526,13 +526,15 @@ namespace BlackMisc //! A default CG if not other value is available static const PhysicalQuantities::CLength &defaultCG(); + //! Ground flag comparisons + //! @{ + //! Both on ground static bool isGfEqualOnGround(double oldGroundFactor, double newGroundFactor) { return isDoubleEpsilonEqual(1.0, oldGroundFactor) && isDoubleEpsilonEqual(1.0, newGroundFactor); } - //! Ground flag comparisons @{ //! Both not on ground static bool isGfEqualAirborne(double oldGroundFactor, double newGroundFactor) { diff --git a/src/blackmisc/aviation/altitude.h b/src/blackmisc/aviation/altitude.h index 51e2ad60e..c1b0ceae9 100644 --- a/src/blackmisc/aviation/altitude.h +++ b/src/blackmisc/aviation/altitude.h @@ -207,7 +207,8 @@ namespace BlackMisc //! \remark https://en.wikipedia.org/wiki/Flight_level CAltitude roundedToNearest100ft(bool roundDown) const; - //! Search the corresponding feet <-> metric / metric <-> feet @{ + //! Search the corresponding feet <-> metric / metric <-> feet + //! @{ static int findMetricAltitude(int feet); static int findAltitudeForMetricAltitude(int metric); //! @} diff --git a/src/blackmisc/aviation/callsign.h b/src/blackmisc/aviation/callsign.h index a0eed292d..fd293953f 100644 --- a/src/blackmisc/aviation/callsign.h +++ b/src/blackmisc/aviation/callsign.h @@ -124,11 +124,12 @@ namespace BlackMisc //! Get the callsign suffix ("TWR", "ATIS" ...) if any ("_" is removed) QString getSuffix() const; - //! Airline suffix (e.g. DLH1234 -> DLH) if applicable @{ + //! Airline suffix (e.g. DLH1234 -> DLH) if applicable + //! @{ QString getAirlinePrefix() const; QString getAirlinePrefix(QString &flightNumber) const; QString getAirlinePrefix(QString &flightNumber, QString &flightIdentification) const; - // @} + //! @} //! Flight number (e.g. DLH1234 -> 1234) if applicable QString getFlightIndentification() const; diff --git a/src/blackmisc/geo/coordinategeodetic.h b/src/blackmisc/geo/coordinategeodetic.h index 4cd14182c..17cd22b46 100644 --- a/src/blackmisc/geo/coordinategeodetic.h +++ b/src/blackmisc/geo/coordinategeodetic.h @@ -136,7 +136,8 @@ namespace BlackMisc //! \copydoc Mixin::String::toQString QString convertToQString(bool i18n = false) const; - //! Check values @{ + //! Check values + //! @{ bool isNaNVector() const; bool isNaNVectorDouble() const; bool isInfVector() const; diff --git a/src/blackmisc/geo/kmlutils.h b/src/blackmisc/geo/kmlutils.h index 792a65b4f..cf2e58cb5 100644 --- a/src/blackmisc/geo/kmlutils.h +++ b/src/blackmisc/geo/kmlutils.h @@ -36,7 +36,8 @@ namespace BlackMisc withAltitude(withAltitude), extrude(extrude) { } - //! Setting members @{ + //! Setting members + //! @{ bool withAltitude = true; bool extrude = false; bool tessellate = true; diff --git a/src/blackmisc/icons.h b/src/blackmisc/icons.h index 038016571..3d26a7fd0 100644 --- a/src/blackmisc/icons.h +++ b/src/blackmisc/icons.h @@ -499,27 +499,32 @@ namespace BlackMisc // -- Simulators // -------------------------------------------------- - //! Simulator FSX @{ + //! Simulator FSX + //! @{ static const QPixmap &simulatorFSX(); static const QPixmap &simulatorFSX16(); //! @} - //! Simulator P3D @{ + //! Simulator P3D + //! @{ static const QPixmap &simulatorP3D(); static const QPixmap &simulatorP3D16(); //! @} - //! Simulator FS9 @{ + //! Simulator FS9 + //! @{ static const QPixmap &simulatorFS9(); static const QPixmap &simulatorFS916(); //! @} - //! Simulator FG @{ + //! Simulator FG + //! @{ static const QPixmap &simulatorFG(); static const QPixmap &simulatorFG16(); //! @} - //! Simulator XPlane @{ + //! Simulator XPlane + //! @{ static const QPixmap &simulatorXPlane(); static const QPixmap &simulatorXPlane16(); //! @} diff --git a/src/blackmisc/math/mathutils.h b/src/blackmisc/math/mathutils.h index ef04ac5a3..33d48350a 100644 --- a/src/blackmisc/math/mathutils.h +++ b/src/blackmisc/math/mathutils.h @@ -57,13 +57,15 @@ namespace BlackMisc //! Round by given epsilon static double roundEpsilon(double value, double epsilon); - //! Epsilon safe equal @{ + //! Epsilon safe equal + //! @{ static bool epsilonEqual(float v1, float v2, float epsilon = 1E-06f); static bool epsilonEqual(double v1, double v2, double epsilon = 1E-06); static bool epsilonEqualLimits(double v1, double v2) { return qAbs(v1 - v2) <= std::numeric_limits::epsilon(); } //! @} - //! Epsilon safe zero @{ + //! Epsilon safe zero + //! @{ static bool epsilonZero(double v, double epsilon) { return epsilonEqual(v, 0.0, epsilon); } static bool epsilonZero(double v) { return epsilonEqual(v, 0.0, 1E-06); } static inline bool epsilonZeroLimits(double v) { return qAbs(v) <= std::numeric_limits::epsilon(); } diff --git a/src/blackmisc/network/fsdsetup.h b/src/blackmisc/network/fsdsetup.h index e505d3955..859938d5b 100644 --- a/src/blackmisc/network/fsdsetup.h +++ b/src/blackmisc/network/fsdsetup.h @@ -106,7 +106,8 @@ namespace BlackMisc bool receiveInterimPositions() const { return this->getSendReceiveDetails().testFlag(ReceiveInterimPositions); } //! @} - //! Airline codes @{ + //! Airline codes + //! @{ bool force3LetterAirlineCodes() const { return this->getSendReceiveDetails().testFlag(Force3LetterAirlineICAO); } void setForce3LetterAirlineCodes(bool force); //! @} diff --git a/src/blackmisc/pq/physicalquantity.h b/src/blackmisc/pq/physicalquantity.h index ebcc04401..2a651f80b 100644 --- a/src/blackmisc/pq/physicalquantity.h +++ b/src/blackmisc/pq/physicalquantity.h @@ -104,15 +104,17 @@ namespace BlackMisc //! Set value in current unit void setCurrentUnitValue(double value); - //! As integer value @{ + //! As integer value + //! @{ int valueInteger(MU unit) const; QString valueIntegerAsString(MU unit) const { return QString::number(this->valueInteger(unit)); } - // @} + //! @} - //! As integer value in current unit @{ + //! As integer value in current unit + //! @{ int valueInteger() const; QString valueIntegerAsString() const { return QString::number(this->valueInteger()); } - // @} + //! @} //! Is value an integer bool isInteger() const; diff --git a/src/blackmisc/simulation/aircraftmatchersetup.h b/src/blackmisc/simulation/aircraftmatchersetup.h index 2a6a5a185..fbfd5cabd 100644 --- a/src/blackmisc/simulation/aircraftmatchersetup.h +++ b/src/blackmisc/simulation/aircraftmatchersetup.h @@ -148,7 +148,8 @@ namespace BlackMisc //! Force mode as string QString getForceModeAsString() const { return forceToString(this->getForceMode()); } - //! Reverse lookup @{ + //! Reverse lookup + //! @{ bool isReverseLookupModelString() const; bool isReverseLookupSwiftLiveryIds() const; void resetReverseLookup(); @@ -157,27 +158,32 @@ namespace BlackMisc //! DB data? bool isDbDataOnly() const { return this->getMatchingMode().testFlag(ExcludeNoDbData); } - //! Get matching files @{ + //! Get matching files + //! @{ const QString &getMsReverseLookupFile() const { return m_msReverseLookupFile; } const QString &getMsMatchingStageFile() const { return m_msMatchingStageFile; } //! @} - //! Set matching files @{ + //! Set matching files + //! @{ void setMsReverseLookupFile(const QString &file) { m_msReverseLookupFile = file; } void setMsMatchingStageFile(const QString &file) { m_msMatchingStageFile = file; } //! @} - //! Is matching script enabled @{ + //! Is matching script enabled + //! @{ bool isMsReverseLookupEnabled() const { return m_msReverseEnabled; } bool isMsMatchingStageEnabled() const { return m_msMatchingEnabled; } //! @} - //! Run the scripts @{ + //! Run the scripts + //! @{ bool doRunMsReverseLookupScript() const; bool doRunMsMatchingStageScript() const; //! @} - //! Is matching script enabled @{ + //! Is matching script enabled + //! @{ void setMsReverseLookupEnabled(bool enabled) { m_msReverseEnabled = enabled; } void setMsMatchingStageEnabled(bool enabled) { m_msMatchingEnabled = enabled; } //! @} diff --git a/src/blackmisc/simulation/aircraftmodelinterfaces.h b/src/blackmisc/simulation/aircraftmodelinterfaces.h index 2b033af02..bcfeba270 100644 --- a/src/blackmisc/simulation/aircraftmodelinterfaces.h +++ b/src/blackmisc/simulation/aircraftmodelinterfaces.h @@ -25,7 +25,8 @@ namespace BlackMisc //! Set models virtual void setModels(const CAircraftModelList &models) = 0; - //! Ctor, dtor, copy operators (CLANG warnings) @{ + //! Ctor, dtor, copy operators (CLANG warnings) + //! @{ IModelsSetable() {} virtual ~IModelsSetable() {} IModelsSetable(const IModelsSetable &) = default; @@ -40,7 +41,8 @@ namespace BlackMisc //! Update models virtual int updateModels(const CAircraftModelList &models) = 0; - //! Ctor, dtor, copy operators (CLANG warnings) @{ + //! Ctor, dtor, copy operators (CLANG warnings) + //! @{ IModelsUpdatable() {} virtual ~IModelsUpdatable() {} IModelsUpdatable(const IModelsUpdatable &) = default; @@ -55,7 +57,8 @@ namespace BlackMisc //! Set models virtual void setModelsForSimulator(const CAircraftModelList &models, const CSimulatorInfo &simulator) = 0; - //! Ctor, dtor, copy operators (CLANG warnings) @{ + //! Ctor, dtor, copy operators (CLANG warnings) + //! @{ IModelsForSimulatorSetable() {} virtual ~IModelsForSimulatorSetable() {} IModelsForSimulatorSetable(const IModelsForSimulatorSetable &) = default; @@ -70,7 +73,8 @@ namespace BlackMisc //! Set models virtual int updateModelsForSimulator(const CAircraftModelList &models, const CSimulatorInfo &simulator) = 0; - //! Ctor, dtor, copy operators (CLANG warnings) @{ + //! Ctor, dtor, copy operators (CLANG warnings) + //! @{ IModelsForSimulatorUpdatable() {} virtual ~IModelsForSimulatorUpdatable() {} IModelsForSimulatorUpdatable(const IModelsForSimulatorUpdatable &) = default; @@ -85,7 +89,8 @@ namespace BlackMisc //! Simulator virtual BlackMisc::Simulation::CSimulatorInfo getSelectedSimulator() const = 0; - //! Ctor, dtor, copy operators (CLANG warnings) @{ + //! Ctor, dtor, copy operators (CLANG warnings) + //! @{ ISimulatorSelectable() {} virtual ~ISimulatorSelectable() {} ISimulatorSelectable(const ISimulatorSelectable &) = default; diff --git a/src/blackmisc/simulation/aircraftmodellist.h b/src/blackmisc/simulation/aircraftmodellist.h index b2a90e7f3..78caee5df 100644 --- a/src/blackmisc/simulation/aircraftmodellist.h +++ b/src/blackmisc/simulation/aircraftmodellist.h @@ -220,7 +220,8 @@ namespace BlackMisc //! Find color liveries CAircraftModelList findColorLiveries() const; - //! Find models with the closest color distance @{ + //! Find models with the closest color distance + //! @{ CAircraftModelList findClosestColorDistance(const CRgbColor &fuselage, const CRgbColor &tail) const; CAircraftModelList findClosestFuselageColorDistance(const CRgbColor &color) const; //! @} @@ -264,19 +265,22 @@ namespace BlackMisc //! All models NOT of the FS (FSX, P3D, FS9) family CAircraftModelList findNonFsFamilyModels() const; - //! With/without DB key @{ + //! With/without DB key + //! @{ CAircraftModelList findWithValidDbKey() const; CAircraftModelList findWithoutValidDbKey() const; CAircraftModelList findWithoutValidDbKey(int maxElements) const; //! @} - //! Some finders for NON DB models, mostly for matching script results @{ + //! Some finders for NON DB models, mostly for matching script results + //! @{ CAircraftModelList findNonDbModelsForAirline(const QString &airline) const; CAircraftModelList findNonDbModelsForAircraft(const QString &airline) const; CAircraftModelList findNonDbModelsForModelString(const QString &modelString) const; //! @} - //! All included/excluded models @{ + //! All included/excluded models + //! @{ CAircraftModelList findAllIncludedModels() const; CAircraftModelList findAllIncludedModels(int maxElements) const; CAircraftModelList findAllExcludedModels() const; @@ -541,14 +545,16 @@ namespace BlackMisc //! A HTML summary of the data in the list QString htmlStatistics(bool aircraftStats, bool airlineStats) const; - //! Save/load invalid models @{ + //! Save/load invalid models + //! @{ CStatusMessage saveInvalidModels() const; CStatusMessage loadInvalidModels(); static const QString &invalidModelFileAndPath(); static bool hasInvalidModelFile(); //! @} - //! Add as valid or invalid model (mutual exclusive) @{ + //! Add as valid or invalid model (mutual exclusive) + //! @{ static void addAsValidOrInvalidModel(const CAircraftModel &model, bool valid, CAircraftModelList &validModels, CAircraftModelList &invalidModels); static void addAsValidOrInvalidModels(const CAircraftModelList &models, bool valid, CAircraftModelList &validModels, CAircraftModelList &invalidModels); //! @} diff --git a/src/blackmisc/simulation/aircraftmodelloader.h b/src/blackmisc/simulation/aircraftmodelloader.h index 97c3b6b20..e4dc79ac3 100644 --- a/src/blackmisc/simulation/aircraftmodelloader.h +++ b/src/blackmisc/simulation/aircraftmodelloader.h @@ -127,7 +127,8 @@ namespace BlackMisc //! Supported simulator bool supportsSimulator(const CSimulatorInfo &simulator) const { return m_simulator == simulator; } - //! Interface implementations @{ + //! Interface implementations + //! @{ virtual void setModels(const CAircraftModelList &models) override; virtual int updateModels(const CAircraftModelList &models) override; //! @} @@ -221,7 +222,8 @@ namespace BlackMisc //! Singleton static CMultiAircraftModelLoaderProvider &multiModelLoaderInstance(); - //! Simulator specific loaders @{ + //! Simulator specific loaders + //! @{ IAircraftModelLoader *modelLoaderFsx() const { return m_loaderFsx; } IAircraftModelLoader *modelLoaderP3D() const { return m_loaderP3D; } IAircraftModelLoader *modelLoaderXP() const { return m_loaderXP; } diff --git a/src/blackmisc/simulation/autopublishdata.h b/src/blackmisc/simulation/autopublishdata.h index 77d74b8b8..a87358470 100644 --- a/src/blackmisc/simulation/autopublishdata.h +++ b/src/blackmisc/simulation/autopublishdata.h @@ -63,7 +63,8 @@ namespace BlackMisc class BLACKMISC_EXPORT CAutoPublishData { public: - //! Insert values we might want to update in the DB @{ + //! Insert values we might want to update in the DB + //! @{ void insert(const QString &modelString, const PhysicalQuantities::CLength &cg); void insert(const QString &modelString, const CSimulatorInfo &simulator); //! @} @@ -80,7 +81,8 @@ namespace BlackMisc //! Read from database JSON int fromDatabaseJson(const QString &jsonData, bool clear = true); - //! Write to file @{ + //! Write to file + //! @{ bool writeJsonToFile() const; bool writeJsonToFile(const QString &pathAndFile) const; //! @} diff --git a/src/blackmisc/simulation/categorymatcher.h b/src/blackmisc/simulation/categorymatcher.h index 3a49ae86f..8a47f768e 100644 --- a/src/blackmisc/simulation/categorymatcher.h +++ b/src/blackmisc/simulation/categorymatcher.h @@ -37,7 +37,8 @@ namespace BlackMisc //! Used categories void setCategories(const Aviation::CAircraftCategoryList &categories); - //! Specialized categories @{ + //! Specialized categories + //! @{ const Aviation::CAircraftCategoryList &gliderCategories() const { return m_gliders; } const Aviation::CAircraftCategoryList &militaryWingCategories() const { return m_militaryWingAircraft; } const Aviation::CAircraftCategoryList &militaryRotorCategories() const { return m_militaryRotorAircraft; } diff --git a/src/blackmisc/simulation/data/modelcaches.h b/src/blackmisc/simulation/data/modelcaches.h index 6dbd6c77c..9e1641e4b 100644 --- a/src/blackmisc/simulation/data/modelcaches.h +++ b/src/blackmisc/simulation/data/modelcaches.h @@ -283,7 +283,8 @@ namespace BlackMisc IMultiSimulatorModelCaches(QObject *parent = nullptr) : QObject(parent) { } - //! \name Cache has been changed. This will only detect changes elsewhere, owned caches will not signal local changes @{ + //! Cache has been changed. This will only detect changes elsewhere, owned caches will not signal local changes + //! @{ void changedFsx() { this->emitCacheChanged(CSimulatorInfo::fsx()); } void changedFs9() { this->emitCacheChanged(CSimulatorInfo::fs9()); } void changedP3D() { this->emitCacheChanged(CSimulatorInfo::p3d()); } @@ -298,7 +299,8 @@ namespace BlackMisc //! Emit cacheChanged() utility function (allows breakpoint) void emitCacheChanged(const CSimulatorInfo &simulator); - //! Cache synchronized flag @{ + //! Cache synchronized flag + //! @{ std::atomic_bool m_syncFsx { false }; std::atomic_bool m_syncP3D { false }; std::atomic_bool m_syncFS9 { false }; @@ -456,7 +458,7 @@ namespace BlackMisc public IModelsForSimulatorUpdatable { public: - //! \name Look like IMultiSimulatorModelCaches interface + //! Look like IMultiSimulatorModelCaches interface //! @{ CAircraftModelList getCachedModels(const CSimulatorInfo &simulator) const { return CCentralMultiSimulatorModelCachesProvider::modelCachesInstance().getCachedModels(simulator); } int getCachedModelsCount(const CSimulatorInfo &simulator) const { return CCentralMultiSimulatorModelCachesProvider::modelCachesInstance().getCachedModelsCount(simulator); } @@ -509,7 +511,7 @@ namespace BlackMisc public IModelsForSimulatorUpdatable { public: - //! \name Look like IMultiSimulatorModelCaches interface + //! Look like IMultiSimulatorModelCaches interface //! @{ CAircraftModelList getCachedModels(const CSimulatorInfo &simulator) const { return CCentralMultiSimulatorModelSetCachesProvider::modelCachesInstance().getCachedModels(simulator); } int getCachedModelsCount(const CSimulatorInfo &simulator) const { return CCentralMultiSimulatorModelSetCachesProvider::modelCachesInstance().getCachedModelsCount(simulator); } diff --git a/src/blackmisc/simulation/distributor.h b/src/blackmisc/simulation/distributor.h index 393952118..fafb0273b 100644 --- a/src/blackmisc/simulation/distributor.h +++ b/src/blackmisc/simulation/distributor.h @@ -125,7 +125,8 @@ namespace BlackMisc //! Object from JSON static CDistributor fromDatabaseJson(const QJsonObject &json, const QString &prefix = QString()); - //! Hardcoded keys for standard models @{ + //! Hardcoded keys for standard models + //! @{ static const QString &standardFSX(); static const QString &standardP3D(); static const QString &standardFS9(); diff --git a/src/blackmisc/simulation/fscommon/fscommonutil.h b/src/blackmisc/simulation/fscommon/fscommonutil.h index eaade2eca..1dc01fa0a 100644 --- a/src/blackmisc/simulation/fscommon/fscommonutil.h +++ b/src/blackmisc/simulation/fscommon/fscommonutil.h @@ -157,7 +157,8 @@ namespace BlackMisc static const QString airFileFilter(); private: - //! Utility functions @{ + //! Utility functions + //! @{ static QSet findP3dConfigFiles(const QString &configFile, const QString &versionHint = "v5"); //! @} diff --git a/src/blackmisc/simulation/interpolator.h b/src/blackmisc/simulation/interpolator.h index 9762c7b37..3b25f5aab 100644 --- a/src/blackmisc/simulation/interpolator.h +++ b/src/blackmisc/simulation/interpolator.h @@ -165,7 +165,8 @@ namespace BlackMisc //! Reset values void reset(); - //! Implicit conversion @{ + //! Implicit conversion + //! @{ operator const Aviation::CAircraftSituation &() const { return m_interpolatedSituation; } operator const Aviation::CAircraftParts &() const { return m_interpolatedParts; } //! @} @@ -324,7 +325,8 @@ namespace BlackMisc //! Return NULL parts and log const BlackMisc::Aviation::CAircraftParts &logAndReturnNullParts(const QString &info, bool log); - //! Derived class @{ + //! Derived class + //! @{ Derived *derived() { return static_cast(this); } const Derived *derived() const { return static_cast(this); } //! @} diff --git a/src/blackmisc/simulation/interpolatorspline.h b/src/blackmisc/simulation/interpolatorspline.h index 6c883e1e9..adb04ee72 100644 --- a/src/blackmisc/simulation/interpolatorspline.h +++ b/src/blackmisc/simulation/interpolatorspline.h @@ -44,7 +44,8 @@ namespace BlackMisc //! Zero initialized position array static const PosArray &zeroPosArray(); - //! 3 coordinates for spline interpolation @{ + //! 3 coordinates for spline interpolation + //! @{ std::array x, y, z, a, gnd, t, dx, dy, dz, da, dgnd; //! Array size diff --git a/src/blackmisc/simulation/matchingscript.h b/src/blackmisc/simulation/matchingscript.h index 84c570a2f..f6bf41165 100644 --- a/src/blackmisc/simulation/matchingscript.h +++ b/src/blackmisc/simulation/matchingscript.h @@ -29,7 +29,8 @@ namespace BlackMisc { Q_OBJECT - //! MSNetworkValues properties @{ + //! MSNetworkValues properties + //! @{ Q_PROPERTY(QString callsign READ getCallsign WRITE setCallsign NOTIFY callsignChanged) Q_PROPERTY(QString callsignAsSet READ getCallsignAsSet) Q_PROPERTY(QString flightNumber READ getFlightNumber) @@ -94,14 +95,16 @@ namespace BlackMisc //! Ctor MSInOutValues(const MSInOutValues &sv); - //! Callsign values @{ + //! Callsign values + //! @{ const QString &getCallsign() const { return m_callsign; } const QString &getCallsignAsSet() const { return m_callsignAsSet; } const QString &getFlightNumber() const { return m_flightNumber; } void setCallsign(const QString &callsign); //! @} - //! Values found in DB? @{ + //! Values found in DB? + //! @{ bool isFoundDbAircraftIcao() const { return m_dbAircraftIcaoId >= 0; } bool isFoundDbAirlineIcao() const { return m_dbAirlineIcaoId >= 0; } bool isFoundDbLivery() const { return m_dbLiveryId >= 0; } @@ -116,7 +119,8 @@ namespace BlackMisc void setDbModelId(int id); //! @} - //! Livery, airline, aircraft, model string @{ + //! Livery, airline, aircraft, model string + //! @{ const QString &getAircraftIcao() const { return m_aircraftIcao; } const QString &getAircraftFamily() const { return m_aircraftFamily; } const QString &getAirlineIcao() const { return m_airlineIcao; } @@ -135,17 +139,20 @@ namespace BlackMisc bool hasAircraftFamily() const { return !m_aircraftFamily.isEmpty(); } //! @} - //! Log. message @{ + //! Log. message + //! @{ const QString &getLogMessage() const { return m_logMessage; } void setLogMessage(const QString &msg); //! @} - //! Modified flag @{ + //! Modified flag + //! @{ bool isModified() const { return m_modified; } void setModified(bool modified); //! @} - //! Request re-run @{ + //! Request re-run + //! @{ bool isRerun() const { return m_rerun; } void setRerun(bool rerun); //! @} @@ -153,7 +160,8 @@ namespace BlackMisc //! Changed values such as modified values void evaluateChanges(const BlackMisc::Aviation::CAircraftIcaoCode &aircraft, const BlackMisc::Aviation::CAirlineIcaoCode &airline); - //! Changed values @{ + //! Changed values + //! @{ bool hasModifiedAircraftIcaoDesignator() const { return m_modifiedAircraftDesignator; } bool hasModifiedAirlineIcaoDesignator() const { return m_modifiedAirlineDesignator; } bool hasModifiedAircraftFamily() const { return m_modifiedAircraftFamily; } @@ -172,7 +180,8 @@ namespace BlackMisc //! Callsign changed void callsignChanged(); - //! Livery, airline, aircraft, or model changed @{ + //! Livery, airline, aircraft, or model changed + //! @{ void aircraftIcaoChanged(); void airlineIcaoChanged(); void virtualAirlineIcaoChanged(); @@ -181,7 +190,8 @@ namespace BlackMisc void combinedTypeChanged(); //! @} - //! DB id changed @{ + //! DB id changed + //! @{ void dbAircraftIcaoIdChanged(); void dbAirlineIcaoIdChanged(); void dbLiveryIdChanged(); @@ -225,7 +235,8 @@ namespace BlackMisc { Q_OBJECT - //! MSModelSet properties @{ + //! MSModelSet properties + //! @{ Q_PROPERTY(QString simulator READ getSimulator WRITE setSimulator NOTIFY simulatorChanged) Q_PROPERTY(bool available READ isAvailable WRITE setAvailable NOTIFY availabilityChanged) Q_PROPERTY(int inputAircraftAndAirlineCount READ getInputAircraftAndAirlineCount WRITE setInputAircraftAndAirlineCount NOTIFY inputAircraftAndAirlineCountChanged) @@ -248,17 +259,20 @@ namespace BlackMisc //! Set callsign void setSimulator(const QString &simulator); - //! Availablity flag @{ + //! Availablity flag + //! @{ bool isAvailable() const { return m_available; } void setAvailable(bool available); //! @} - //! Input aircraft/airline available flag @{ + //! Input aircraft/airline available flag + //! @{ int getInputAircraftAndAirlineCount() const { return m_inputAircraftAndAirlineCount; } void setInputAircraftAndAirlineCount(int count); //! @} - //! Model set functions as properties @{ + //! Model set functions as properties + //! @{ int getModelSetSize() const { return m_modelSet.size(); } int countDifferentAirlines() const { return m_modelSet.countDifferentAirlines(); } int countVtolAircraft() const { return m_modelSet.countVtolAircraft(); } @@ -268,7 +282,8 @@ namespace BlackMisc int countModelsWithAirlineLivery() const { return m_modelSet.countModelsWithAirlineLivery(); } //! @} - //! Invokable model set functions as properties @{ + //! Invokable model set functions as properties + //! @{ Q_INVOKABLE bool containsModelString(const QString &modelString) const { return m_modelSet.containsModelString(modelString, Qt::CaseInsensitive); } Q_INVOKABLE bool containsDbKey(int dbKey) const { return m_modelSet.containsDbKey(dbKey); } Q_INVOKABLE bool containsCombinedType(const QString &ct) const { return m_modelSet.containsCombinedType(ct); } diff --git a/src/blackmisc/simulation/remoteaircraftprovider.h b/src/blackmisc/simulation/remoteaircraftprovider.h index 22fb9631b..ab66e50d9 100644 --- a/src/blackmisc/simulation/remoteaircraftprovider.h +++ b/src/blackmisc/simulation/remoteaircraftprovider.h @@ -204,8 +204,9 @@ namespace BlackMisc //! \threadsafe virtual bool updateCGAndModelString(const Aviation::CCallsign &callsign, const PhysicalQuantities::CLength &cg, const QString &modelString) = 0; - //! CG values from DB @{ + //! CG values from DB //! \threadsafe + //! @{ virtual PhysicalQuantities::CLength getCGFromDB(const Aviation::CCallsign &callsign) const = 0; virtual PhysicalQuantities::CLength getCGFromDB(const QString &modelString) const = 0; virtual void rememberCGFromDB(const PhysicalQuantities::CLength &cgFromDB, const Aviation::CCallsign &callsign) = 0; diff --git a/src/blackmisc/simulation/settings/simulatorsettings.h b/src/blackmisc/simulation/settings/simulatorsettings.h index 44079c02c..5498b61d6 100644 --- a/src/blackmisc/simulation/settings/simulatorsettings.h +++ b/src/blackmisc/simulation/settings/simulatorsettings.h @@ -503,7 +503,8 @@ namespace BlackMisc CSetting m_simSettingsXP { this, &CMultiSimulatorSettings::onXPSettingsChanged }; //!< XP settings CSetting m_simSettingsFG { this, &CMultiSimulatorSettings::onFGSettingsChanged }; //!< FG settings - //! Settings changed, this will only detect if settings are changed elsewhere @{ + //! Settings changed, this will only detect if settings are changed elsewhere + //! @{ void onFsxSettingsChanged(); void onFs9SettingsChanged(); void onP3DSettingsChanged(); diff --git a/src/blackmisc/simulation/settings/xswiftbussettingsqtfree.h b/src/blackmisc/simulation/settings/xswiftbussettingsqtfree.h index 88609970d..f0f85d34e 100644 --- a/src/blackmisc/simulation/settings/xswiftbussettingsqtfree.h +++ b/src/blackmisc/simulation/settings/xswiftbussettingsqtfree.h @@ -160,7 +160,8 @@ namespace BlackMisc } protected: - //! The JSON members @{ + //! The JSON members + //! @{ static constexpr char JsonDBusServerAddress[] = "dbusserveradress"; static constexpr char JsonDrawingLabels[] = "drawinglabels"; static constexpr char JsonLogRenderPhases[] = "renderPhases"; diff --git a/src/blackmisc/simulation/simulatorinfo.h b/src/blackmisc/simulation/simulatorinfo.h index 1a97f8f02..66054f09b 100644 --- a/src/blackmisc/simulation/simulatorinfo.h +++ b/src/blackmisc/simulation/simulatorinfo.h @@ -202,7 +202,8 @@ namespace BlackMisc //! From database JSON static CSimulatorInfo fromDatabaseJson(const QJsonObject &json, const QString &prefix); - //! Const simulator info objects @{ + //! Const simulator info objects + //! @{ static const CSimulatorInfo &fg() { static const CSimulatorInfo s(FG); return s; } static const CSimulatorInfo &fsx() { static const CSimulatorInfo s(FSX); return s; } static const CSimulatorInfo &p3d() { static const CSimulatorInfo s(P3D); return s; } diff --git a/src/blacksound/audioutilities.h b/src/blacksound/audioutilities.h index 798b72484..03a7e2b67 100644 --- a/src/blacksound/audioutilities.h +++ b/src/blacksound/audioutilities.h @@ -20,7 +20,8 @@ namespace BlackSound { - //! Conversion functions @{ + //! Conversion functions + //! @{ BLACKSOUND_EXPORT QVector convertBytesTo32BitFloatPCM(const QByteArray &input); BLACKSOUND_EXPORT QVector convertBytesTo16BitPCM(const QByteArray &input); BLACKSOUND_EXPORT QVector convertFloatBytesTo16BitPCM(const QByteArray &input); @@ -36,7 +37,8 @@ namespace BlackSound BLACKSOUND_EXPORT const QString &toQString(QAudioFormat::SampleType s); //! @} - //! Normalize audio volume to 0..100 @{ + //! Normalize audio volume to 0..100 + //! @{ BLACKSOUND_EXPORT double normalize0to100(double in); BLACKSOUND_EXPORT qreal normalize0to100qr(double in); //! @} diff --git a/src/blacksound/codecs/opusdecoder.h b/src/blacksound/codecs/opusdecoder.h index 107c38d91..c674b61fc 100644 --- a/src/blacksound/codecs/opusdecoder.h +++ b/src/blacksound/codecs/opusdecoder.h @@ -30,7 +30,8 @@ namespace BlackSound //! Dtor ~COpusDecoder(); - //! Not copyable and assignable @{ + //! Not copyable and assignable + //! @{ COpusDecoder(const COpusDecoder &decoder) = delete; COpusDecoder& operator=(COpusDecoder const&) = delete; //! @} diff --git a/src/blacksound/dsp/SimpleComp.h b/src/blacksound/dsp/SimpleComp.h index aa350b5a0..98382a82c 100644 --- a/src/blacksound/dsp/SimpleComp.h +++ b/src/blacksound/dsp/SimpleComp.h @@ -46,13 +46,15 @@ namespace chunkware_simple //! Dtor virtual ~SimpleComp() {} - //! @{ set parameters + //! set parameters + //! @{ virtual void setThresh(double dB); virtual void setRatio(double dB); void setMakeUpGain(double gain); //! @} - //! @{ get parameters + //! get parameters + //! @{ virtual double getThresh(void) const { return threshdB_; } virtual double getRatio(void) const { return ratio_; } double getMakeUpGain(void) const { return makeUpGain_; } diff --git a/src/blacksound/dsp/SimpleEnvelope.h b/src/blacksound/dsp/SimpleEnvelope.h index 5cd514fb1..56cdb51d5 100644 --- a/src/blacksound/dsp/SimpleEnvelope.h +++ b/src/blacksound/dsp/SimpleEnvelope.h @@ -91,17 +91,20 @@ namespace chunkware_simple //! Dtor virtual ~AttRelEnvelope() {} - //! Attack time constant @{ + //! Attack time constant + //! @{ virtual void setAttack(double ms); virtual double getAttack(void) const { return att_.getTc(); } //! @} - //! Release time constant @{ + //! Release time constant + //! @{ virtual void setRelease(double ms); virtual double getRelease(void) const { return rel_.getTc(); } //! @} - //! Sample rate dependencies @{ + //! Sample rate dependencies + //! @{ virtual void setSampleRate(double sampleRate); virtual double getSampleRate(void) const { return att_.getSampleRate(); } //! @} diff --git a/src/blacksound/dsp/SimpleLimit.h b/src/blacksound/dsp/SimpleLimit.h index c82cc80cb..05c125af9 100644 --- a/src/blacksound/dsp/SimpleLimit.h +++ b/src/blacksound/dsp/SimpleLimit.h @@ -48,13 +48,15 @@ namespace chunkware_simple //! Dtor virtual ~SimpleLimit() {} - //! @{ set parameters + //! set parameters + //! @{ virtual void setThresh(double dB); virtual void setAttack(double ms) { this->setAttackImpl(ms); } // used in ctor virtual void setRelease(double ms); //! @} - //! @{ get parameters + //! get parameters + //! @{ virtual double getThresh(void) const { return threshdB_; } virtual double getAttack(void) const { return att_.getTc(); } virtual double getRelease(void) const { return rel_.getTc(); } @@ -63,7 +65,8 @@ namespace chunkware_simple //! get latency virtual unsigned int getLatency(void) const { return peakHold_; } - //! @{ sample rate + //! sample rate + //! @{ virtual void setSampleRate(double sampleRate); virtual double getSampleRate(void) { return att_.getSampleRate(); } //! @} diff --git a/src/blacksound/dsp/biquadfilter.h b/src/blacksound/dsp/biquadfilter.h index 51c840bcc..7f9f6ef32 100644 --- a/src/blacksound/dsp/biquadfilter.h +++ b/src/blacksound/dsp/biquadfilter.h @@ -27,14 +27,16 @@ namespace BlackSound //! Transform float transform(float inSample); - //! Set filter parameters @{ + //! Set filter parameters + //! @{ void setCoefficients(double aa0, double aa1, double aa2, double b0, double b1, double b2); void setLowPassFilter(float sampleRate, float cutoffFrequency, float q); void setPeakingEq(float sampleRate, float centreFrequency, float q, float dbGain); void setHighPassFilter(float sampleRate, float cutoffFrequency, float q); //! @} - //! Get filters @{ + //! Get filters + //! @{ static BiQuadFilter lowPassFilter(float sampleRate, float cutoffFrequency, float q); static BiQuadFilter highPassFilter(float sampleRate, float cutoffFrequency, float q); static BiQuadFilter peakingEQ(float sampleRate, float centreFrequency, float q, float dbGain); diff --git a/src/blacksound/sampleprovider/equalizersampleprovider.h b/src/blacksound/sampleprovider/equalizersampleprovider.h index 64cfe6d2b..cc688414b 100644 --- a/src/blacksound/sampleprovider/equalizersampleprovider.h +++ b/src/blacksound/sampleprovider/equalizersampleprovider.h @@ -43,7 +43,8 @@ namespace BlackSound //! Bypassing? void setBypassEffects(bool value) { m_bypass = value; } - //! Gain @{ + //! Gain + //! @{ double outputGain() const; void setOutputGain(double outputGain); //! @} diff --git a/src/blacksound/sampleprovider/resourcesoundsampleprovider.h b/src/blacksound/sampleprovider/resourcesoundsampleprovider.h index ca0ac3c72..99bbee565 100644 --- a/src/blacksound/sampleprovider/resourcesoundsampleprovider.h +++ b/src/blacksound/sampleprovider/resourcesoundsampleprovider.h @@ -32,12 +32,14 @@ namespace BlackSound //! copydoc ISampleProvider::isFinished virtual bool isFinished() const override { return m_isFinished; } - //! Looping @{ + //! Looping + //! @{ bool looping() const { return m_looping; } void setLooping(bool looping) { m_looping = looping; } - // @} + //! @} - //! Gain @{ + //! Gain + //! @{ double gain() const { return m_gain; } void setGain(double gain) { m_gain = gain; } //! @} diff --git a/src/blacksound/sampleprovider/samples.h b/src/blacksound/sampleprovider/samples.h index 19c94501a..ad92d99c9 100644 --- a/src/blacksound/sampleprovider/samples.h +++ b/src/blacksound/sampleprovider/samples.h @@ -32,7 +32,8 @@ namespace BlackSound //! Avoid to copy Samples(const Samples &) = delete; - //! Various samples (sounds) @{ + //! Various samples (sounds) + //! @{ const CResourceSound &crackle() const { return m_crackle; } const CResourceSound &click() const { return m_click; } const CResourceSound &whiteNoise() const { return m_whiteNoise; } @@ -42,7 +43,8 @@ namespace BlackSound //! Play the click sound bool playClick() const { return m_audioSettings.get().pttClickUp(); } - //! File names @{ + //! File names + //! @{ static const QString &fnCrackle() { static const QString f = "afv_crackle_f32.wav"; return f; } static const QString &fnClick() { static const QString f = "afv_click_f32.wav"; return f; } static const QString &fnWhiteNoise() { static const QString f = "afv_whitenoise_f32.wav"; return f; } diff --git a/src/plugins/simulator/flightgear/simulatorflightgear.h b/src/plugins/simulator/flightgear/simulatorflightgear.h index b078c1fb1..06bf5f027 100644 --- a/src/plugins/simulator/flightgear/simulatorflightgear.h +++ b/src/plugins/simulator/flightgear/simulatorflightgear.h @@ -179,13 +179,15 @@ namespace BlackSimPlugin //! \remark this is where the interpolated data are set void updateRemoteAircraft(); - //! Request elevation and CG from Flightgear @{ + //! Request elevation and CG from Flightgear + //! @{ void requestRemoteAircraftDataFromFlightgear(); void requestRemoteAircraftDataFromFlightgear(const BlackMisc::Aviation::CCallsignSet &callsigns); void triggerRequestRemoteAircraftDataFromFlightgear(const BlackMisc::Aviation::CCallsignSet &callsigns); //! @} - //! Adding new aircraft @{ + //! Adding new aircraft + //! @{ void addNextPendingAircraft(); void triggerAddNextPendingAircraft(); //! @} @@ -202,7 +204,8 @@ namespace BlackSimPlugin //! Can the next aircraft be added? bool canAddAircraft() const; - //! Callbacks from simulator @{ + //! Callbacks from simulator + //! @{ void onRemoteAircraftAdded(const QString &callsign); void onRemoteAircraftAddingFailed(const QString &callsign); void updateRemoteAircraftFromSimulator(const QStringList &callsigns, const QDoubleList &latitudesDeg, const QDoubleList &longitudesDeg, diff --git a/src/plugins/simulator/fs9/fs9client.h b/src/plugins/simulator/fs9/fs9client.h index 8744e68b9..b87cc174f 100644 --- a/src/plugins/simulator/fs9/fs9client.h +++ b/src/plugins/simulator/fs9/fs9client.h @@ -52,7 +52,8 @@ namespace BlackSimPlugin //! Starts the FS9 client messaging void start(); - //! Get interpolator @{ + //! Get interpolator + //! @{ BlackMisc::Simulation::CInterpolatorMulti *getInterpolator() { return &m_interpolator; } const BlackMisc::Simulation::CInterpolatorMulti *getInterpolator() const { return &m_interpolator; } //! @} diff --git a/src/plugins/simulator/fs9/simulatorfs9.h b/src/plugins/simulator/fs9/simulatorfs9.h index 9e47ab680..624fd7085 100644 --- a/src/plugins/simulator/fs9/simulatorfs9.h +++ b/src/plugins/simulator/fs9/simulatorfs9.h @@ -51,7 +51,7 @@ namespace BlackSimPlugin virtual ~CSimulatorFs9() override = default; //! \name Interface implementations - //! \@{ + //! @{ virtual bool connectTo() override; virtual bool disconnectFrom() override; virtual bool physicallyAddRemoteAircraft(const BlackMisc::Simulation::CSimulatedAircraft &newRemoteAircraft) override; @@ -66,14 +66,14 @@ namespace BlackSimPlugin virtual BlackMisc::CStatusMessageList getInterpolationMessages(const BlackMisc::Aviation::CCallsign &callsign) const override; virtual bool testSendSituationAndParts(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::Aviation::CAircraftSituation &situation, const BlackMisc::Aviation::CAircraftParts &parts) override; virtual void injectWeatherGrid(const BlackMisc::Weather::CWeatherGrid &weatherGrid) override; - //! \@} + //! @} protected: //! \name Interface implementations - //! \@{ + //! @{ virtual bool isConnected() const override; virtual bool isSimulating() const override { return isConnected(); } - //! \@} + //! @} //! Timer event dispatching //! \sa m_timerId diff --git a/src/plugins/simulator/fscommon/simulatorfscommonfunctions.h b/src/plugins/simulator/fscommon/simulatorfscommonfunctions.h index 16b0e895d..59d435b19 100644 --- a/src/plugins/simulator/fscommon/simulatorfscommonfunctions.h +++ b/src/plugins/simulator/fscommon/simulatorfscommonfunctions.h @@ -18,7 +18,8 @@ namespace BlackSimPlugin { namespace FsCommon { - //! Correctly casted values/checks @{ + //! Correctly casted values/checks + //! @{ HRESULT inline s_ok() { return S_OK; } HRESULT inline s_false() { return S_FALSE; } static bool inline isOk(HRESULT result) { return result == s_ok(); } diff --git a/src/plugins/simulator/fsxcommon/simconnectdatadefinition.h b/src/plugins/simulator/fsxcommon/simconnectdatadefinition.h index e2cb00271..24b2cfb31 100644 --- a/src/plugins/simulator/fsxcommon/simconnectdatadefinition.h +++ b/src/plugins/simulator/fsxcommon/simconnectdatadefinition.h @@ -100,7 +100,8 @@ namespace BlackSimPlugin char atcAirline[64]; //!< Airline used by ATC char atcFlightNumber[8]; //!< Flight Number used by ATC - //! Copy the strings, length from docu @{ + //! Copy the strings, length from docu + //! @{ void copyAtcId(const char *c) { strncpy_s(atcId, c, 10); atcId[9] = 0; } void copyAtcAirline(const char *c) { strncpy_s(atcAirline, c, 50); atcAirline[49] = 0; } void copyFlightNumber(const char *c) { strncpy_s(atcFlightNumber, c, 6); atcFlightNumber[5] = 0; } diff --git a/src/plugins/simulator/fsxcommon/simconnectsymbols.cpp b/src/plugins/simulator/fsxcommon/simconnectsymbols.cpp index fd8dc80c5..c54a97ef1 100644 --- a/src/plugins/simulator/fsxcommon/simconnectsymbols.cpp +++ b/src/plugins/simulator/fsxcommon/simconnectsymbols.cpp @@ -70,7 +70,8 @@ typedef HRESULT(__stdcall *PfnSimConnect_SetObserverLookAt)(HANDLE, const char * #endif //! The SimConnect Symbols -//! \private @{ +//! \private +//! @{ struct SimConnectSymbols { PfnSimConnect_Open SimConnect_Open = nullptr; @@ -113,7 +114,7 @@ struct SimConnectSymbols PfnSimConnect_CloseView SimConnect_CloseView = nullptr; #endif }; -//! @ } +//! @} static SimConnectSymbols gSymbols; diff --git a/src/plugins/simulator/fsxcommon/simulatorfsxcommon.h b/src/plugins/simulator/fsxcommon/simulatorfsxcommon.h index de4f65381..678ae6586 100644 --- a/src/plugins/simulator/fsxcommon/simulatorfsxcommon.h +++ b/src/plugins/simulator/fsxcommon/simulatorfsxcommon.h @@ -300,7 +300,8 @@ namespace BlackSimPlugin //! Register help static void registerHelp(); - //! Word size @{ + //! Word size + //! @{ static bool is32bit() { return (BlackConfig::CBuildConfig::buildWordSize() == 32); } static bool is64bit() { return (BlackConfig::CBuildConfig::buildWordSize() == 64); } //! @} @@ -629,7 +630,8 @@ namespace BlackSimPlugin static QString requestIdToString(DWORD requestId); public: - //! Offsets @{ + //! Offsets + //! @{ static DWORD offsetSimObjAircraft(CSimConnectDefinitions::SimObjectRequest req) { return MaxSimObjAircraft * static_cast(req); } static DWORD offsetSimObjTerrainProbe(CSimConnectDefinitions::SimObjectRequest req) { return MaxSimObjProbes * static_cast(req); } //! @} diff --git a/src/plugins/simulator/xplane/simulatorxplane.h b/src/plugins/simulator/xplane/simulatorxplane.h index 92654b26f..3eadf48cd 100644 --- a/src/plugins/simulator/xplane/simulatorxplane.h +++ b/src/plugins/simulator/xplane/simulatorxplane.h @@ -197,13 +197,15 @@ namespace BlackSimPlugin //! Update airports void updateAirportsInRange(); - //! Request elevation and CG from XPlane @{ + //! Request elevation and CG from XPlane + //! @{ void requestRemoteAircraftDataFromXPlane(); void requestRemoteAircraftDataFromXPlane(const BlackMisc::Aviation::CCallsignSet &callsigns); void triggerRequestRemoteAircraftDataFromXPlane(const BlackMisc::Aviation::CCallsignSet &callsigns); //! @} - //! Adding new aircraft @{ + //! Adding new aircraft + //! @{ void addNextPendingAircraft(); void triggerAddNextPendingAircraft(); //! @} @@ -220,7 +222,8 @@ namespace BlackSimPlugin //! Can the next aircraft be added? No other aircraft adding in progress? bool canAddAircraft() const; - //! Callbacks from simulator @{ + //! Callbacks from simulator + //! @{ void onRemoteAircraftAdded(const QString &callsign); void onRemoteAircraftAddingFailed(const QString &callsign); void updateRemoteAircraftFromSimulator(const QStringList &callsigns, const QDoubleList &latitudesDeg, const QDoubleList &longitudesDeg, @@ -230,7 +233,8 @@ namespace BlackSimPlugin //! Disconnect from DBus void disconnectFromDBus(); - //! Send/receive settings @{ + //! Send/receive settings + //! @{ bool sendXSwiftBusSettings(); BlackMisc::Simulation::Settings::CXSwiftBusSettings receiveXSwiftBusSettings(bool &ok); //! @} diff --git a/src/swiftcore/swiftcore.h b/src/swiftcore/swiftcore.h index 78d13ee83..512a8489b 100644 --- a/src/swiftcore/swiftcore.h +++ b/src/swiftcore/swiftcore.h @@ -54,7 +54,7 @@ public: virtual ~CSwiftCore() override; private: - //! \name Init + //! Init //! @{ void initLogDisplay(); void initStyleSheet(); diff --git a/src/swiftdata/swiftdata.h b/src/swiftdata/swiftdata.h index f4494b54a..d71a4d684 100644 --- a/src/swiftdata/swiftdata.h +++ b/src/swiftdata/swiftdata.h @@ -46,7 +46,8 @@ public: virtual ~CSwiftData() override; protected: - //! \name QMainWindow events @[ + //! \name QMainWindow events + //! @{ virtual void closeEvent(QCloseEvent *event) override; //! @} @@ -57,7 +58,8 @@ private: //! Menu clicked void onMenuClicked(); - //! Init functions @{ + //! Init functions + //! @{ void init(); void initLogDisplay(); void initStyleSheet(); diff --git a/src/swiftguistandard/swiftguistd.h b/src/swiftguistandard/swiftguistd.h index e553ba31e..7cb6274d9 100644 --- a/src/swiftguistandard/swiftguistd.h +++ b/src/swiftguistandard/swiftguistd.h @@ -106,7 +106,8 @@ protected: //! Get a minimize action which minimizes the window - //! Actions for navigator @{ + //! Actions for navigator + //! @{ QAction *getWindowMinimizeAction(QObject *parent); QAction *getWindowNormalAction(QObject *parent); QAction *getToggleWindowVisibilityAction(QObject *parent); @@ -325,7 +326,8 @@ private: //! Start AFV map bool startAFVMap(); - //! Request overlay inline text message @{ + //! Request overlay inline text message + //! @{ void onShowOverlayVariant(const BlackMisc::CVariant &variant, int durationMs); void onShowOverlayInlineTextMessageTab(BlackGui::Components::TextMessageTab tab); void onShowOverlayInlineTextMessageCallsign(const BlackMisc::Aviation::CCallsign &callsign); diff --git a/src/swiftlauncher/swiftlauncher.h b/src/swiftlauncher/swiftlauncher.h index c4dd57611..a2b839bdf 100644 --- a/src/swiftlauncher/swiftlauncher.h +++ b/src/swiftlauncher/swiftlauncher.h @@ -88,7 +88,8 @@ public: bool startDetached(); protected: - //! Mouse events for frameless window @{ + //! Mouse events for frameless window + //! @{ virtual void mousePressEvent(QMouseEvent *event) override; virtual void mouseMoveEvent(QMouseEvent *event) override; virtual void mouseReleaseEvent(QMouseEvent *event) override; diff --git a/src/xswiftbus/service.h b/src/xswiftbus/service.h index 9e61e88d5..34636a14e 100644 --- a/src/xswiftbus/service.h +++ b/src/xswiftbus/service.h @@ -160,7 +160,8 @@ namespace XSwiftBus //! Get whether all wheels are on the ground bool getAllWheelsOnGround() const { return m_onGroundAll.get(); } - //! COM Selection 6/7 @{ + //! COM Selection 6/7 + //! @{ int getComSelection() const { return m_comAudioSelection.get(); } bool isCom1Selected() const { return this->getComSelection() == 6; } bool isCom2Selected() const { return this->getComSelection() == 7; } diff --git a/src/xswiftbus/traffic.h b/src/xswiftbus/traffic.h index 8846e1f91..0189bbddc 100644 --- a/src/xswiftbus/traffic.h +++ b/src/xswiftbus/traffic.h @@ -193,26 +193,30 @@ namespace XSwiftBus const std::string &livery_, const std::string &modelName_); }; - //! Check functions @{ + //! Check functions + //! @{ static bool isPlusMinusOne(float v); static bool isPlusMinus180(float v); static bool isPlusMinus180(double v); static bool isZeroTo360(double v); //! @} - //! Normalize to (-180, 180] or [0, 360) degrees @{ + //! Normalize to (-180, 180] or [0, 360) degrees + //! @{ static float normalizeToPlusMinus180Deg(float v); static double normalizeToPlusMinus180Deg(double v); static float normalizeToZero360Deg(float v); static double normalizeToZero360Deg(double v); //! @} - //! Check the position if values are valid @{ + //! Check the position if values are valid + //! @{ static bool isValidPosition(const XPMPPlanePosition_t &position); static bool isValidPosition(const XPLMCameraPosition_t *camPos); //! @} - //! Pos as string @{ + //! Pos as string + //! @{ static std::string pos2String(const XPMPPlanePosition_t &position); static std::string pos2String(const XPLMCameraPosition_t *camPos); //! @}