From 7691e42a5b1a526372505538c5c3afb9d77789ea Mon Sep 17 00:00:00 2001 From: Mat Sutcliffe Date: Sun, 5 Feb 2023 16:32:51 +0000 Subject: [PATCH] Fix doxygen warnings Fixes #188 --- src/blackcore/actionbind.h | 2 +- src/blackcore/afv/audio/callsigndelaycache.h | 2 +- .../afv/audio/callsignsampleprovider.h | 4 +- src/blackcore/afv/audio/input.h | 6 +- src/blackcore/afv/audio/output.h | 2 +- .../afv/audio/receiversampleprovider.h | 4 +- src/blackcore/afv/clients/afvclient.h | 48 +++---- .../afv/connection/apiserverconnection.h | 2 +- .../afv/connection/clientconnection.h | 4 +- .../afv/connection/clientconnectiondata.h | 14 +- src/blackcore/afv/crypto/cryptodtochannel.h | 2 +- .../afv/crypto/cryptodtoserializer.h | 6 +- src/blackcore/afv/dto.h | 24 ++-- src/blackcore/afv/model/afvmapreader.h | 2 +- src/blackcore/afv/model/atcstationmodel.h | 2 +- src/blackcore/airspacemonitor.h | 6 +- src/blackcore/application.h | 14 +- src/blackcore/context/contextapplication.h | 7 +- .../context/contextapplicationimpl.h | 3 - .../context/contextapplicationproxy.h | 3 - src/blackcore/context/contextaudio.h | 25 ++-- src/blackcore/context/contextaudioimpl.h | 4 - src/blackcore/context/contextaudioproxy.h | 5 - src/blackcore/context/contextnetwork.h | 7 +- src/blackcore/context/contextnetworkimpl.h | 29 ++--- src/blackcore/context/contextownaircraft.h | 7 +- .../context/contextownaircraftimpl.h | 4 +- .../context/contextownaircraftproxy.h | 3 - src/blackcore/context/contextsimulator.h | 7 +- src/blackcore/context/contextsimulatorimpl.h | 18 +-- src/blackcore/fsd/atcdataupdate.h | 2 +- src/blackcore/fsd/clientidentification.h | 2 +- src/blackcore/fsd/clientquery.h | 2 +- src/blackcore/fsd/clientresponse.h | 2 +- src/blackcore/fsd/enums.h | 2 +- src/blackcore/fsd/euroscopesimdata.h | 2 +- src/blackcore/fsd/flightplan.h | 2 +- src/blackcore/fsd/fsdclient.h | 34 +++-- src/blackcore/fsd/fsdidentification.h | 2 +- src/blackcore/fsd/interimpilotdataupdate.h | 2 +- src/blackcore/fsd/pilotdataupdate.h | 2 +- src/blackcore/fsd/planeinforequestfsinn.h | 2 +- src/blackcore/fsd/planeinformation.h | 2 +- src/blackcore/fsd/planeinformationfsinn.h | 2 +- src/blackcore/fsd/rehost.h | 2 +- src/blackcore/fsd/revbclientparts.h | 7 +- src/blackcore/fsd/servererror.h | 4 +- src/blackcore/fsd/visualpilotdataperiodic.h | 2 +- src/blackcore/fsd/visualpilotdatastopped.h | 2 +- src/blackcore/fsd/visualpilotdatatoggle.h | 2 +- src/blackcore/fsd/visualpilotdataupdate.h | 2 +- src/blackcore/simulator.h | 9 +- src/blackcore/vatsim/vatsimbookingreader.h | 4 +- src/blackcore/vatsim/vatsimdatafilereader.h | 4 +- src/blackcore/vatsim/vatsimmetarreader.h | 4 +- src/blackcore/webdataservicesms.h | 2 +- .../audioadvanceddistributedcomponent.h | 2 +- .../audiodevicevolumesetupcomponent.h | 8 +- src/blackgui/components/cgsourceselector.h | 2 +- src/blackgui/components/cockpitcomcomponent.h | 2 +- src/blackgui/components/cockpitcomponent.h | 2 +- .../components/dbmappingcomponentaware.h | 2 +- .../components/networkdetailscomponent.h | 2 +- .../components/settingstextmessagestyle.h | 2 +- .../components/textmessagecomponent.h | 4 +- src/blackgui/dockwidget.h | 2 +- src/blackgui/editors/cockpitcomform.h | 2 +- src/blackgui/editors/matchingform.h | 2 +- src/blackgui/editors/pbhsform.h | 2 +- src/blackgui/editors/situationform.h | 2 +- src/blackgui/guiapplication.h | 14 +- src/blackgui/guiutility.h | 4 +- src/blackgui/levelmeter.h | 4 +- src/blackgui/menus/fontmenus.h | 2 +- src/blackgui/menus/menuaction.h | 2 +- src/blackgui/models/actionitem.h | 2 +- src/blackgui/models/columnformatters.h | 2 +- src/blackgui/models/columns.h | 2 +- src/blackgui/views/atcstationtreeview.h | 2 +- src/blackgui/views/simulatedaircraftview.h | 4 +- src/blackgui/views/viewbase.h | 4 +- src/blackmisc/audio/audiodeviceinfolist.h | 2 +- src/blackmisc/audio/audiosettings.h | 6 +- src/blackmisc/aviation/aircraftsituation.h | 8 +- src/blackmisc/aviation/aircraftvelocity.h | 6 +- src/blackmisc/aviation/altitude.h | 2 +- src/blackmisc/aviation/callsign.h | 2 +- src/blackmisc/aviation/flightplan.h | 4 +- src/blackmisc/collection.h | 2 +- src/blackmisc/connectionguard.h | 2 +- src/blackmisc/containerbase.h | 5 +- src/blackmisc/datacache.h | 6 +- src/blackmisc/dbusserver.h | 2 +- src/blackmisc/dictionary.h | 8 +- src/blackmisc/directoryutils.h | 2 +- src/blackmisc/geo/coordinategeodetic.h | 2 +- src/blackmisc/geo/kmlutils.h | 2 +- src/blackmisc/icons.h | 12 +- src/blackmisc/iterator.h | 24 ++-- src/blackmisc/json.h | 20 +-- src/blackmisc/jsonexception.h | 4 +- src/blackmisc/lockfree.h | 16 +-- src/blackmisc/mapbuilder.h | 2 +- src/blackmisc/math/mathutils.h | 4 +- src/blackmisc/metaclass.h | 4 +- src/blackmisc/network/clientprovider.h | 4 +- src/blackmisc/network/connectionstatus.h | 2 +- src/blackmisc/network/fsdsetup.h | 6 +- src/blackmisc/pq/literals.h | 88 ++++++------- src/blackmisc/pq/measurementunit.h | 10 +- src/blackmisc/pq/physicalquantity.h | 4 +- src/blackmisc/range.h | 18 +-- src/blackmisc/sequence.h | 6 +- src/blackmisc/setbuilder.h | 4 +- src/blackmisc/settingscache.h | 2 +- src/blackmisc/sharedstate/datalink.h | 4 +- src/blackmisc/sharedstate/dbus/hubimpl.h | 1 + .../simulation/aircraftmatchersetup.h | 12 +- .../simulation/aircraftmodelinterfaces.h | 10 +- src/blackmisc/simulation/aircraftmodellist.h | 12 +- .../simulation/aircraftmodelloader.h | 4 +- .../simulation/aircraftmodelloaderprovider.h | 2 +- src/blackmisc/simulation/autopublishdata.h | 4 +- src/blackmisc/simulation/categorymatcher.h | 2 +- src/blackmisc/simulation/data/modelcaches.h | 6 +- src/blackmisc/simulation/distributor.h | 2 +- .../simulation/fscommon/fsdirectories.h | 2 +- src/blackmisc/simulation/interpolator.h | 4 +- src/blackmisc/simulation/interpolatorlinear.h | 2 +- src/blackmisc/simulation/interpolatorpbh.h | 4 +- src/blackmisc/simulation/interpolatorspline.h | 2 - src/blackmisc/simulation/matchingscript.h | 30 ++--- .../simulation/remoteaircraftprovider.h | 14 +- .../simulation/remoteaircraftproviderdummy.h | 4 +- .../simulation/settings/simulatorsettings.h | 2 +- .../settings/xswiftbussettingsqtfree.h | 2 +- .../simulationenvironmentprovider.h | 2 +- src/blackmisc/simulation/simulatorinfo.h | 2 +- src/blackmisc/simulation/xplane/qtfreeutils.h | 4 +- src/blackmisc/statusmessage.h | 38 +++--- src/blackmisc/test/testserviceinterface.h | 4 +- src/blackmisc/valuecache.h | 6 +- src/blackmisc/variant.cpp | 2 +- src/blackmisc/verify.h | 4 +- src/blacksound/audioutilities.h | 4 +- src/blacksound/codecs/opusdecoder.h | 2 +- src/blacksound/dsp/SimpleComp.h | 8 +- src/blacksound/dsp/SimpleEnvelope.h | 6 +- src/blacksound/dsp/SimpleLimit.h | 6 +- src/blacksound/dsp/biquadfilter.h | 4 +- .../sampleprovider/equalizersampleprovider.h | 2 +- .../resourcesoundsampleprovider.h | 4 +- src/blacksound/sampleprovider/samples.h | 4 +- .../sampleprovider/volumesampleprovider.h | 2 +- .../simulator/emulated/simulatoremulated.h | 2 - .../flightgear/fgswiftbusserviceproxy.h | 72 +++++------ .../flightgear/simulatorflightgear.h | 6 +- .../simulator/fscommon/simulatorfscommon.h | 6 +- .../fscommon/simulatorfscommonfunctions.h | 2 +- .../fsxcommon/simconnectdatadefinition.h | 2 +- .../simulator/fsxcommon/simconnectobject.h | 2 +- .../simulator/fsxcommon/simconnectsymbols.cpp | 2 - .../simulator/fsxcommon/simulatorfsxcommon.h | 6 +- .../plugincommon/simulatorplugincommon.h | 2 - .../simulator/xplane/simulatorxplane.h | 8 +- .../simulator/xplane/xswiftbusserviceproxy.h | 120 +++++++++--------- src/swiftcore/swiftcore.h | 2 +- src/swiftdata/swiftdata.h | 2 +- src/swiftguistandard/swiftguistd.h | 4 +- src/xswiftbus/command.h | 2 +- src/xswiftbus/dbusmessage.h | 6 +- src/xswiftbus/service.h | 6 +- src/xswiftbus/terrainprobe.h | 4 +- src/xswiftbus/traffic.h | 8 +- src/xswiftbus/utils.h | 2 +- 175 files changed, 570 insertions(+), 664 deletions(-) diff --git a/src/blackcore/actionbind.h b/src/blackcore/actionbind.h index b26b14c8f..a770ca094 100644 --- a/src/blackcore/actionbind.h +++ b/src/blackcore/actionbind.h @@ -50,8 +50,8 @@ namespace BlackCore //! Signature just to set an icon for an action CActionBind(const QString &action, BlackMisc::CIcons::IconIndex icon, QObject *parent = nullptr); - //! Not copyable //! @{ + //! Not copyable CActionBind(const CActionBind &) = delete; CActionBind &operator =(const CActionBind &) = delete; //! @} diff --git a/src/blackcore/afv/audio/callsigndelaycache.h b/src/blackcore/afv/audio/callsigndelaycache.h index e8bb29ff5..e71fdce49 100644 --- a/src/blackcore/afv/audio/callsigndelaycache.h +++ b/src/blackcore/afv/audio/callsigndelaycache.h @@ -32,8 +32,8 @@ namespace BlackCore::Afv::Audio //! 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 28091711e..db12ddcf0 100644 --- a/src/blackcore/afv/audio/callsignsampleprovider.h +++ b/src/blackcore/afv/audio/callsignsampleprovider.h @@ -49,8 +49,8 @@ namespace BlackCore::Afv::Audio //! Type const QString &type() const { return m_aircraftType; } - //! Is active? //! @{ + //! Is active? void active(const QString &callsign, const QString &aircraftType); void activeSilent(const QString &callsign, const QString &aircraftType); //! @} @@ -58,8 +58,8 @@ namespace BlackCore::Afv::Audio //! 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 721386db9..95a695d6e 100644 --- a/src/blackcore/afv/audio/input.h +++ b/src/blackcore/afv/audio/input.h @@ -92,16 +92,16 @@ namespace BlackCore::Afv::Audio this->stop(); } - //! Number of encoded bytes //! @{ + //! Number of encoded bytes int opusBytesEncoded() const { return m_opusBytesEncoded; } void setOpusBytesEncoded(int opusBytesEncoded) { m_opusBytesEncoded = opusBytesEncoded; } //! @} + //! @{ //! Gain ratio, value a amplitude need to be multiplied with //! \see http://www.sengpielaudio.com/calculator-amplification.htm //! \remark gain ratio is voltage ratio/or amplitude ratio, something between 0.001-7.95 for -60dB to 80dB - //! @{ double getGainRatio() const { return m_gainRatio; } bool setGainRatio(double gainRatio); //! @} @@ -110,8 +110,8 @@ namespace BlackCore::Afv::Audio // 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 678bd9717..9a2f90190 100644 --- a/src/blackcore/afv/audio/output.h +++ b/src/blackcore/afv/audio/output.h @@ -86,8 +86,8 @@ namespace BlackCore::Afv::Audio 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 8aa3aaaab..b85d8855a 100644 --- a/src/blackcore/afv/audio/receiversampleprovider.h +++ b/src/blackcore/afv/audio/receiversampleprovider.h @@ -56,8 +56,8 @@ namespace BlackCore::Afv::Audio //! Volume double volume() const { return 1.0; } - //! Mute //! @{ + //! Mute bool getMute() const { return m_mute; } void setMute(bool value); //! @} @@ -65,8 +65,8 @@ namespace BlackCore::Afv::Audio //! \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 6c511931d..5dc1991eb 100644 --- a/src/blackcore/afv/clients/afvclient.h +++ b/src/blackcore/afv/clients/afvclient.h @@ -45,8 +45,8 @@ namespace BlackCore::Afv::Clients { 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) @@ -68,9 +68,9 @@ namespace BlackCore::Afv::Clients //! Dtor virtual ~CAfvClient() override { this->stopAudio(); } + //! @{ //! Corresponding callsign //! \threadsafe - //! @{ QString getCallsign() const; void setCallsign(const QString &getCallsign); //! @} @@ -88,17 +88,17 @@ namespace BlackCore::Afv::Clients //! \remark runs in thread of CAfvClient object and is ASYNC when called from another thread Q_INVOKABLE void connectTo(const QString &cid, const QString &password, const QString &callsign, const QString &client); + //! @{ //! Disconnect from network //! \threadsafe //! \remark runs in thread of CAfvClient object and is ASYNC when called from another thread - //! @{ void disconnectFrom(bool stop); Q_INVOKABLE void disconnectFrom() { this->disconnectFrom(false); } void disconnectFromAndStop() { this->disconnectFrom(true); } //! @} - //! Audio devices //! @{ + //! Audio devices Q_INVOKABLE QStringList availableInputDevices() const; Q_INVOKABLE QStringList availableOutputDevices() const; //! @} @@ -109,15 +109,15 @@ namespace BlackCore::Afv::Clients //! Client started? bool isStarted() const { return m_isStarted; } + //! @{ //! Muted //! \threadsafe - //! @{ bool isMuted() const; 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); @@ -130,8 +130,8 @@ namespace BlackCore::Afv::Clients 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; @@ -143,55 +143,55 @@ namespace BlackCore::Afv::Clients //! \threadsafe void setReceiveAudio(bool receive); + //! @{ //! Enable COM unit/transceiver //! \threadsafe - //! @{ Q_INVOKABLE void enableTransceiver(quint16 id, bool enable); void enableComUnit(BlackMisc::Aviation::CComSystem::ComUnit comUnit, bool enable); bool isEnabledTransceiver(quint16 id) const; bool isEnabledComUnit(BlackMisc::Aviation::CComSystem::ComUnit comUnit) const; //! @} + //! @{ //! Set transmitting transceivers //! \threadsafe - //! @{ void setTransmittingTransceiver(quint16 transceiverID); void setTransmittingComUnit(BlackMisc::Aviation::CComSystem::ComUnit comUnit); void setTransmittingTransceivers(const QVector &transceivers); //! @} + //! @{ //! Transmitting transceiver/COM unit //! \threadsafe - //! @{ bool isTransmittingTransceiver(quint16 id) const; bool isTransmittingComUnit(BlackMisc::Aviation::CComSystem::ComUnit comUnit) const; //! @} + //! @{ //! Simplified enable/disable //! \threadsafe - //! @{ void setRxTx(bool rx1, bool tx1, bool rx2, bool tx2); void getRxTx(bool &rx1, bool &tx1, bool &rx2, bool &tx2) const; //! @} + //! @{ //! Get transceivers //! \threadsafe - //! @{ QVector getTransceivers() const; QVector getTransmittingTransceivers() const; QSet getEnabledTransceivers() const; //! @} + //! @{ //! Aliased stations enabled? //! \threadsafe - //! @{ bool isAliasedStationsEnabled() const { return m_enableAliased; } void enableAliasedStations(bool enabled) { m_enableAliased = enabled; } //! @} + //! @{ //! Update frequency //! \threadsafe - //! @{ Q_INVOKABLE void updateComFrequency(quint16 id, quint32 frequencyHz); void updateComFrequency(BlackMisc::Aviation::CComSystem::ComUnit comUnit, const BlackMisc::PhysicalQuantities::CFrequency &comFrequency); void updateComFrequency(BlackMisc::Aviation::CComSystem::ComUnit comUnit, const BlackMisc::Aviation::CComSystem &comSystem); @@ -206,30 +206,30 @@ namespace BlackCore::Afv::Clients //! \threadsafe void updateFromOwnAircraft(const BlackMisc::Simulation::CSimulatedAircraft &aircraft, bool withSignals = true); + //! @{ //! Push to talk //! \threadsafe - //! @{ Q_INVOKABLE void setPtt(bool active); void setPttForCom(bool active, BlackMisc::Audio::PTTCOM com); //! @} + //! @{ //! Loopback //! \threadsafe - //! @{ Q_INVOKABLE void setLoopBack(bool on) { m_loopbackOn = on; } Q_INVOKABLE bool isLoopback() const { return m_loopbackOn; } //! @} + //! @{ //! Input volume in dB, [MinDbIn, MaxDbIn]dB //! \threadsafe - //! @{ double getInputVolumeDb() const; Q_INVOKABLE bool setInputVolumeDb(double valueDb); //! @} + //! @{ //! Output volume for each COM in dB, [MinDbOut, MaxDbOut]dB //! \threadsafe - //! @{ double getComOutputVolumeDb(BlackMisc::Aviation::CComSystem::ComUnit comUnit) const; Q_INVOKABLE bool setComOutputVolumeDb(BlackMisc::Aviation::CComSystem::ComUnit comUnit, double valueDb); //! @} @@ -238,9 +238,9 @@ namespace BlackCore::Afv::Clients //! \threadsafe double getOutputGainRatio(BlackMisc::Aviation::CComSystem::ComUnit comUnit) const; + //! @{ //! Normalized volumes 0..100 //! \threadsafe - //! @{ int getNormalizedInputVolume() const; int getNormalizedComOutputVolume(BlackMisc::Aviation::CComSystem::ComUnit comUnit) const; int getNormalizedMasterOutputVolume() const; @@ -249,24 +249,24 @@ namespace BlackCore::Afv::Clients bool setNormalizedMasterOutputVolume(int volume); //! @} + //! @{ //! VU values, 0..1 //! \threadsafe - //! @{ double getInputVolumePeakVU() const; double getOutputVolumePeakVU() const; //! @} + //! @{ //! Recently used device //! \threadsafe - //! @{ const BlackMisc::Audio::CAudioDeviceInfo &getInputDevice() const; const BlackMisc::Audio::CAudioDeviceInfo &getOutputDevice() const; bool usesSameDevices(const BlackMisc::Audio::CAudioDeviceInfo &inputDevice, const BlackMisc::Audio::CAudioDeviceInfo &outputDevice); //! @} + //! @{ //! Callsigns currently received //! \threadsafe - //! @{ QString getReceivingCallsignsStringCom1() const; QString getReceivingCallsignsStringCom2() const; BlackMisc::Aviation::CCallsignSet getReceivingCallsignsCom1() const; @@ -301,8 +301,8 @@ namespace BlackCore::Afv::Clients //! 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); //! @} @@ -344,9 +344,9 @@ namespace BlackCore::Afv::Clients //! Connect again in given ms void reconnectTo(const QString &cid, const QString &password, const QString &callsign, const QString &client, int delayMs, const BlackMisc::CStatusMessage &msg); + //! @{ //! All aliased stations //! \threadsafe - //! @{ QVector getAliasedStations() const; void setAliasedStations(const QVector &stations); //! @} diff --git a/src/blackcore/afv/connection/apiserverconnection.h b/src/blackcore/afv/connection/apiserverconnection.h index 4dfd18121..c489e6e38 100644 --- a/src/blackcore/afv/connection/apiserverconnection.h +++ b/src/blackcore/afv/connection/apiserverconnection.h @@ -79,8 +79,8 @@ namespace BlackCore::Afv::Connection //! 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 4c9713bb7..9f4c73b8d 100644 --- a/src/blackcore/afv/connection/clientconnection.h +++ b/src/blackcore/afv/connection/clientconnection.h @@ -54,8 +54,8 @@ namespace BlackCore::Afv::Connection //! 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; } @@ -94,8 +94,8 @@ namespace BlackCore::Afv::Connection //! 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 12248cb72..2c50898d8 100644 --- a/src/blackcore/afv/connection/clientconnectiondata.h +++ b/src/blackcore/afv/connection/clientconnectiondata.h @@ -36,20 +36,20 @@ namespace BlackCore::Afv::Connection //! 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; } //! @} @@ -57,26 +57,26 @@ namespace BlackCore::Afv::Connection //! 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 3750e51d6..c25a46fb6 100644 --- a/src/blackcore/afv/crypto/cryptodtochannel.h +++ b/src/blackcore/afv/crypto/cryptodtochannel.h @@ -32,8 +32,8 @@ namespace BlackCore::Afv::Crypto //! 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 9375852ec..f9715c1cd 100644 --- a/src/blackcore/afv/crypto/cryptodtoserializer.h +++ b/src/blackcore/afv/crypto/cryptodtoserializer.h @@ -137,20 +137,20 @@ namespace BlackCore::Afv::Crypto 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 da472295d..e96929d45 100644 --- a/src/blackcore/afv/dto.h +++ b/src/blackcore/afv/dto.h @@ -25,8 +25,8 @@ namespace BlackCore::Afv //! Channel config DTO struct CryptoDtoChannelConfigDto { - //! Properties //! @{ + //! Properties QString channelTag; QByteArray aeadReceiveKey; QByteArray aeadTransmitKey; @@ -60,8 +60,8 @@ namespace BlackCore::Afv //! 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,8 +91,8 @@ namespace BlackCore::Afv //! Callsign DTO struct PostCallsignResponseDto { - //! Properties //! @{ + //! Properties // DataServerConnectionDataDto DataServer; VoiceServerConnectionDataDto VoiceServer; bool isValid = false; @@ -121,8 +121,8 @@ namespace BlackCore::Afv //! Transceiver DTO struct TransceiverDto { - //! Properties //! @{ + //! Properties quint16 id; quint32 frequencyHz; double LatDeg = 0.0; @@ -162,8 +162,8 @@ namespace BlackCore::Afv //! Station DTO struct StationDto { - //! Properties //! @{ + //! Properties QUuid id; QString name; quint32 frequencyHz; @@ -185,8 +185,8 @@ namespace BlackCore::Afv //! Heartbeat DTO struct HeartbeatDto { - //! Name //! @{ + //! Name static QByteArray getDtoName() { return "HeartbeatDto"; } static QByteArray getShortDtoName() { return "H"; } //! @} @@ -198,8 +198,8 @@ namespace BlackCore::Afv //! Heartbeat DTO struct HeartbeatAckDto { - //! Name //! @{ + //! Name static QByteArray getDtoName() { return "HeartbeatAckDto"; } static QByteArray getShortDtoName() { return "HA"; } //! @} @@ -210,8 +210,8 @@ namespace BlackCore::Afv //! Receive transceiver DTO struct RxTransceiverDto { - //! Properties //! @{ + //! Properties uint16_t id; uint32_t frequency; float distanceRatio; @@ -246,14 +246,14 @@ namespace BlackCore::Afv //! 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; @@ -266,14 +266,14 @@ namespace BlackCore::Afv //! 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 6d07533a9..9748e4250 100644 --- a/src/blackcore/afv/model/afvmapreader.h +++ b/src/blackcore/afv/model/afvmapreader.h @@ -22,8 +22,8 @@ namespace BlackCore::Afv::Model { 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 ec47e33b0..43105b5d8 100644 --- a/src/blackcore/afv/model/atcstationmodel.h +++ b/src/blackcore/afv/model/atcstationmodel.h @@ -31,8 +31,8 @@ namespace BlackCore::Afv::Model //! 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 239bcc71d..9e9a113c9 100644 --- a/src/blackcore/airspacemonitor.h +++ b/src/blackcore/airspacemonitor.h @@ -80,9 +80,9 @@ namespace BlackCore Fsd::CFSDClient *fsdClient, QObject *parent); + //! @{ //! Members not implenented or fully implenented by CRemoteAircraftProvider //! \ingroup remoteaircraftprovider - //! @{ virtual QObject *asQObject() override { return this; } virtual BlackMisc::Simulation::CAirspaceAircraftSnapshot getLatestAirspaceAircraftSnapshot() const override; virtual bool updateFastPositionEnabled(const BlackMisc::Aviation::CCallsign &callsign, bool enableFastPositonUpdates) override; @@ -167,18 +167,16 @@ namespace BlackCore }; Q_DECLARE_FLAGS(MatchingReadiness, MatchingReadinessFlag) - //! As string //! @{ + //! As string static const QString &enumFlagToString(MatchingReadinessFlag r); static QString enumToString(MatchingReadiness r); //! @} //! \addtogroup swiftdotcommands - //! @{ //! 
         //! .fsd range distance        max.range e.g. ".fsd range 100NM"
         //!
- //! @} //! \copydoc BlackCore::Context::IContextNetwork::parseCommandLine bool parseCommandLine(const QString &commandLine, const BlackMisc::CIdentifier &originator); diff --git a/src/blackcore/application.h b/src/blackcore/application.h index e0549d39d..a59879b32 100644 --- a/src/blackcore/application.h +++ b/src/blackcore/application.h @@ -315,6 +315,8 @@ namespace BlackCore //! cmd line arguments as string virtual QString cmdLineArgumentsAsString(bool withExecutable = true); + //! @} + //! Simulate a crash //! \private only for testing purposes void simulateCrash(); @@ -378,15 +380,15 @@ namespace BlackCore //! Get the facade CCoreFacade *getCoreFacade() { return m_coreFacade.data(); } - //! Local or DBus application? - //! @{ + //! Local application? (not DBus) bool isLocalContext() const; + + //! DBus application? (not Local) bool isDBusContext() const; - //! @} //! Get the facade - //! @{ const CCoreFacade *getCoreFacade() const { return m_coreFacade.data(); } + //! @} //! Direct access to contexts if a CCoreFacade has been initialized @@ -450,6 +452,9 @@ namespace BlackCore // ------------------------- network ----------------------------------------------- + //! \name network + //! @{ + static constexpr int NoRedirects = -1; //!< network request not allowing redirects static constexpr int NoLogRequestId = -1; //!< network request without logging static constexpr int DefaultMaxRedirects = 2; //!< network request, default for max.redirects @@ -565,6 +570,7 @@ namespace BlackCore //! \threadsafe QNetworkReply *downloadFromNetwork(const BlackMisc::Network::CUrl &url, const QString &saveAsFileName, const BlackMisc::CSlot &callback, int maxRedirects = DefaultMaxRedirects); + //! @} signals: //! Setup available (cache, web load, ..) or failed to load setup diff --git a/src/blackcore/context/contextapplication.h b/src/blackcore/context/contextapplication.h index ebd8eec39..0a1926003 100644 --- a/src/blackcore/context/contextapplication.h +++ b/src/blackcore/context/contextapplication.h @@ -33,17 +33,14 @@ // clazy:excludeall=const-signal-or-slot -//! \addtogroup dbus -//! @{ - //! DBus interface for context +//! \addtogroup dbus #define BLACKCORE_CONTEXTAPPLICATION_INTERFACENAME "org.swift_project.blackcore.contextapplication" //! DBus object path for context +//! \addtogroup dbus #define BLACKCORE_CONTEXTAPPLICATION_OBJECTPATH "/application" -//! @} - class QDBusConnection; namespace BlackMisc { class CDBusServer; } namespace BlackCore diff --git a/src/blackcore/context/contextapplicationimpl.h b/src/blackcore/context/contextapplicationimpl.h index c1fe66f75..29ebc1512 100644 --- a/src/blackcore/context/contextapplicationimpl.h +++ b/src/blackcore/context/contextapplicationimpl.h @@ -46,8 +46,6 @@ 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; @@ -67,7 +65,6 @@ namespace BlackCore virtual bool removeFile(const QString &fileName) override; virtual bool existsFile(const QString &fileName) const override; virtual QString dotCommandsHtmlHelp() const override; - //! @} protected: //! Constructor diff --git a/src/blackcore/context/contextapplicationproxy.h b/src/blackcore/context/contextapplicationproxy.h index de4072cb4..4a9960677 100644 --- a/src/blackcore/context/contextapplicationproxy.h +++ b/src/blackcore/context/contextapplicationproxy.h @@ -49,8 +49,6 @@ 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; @@ -70,7 +68,6 @@ namespace BlackCore virtual bool removeFile(const QString &fileName) override; virtual bool existsFile(const QString &fileName) const override; virtual QString dotCommandsHtmlHelp() const override; - //! @} //! Used to test if there is a core running? //! \note creates and connects via proxy object, so not meant for very frequent tests diff --git a/src/blackcore/context/contextaudio.h b/src/blackcore/context/contextaudio.h index 5903b4b3e..e41fe1b14 100644 --- a/src/blackcore/context/contextaudio.h +++ b/src/blackcore/context/contextaudio.h @@ -43,17 +43,14 @@ // clazy:excludeall=const-signal-or-slot -//! \addtogroup dbus -//! @{ - //! DBus interface for context +//! \addtogroup dbus #define BLACKCORE_CONTEXTAUDIO_INTERFACENAME "org.swift_project.blackcore.contextaudio" //! DBus object path for context +//! \addtogroup dbus #define BLACKCORE_CONTEXTAUDIO_OBJECTPATH "/audio" -//! @} - class QDBusConnection; namespace BlackMisc { class CDBusServer; } @@ -144,23 +141,23 @@ 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; //! @} // -------- parts which can run in core and GUI, referring to local voice client ------------ - //! Audio devices //! @{ + //! Audio devices BlackMisc::Audio::CAudioDeviceInfoList getAudioDevices() const; BlackMisc::Audio::CAudioDeviceInfoList getAudioInputDevices() const; BlackMisc::Audio::CAudioDeviceInfoList getAudioOutputDevices() const; @@ -176,8 +173,8 @@ namespace BlackCore //! Set current audio devices void setCurrentAudioDevices(const BlackMisc::Audio::CAudioDeviceInfo &inputDevice, const BlackMisc::Audio::CAudioDeviceInfo &outputDevice); - //! Volume //! @{ + //! Volume void setMasterOutputVolume(int volume); void setComOutputVolume(BlackMisc::Aviation::CComSystem::ComUnit comUnit, int volume); int getMasterOutputVolume() const; @@ -192,14 +189,14 @@ namespace BlackCore //! Notification sounds void playNotification(BlackMisc::Audio::CNotificationSounds::NotificationFlag notification, bool considerSettings, int volume = -1); - //! Loopback //! @{ + //! Loopback void enableAudioLoopback(bool enable = true); bool isAudioLoopbackEnabled() const; //! @} - //! Voice setup //! @{ + //! Voice setup BlackMisc::Audio::CVoiceSetup getVoiceSetup() const; void setVoiceSetup(const BlackMisc::Audio::CVoiceSetup &setup); //! @} @@ -295,8 +292,8 @@ namespace BlackCore * Workaround those must be invisible for DBus * - //! VU levels //! @{ + //! VU levels void inputVolumePeakVU (double value); void outputVolumePeakVU(double value); //! @} @@ -318,8 +315,8 @@ namespace BlackCore //! Terminate the voice client void terminateVoiceClient(); - //! Enable/disable voice transmission, nornally used with hotkey //! @{ + //! Enable/disable voice transmission, nornally used with hotkey void setVoiceTransmission(bool enable, BlackMisc::Audio::PTTCOM com); void setVoiceTransmissionComActive(bool enabled); //! @} @@ -333,8 +330,8 @@ namespace BlackCore //! Changed voice settings void onChangedVoiceSettings(); - //! Audio increase/decrease volume //! @{ + //! Audio increase/decrease volume void audioIncreaseVolume(bool enabled); void audioDecreaseVolume(bool enabled); void audioIncreaseVolumeCom1(bool enabled); diff --git a/src/blackcore/context/contextaudioimpl.h b/src/blackcore/context/contextaudioimpl.h index 2874158e6..5b7ff0b5b 100644 --- a/src/blackcore/context/contextaudioimpl.h +++ b/src/blackcore/context/contextaudioimpl.h @@ -42,9 +42,6 @@ namespace BlackCore friend class IContextAudio; public slots: - // Interface implementations for DBus - //! \publicsection - //! @{ virtual BlackMisc::Audio::CAudioDeviceInfoList getRegisteredDevices() const override; virtual void registerDevices(const BlackMisc::Audio::CAudioDeviceInfoList &devices) override; virtual void unRegisterDevices(const BlackMisc::Audio::CAudioDeviceInfoList &devices) override; @@ -52,7 +49,6 @@ namespace BlackCore virtual void registerAudioCallsign(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::CIdentifier &identifier) override; virtual void unRegisterAudioCallsign(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::CIdentifier &identifier) override; virtual bool hasRegisteredAudioCallsign(const BlackMisc::Aviation::CCallsign &callsign) const override; - //! @} protected: //! Constructor diff --git a/src/blackcore/context/contextaudioproxy.h b/src/blackcore/context/contextaudioproxy.h index a94333bd7..ed364cb90 100644 --- a/src/blackcore/context/contextaudioproxy.h +++ b/src/blackcore/context/contextaudioproxy.h @@ -58,10 +58,6 @@ namespace BlackCore static void unitTestRelaySignals(); public slots: - //! All DBus interface overrides - //! \publicsection - //! @{ - //! Register a device on a machine (for core/GUI it will return all known devices on all machines) virtual BlackMisc::Audio::CAudioDeviceInfoList getRegisteredDevices() const override; virtual void registerDevices(const BlackMisc::Audio::CAudioDeviceInfoList &devices) override; virtual void unRegisterDevices(const BlackMisc::Audio::CAudioDeviceInfoList &devices) override; @@ -69,7 +65,6 @@ namespace BlackCore virtual void registerAudioCallsign(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::CIdentifier &identifier) override; virtual void unRegisterAudioCallsign(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::CIdentifier &identifier) override; virtual bool hasRegisteredAudioCallsign(const BlackMisc::Aviation::CCallsign &callsign) const override; - //! @} private: BlackMisc::CGenericDBusInterface *m_dBusInterface; diff --git a/src/blackcore/context/contextnetwork.h b/src/blackcore/context/contextnetwork.h index 4ec253927..51ff4d1f4 100644 --- a/src/blackcore/context/contextnetwork.h +++ b/src/blackcore/context/contextnetwork.h @@ -44,17 +44,14 @@ // clazy:excludeall=const-signal-or-slot -//! \addtogroup dbus -//! @{ - //! DBus interface for context +//! \addtogroup dbus #define BLACKCORE_CONTEXTNETWORK_INTERFACENAME "org.swift_project.blackcore.contextnetwork" //! DBus object path for context +//! \addtogroup dbus #define BLACKCORE_CONTEXTNETWORK_OBJECTPATH "/network" -//! @} - class QDBusConnection; namespace BlackMisc { diff --git a/src/blackcore/context/contextnetworkimpl.h b/src/blackcore/context/contextnetworkimpl.h index fb468362c..9d54ccc9a 100644 --- a/src/blackcore/context/contextnetworkimpl.h +++ b/src/blackcore/context/contextnetworkimpl.h @@ -95,8 +95,7 @@ namespace BlackCore //! Destructor virtual ~CContextNetwork() override; - //! \ingroup remoteaircraftprovider - //! @{ + // remoteaircraftprovider virtual BlackMisc::Aviation::CAircraftSituationList remoteAircraftSituations(const BlackMisc::Aviation::CCallsign &callsign) const override; virtual BlackMisc::Aviation::CAircraftSituation remoteAircraftSituation(const BlackMisc::Aviation::CCallsign &callsign, int index) const override; virtual BlackMisc::MillisecondsMinMaxMean remoteAircraftSituationsTimestampDifferenceMinMaxMean(const BlackMisc::Aviation::CCallsign &callsign) const override; @@ -126,10 +125,8 @@ namespace BlackCore std::function removedAircraftSlot, std::function aircraftSnapshotSlot ) override; - //! @} - //! \ingroup clientprovider - //! @{ + // clientprovider virtual void setClients(const BlackMisc::Network::CClientList &clients) override; virtual void clearClients() override; virtual BlackMisc::Network::CClient getClientOrDefaultForCallsign(const BlackMisc::Aviation::CCallsign &callsign) const override; @@ -141,7 +138,6 @@ namespace BlackCore virtual bool addClientGndCapability(const BlackMisc::Aviation::CCallsign &callsign) override; virtual bool setClientGndCapability(const BlackMisc::Aviation::CCallsign &callsign, bool supportGndFlag) override; virtual void markAsSwiftClient(const BlackMisc::Aviation::CCallsign &callsign) override; - //! @} //! \copydoc IContextNetwork::connectRawFsdMessageSignal virtual QMetaObject::Connection connectRawFsdMessageSignal(QObject *receiver, RawFsdMessageReceivedSlot rawFsdMessageReceivedSlot) override; @@ -149,21 +145,20 @@ namespace BlackCore //! Gracefully shut down, e.g. for thread safety void gracefulShutdown(); + //! Network library //! \protected //! \remarks normally only for core facade internal usage //! \remarks public so values can be logged/monitored - //! @{ - //! Network library Fsd::CFSDClient *fsdClient() const { return m_fsdClient; } //! Airspace + //! \protected + //! \remarks normally only for core facade internal usage + //! \remarks public so values can be logged/monitored CAirspaceMonitor *airspace() const { return m_airspace; } - //! @} public slots: - // ------------ from context and provider interface ------------- - //! \ingroup remoteaircraftprovider - //! @{ + // remoteaircraftprovider // emit signal when changed virtual bool updateAircraftEnabled(const BlackMisc::Aviation::CCallsign &callsign, bool enabledForRendering) override; @@ -203,14 +198,11 @@ namespace BlackCore virtual bool testAddAltitudeOffset(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::PhysicalQuantities::CLength &offset = BlackMisc::PhysicalQuantities::CLength::null()) override; virtual QStringList getNetworkPresetValues() const override; virtual BlackMisc::Aviation::CCallsign getPartnerCallsign() const override; - //! @} - //! \ingroup clientprovider - //! @{ + // clientprovider virtual BlackMisc::Network::CClientList getClients() const override; virtual BlackMisc::Network::CClientList getClientsForCallsigns(const BlackMisc::Aviation::CCallsignSet &callsigns) const override; virtual bool setOtherClient(const BlackMisc::Network::CClient &client) override; - //! @} //! In transition state, e.g. connecting, disconnecting. //! \details In such a state it is advisable to wait until an end state (connected/disconnected) is reached @@ -219,7 +211,6 @@ namespace BlackCore // --------------------- IContextNetwork implementations --------------------- //! \addtogroup swiftdotcommands - //! @{ //! 
             //! .m .msg .chat callsign|freq. message   message text
             //! .altos .altoffset                      altitude offset for testing
@@ -228,7 +219,6 @@ namespace BlackCore
             //! .watchdog on|off                       watchdog on/off
             //! .wallop message                        send wallop message
             //!
- //! @} //! \copydoc IContextNetwork::parseCommandLine virtual bool parseCommandLine(const QString &commandLine, const BlackMisc::CIdentifier &originator) override; @@ -250,8 +240,6 @@ namespace BlackCore BlackMisc::CSimpleCommandParser::registerCommand({".disable callsign", "disable/ignore callsign"}); } - //! \publicsection - //! @{ virtual void requestAtcBookingsUpdate() const override; virtual BlackMisc::Aviation::CAtcStationList getAtcStationsBooked(bool recalculateDistance) const override; virtual BlackMisc::Aviation::CAtcStationList getAtcStationsOnline(bool recalculateDistance) const override; @@ -284,7 +272,6 @@ namespace BlackCore virtual void testReceivedAtisMessage(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::Aviation::CInformationMessage &msg) override; virtual void testReceivedTextMessages(const BlackMisc::Network::CTextMessageList &textMessages) override; virtual void testRequestAircraftConfig(const BlackMisc::Aviation::CCallsign &callsign) override; - //! @} // --------------------- IContextNetwork implementations --------------------- protected: diff --git a/src/blackcore/context/contextownaircraft.h b/src/blackcore/context/contextownaircraft.h index cdf8847c8..7e4a9d70d 100644 --- a/src/blackcore/context/contextownaircraft.h +++ b/src/blackcore/context/contextownaircraft.h @@ -29,17 +29,14 @@ // clazy:excludeall=const-signal-or-slot -//! \addtogroup dbus -//! @{ - //! DBus interface for context +//! \addtogroup dbus #define BLACKCORE_CONTEXTOWNAIRCRAFT_INTERFACENAME "org.swift_project.blackcore.contextownaircraft" //! DBus object path for context +//! \addtogroup dbus #define BLACKCORE_CONTEXTOWNAIRCRAFT_OBJECTPATH "/ownaircraft" -//! @} - class QDBusConnection; namespace BlackMisc { diff --git a/src/blackcore/context/contextownaircraftimpl.h b/src/blackcore/context/contextownaircraftimpl.h index 2812a71bb..8f0ae73f2 100644 --- a/src/blackcore/context/contextownaircraftimpl.h +++ b/src/blackcore/context/contextownaircraftimpl.h @@ -177,14 +177,12 @@ namespace BlackCore virtual bool setTransponderMode(BlackMisc::Aviation::CTransponder::TransponderMode mode) override; //! \addtogroup swiftdotcommands - //! @{ //! 
             //! .x    .xpdr  code       set transponder code    BlackCore::Context::CContextOwnAircraft
             //! .x    .xpdr  mode       set transponder mode    BlackCore::Context::CContextOwnAircraft
             //! .com1 .com2  frequency  set COM1/2 frequency    BlackCore::Context::CContextOwnAircraft
             //! .selcal      code       set SELCAL code         BlackCore::Context::CContextOwnAircraft
             //!
- //! @} //! \copydoc IContextOwnAircraft::parseCommandLine virtual bool parseCommandLine(const QString &commandLine, const BlackMisc::CIdentifier &originator) override; @@ -237,8 +235,8 @@ namespace BlackCore //! \ingroup crosscontextfunction void xCtxChangedSimulatorStatus(int status); - //! Actions //! @{ + //! Actions void actionToggleTransponder(bool keydown); void actionIdent(bool keydown); //! @} diff --git a/src/blackcore/context/contextownaircraftproxy.h b/src/blackcore/context/contextownaircraftproxy.h index ee0375b8d..a8164f7d4 100644 --- a/src/blackcore/context/contextownaircraftproxy.h +++ b/src/blackcore/context/contextownaircraftproxy.h @@ -62,8 +62,6 @@ namespace BlackCore static void unitTestRelaySignals(); public slots: - //! \publicsection - //! @{ virtual BlackMisc::Simulation::CSimulatedAircraft getOwnAircraft() const override; virtual BlackMisc::Aviation::CComSystem getOwnComSystem(BlackMisc::Aviation::CComSystem::ComUnit unit) const override; virtual BlackMisc::Aviation::CTransponder getOwnTransponder() const override; @@ -79,7 +77,6 @@ namespace BlackCore virtual void toggleTransponderMode() override; virtual bool setTransponderMode(BlackMisc::Aviation::CTransponder::TransponderMode mode) override; virtual bool parseCommandLine(const QString &commandLine, const BlackMisc::CIdentifier &originator) override; - //! @} protected: //! \brief Constructor diff --git a/src/blackcore/context/contextsimulator.h b/src/blackcore/context/contextsimulator.h index c9dd5c605..bcdfed762 100644 --- a/src/blackcore/context/contextsimulator.h +++ b/src/blackcore/context/contextsimulator.h @@ -40,17 +40,14 @@ // clazy:excludeall=const-signal-or-slot -//! \addtogroup dbus -//! @{ - //! DBus interface for context +//! \addtogroup dbus #define BLACKCORE_CONTEXTSIMULATOR_INTERFACENAME "org.swift_project.blackcore.contextsimulator" //! DBus object path for context +//! \addtogroup dbus #define BLACKCORE_CONTEXTSIMULATOR_OBJECTPATH "/simulator" -//! @} - class QDBusConnection; namespace BlackMisc diff --git a/src/blackcore/context/contextsimulatorimpl.h b/src/blackcore/context/contextsimulatorimpl.h index e3774ab91..3460c02cd 100644 --- a/src/blackcore/context/contextsimulatorimpl.h +++ b/src/blackcore/context/contextsimulatorimpl.h @@ -75,8 +75,6 @@ namespace BlackCore public slots: // ----------------------------- context interface ----------------------------- - //! \publicsection - //! @{ virtual BlackMisc::Simulation::CSimulatorPluginInfo getSimulatorPluginInfo() const override; virtual BlackMisc::Simulation::CSimulatorPluginInfoList getAvailableSimulatorPlugins() const override; virtual BlackMisc::Simulation::Settings::CSimulatorSettings getSimulatorSettings() const override; @@ -135,10 +133,8 @@ namespace BlackCore // also in IAircraftModelSetProvider virtual BlackMisc::Simulation::CAircraftModelList getModelSet() const override; virtual int getModelSetCount() const override; - //! @} //! \addtogroup swiftdotcommands - //! @{ //! 
             //! .plugin           forwarded to plugin, see details there
             //! .driver .drv      forwarded to plugin (same as above)
@@ -146,7 +142,6 @@ namespace BlackCore
             //! .ris debug on|off interpolation/rendering setup, debug messages
             //! .ris parts on|off interpolation/rendering setup, aircraft parts
             //!
- //! @} //! \copydoc IContextSimulator::parseCommandLine virtual bool parseCommandLine(const QString &commandLine, const BlackMisc::CIdentifier &originator) override; // ----------------------------- context interface ----------------------------- @@ -189,39 +184,46 @@ namespace BlackCore static constexpr int MaxModelAddedFailoverTrials = 3; //!< if model cannot be added, try again max times // ------------ slots connected with network or other contexts --------- - //! \ingroup crosscontextfunction - //! @{ //! Remote aircraft added and ready for model matching + //! \ingroup crosscontextfunction void xCtxAddedRemoteAircraftReadyForModelMatching(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft); //! Remove remote aircraft + //! \ingroup crosscontextfunction void xCtxRemovedRemoteAircraft(const BlackMisc::Aviation::CCallsign &callsign); //! Changed remote aircraft model + //! \ingroup crosscontextfunction void xCtxChangedRemoteAircraftModel(const BlackMisc::Simulation::CSimulatedAircraft &aircraft, const BlackMisc::CIdentifier &originator); //! Changed own aircraft model + //! \ingroup crosscontextfunction void xCtxChangedOwnAircraftModel(const BlackMisc::Simulation::CAircraftModel &aircraftModel, const BlackMisc::CIdentifier &originator); //! Enable / disable aircraft + //! \ingroup crosscontextfunction void xCtxChangedRemoteAircraftEnabled(const BlackMisc::Simulation::CSimulatedAircraft &aircraft); //! Network connection status + //! \ingroup crosscontextfunction void xCtxNetworkConnectionStatusChanged(const BlackMisc::Network::CConnectionStatus &from, const BlackMisc::Network::CConnectionStatus &to); //! Update simulator cockpit from context, because someone else has changed cockpit (e.g. GUI, 3rd party) + //! \ingroup crosscontextfunction void xCtxUpdateSimulatorCockpitFromContext(const BlackMisc::Simulation::CSimulatedAircraft &ownAircraft, const BlackMisc::CIdentifier &originator); //! Update simulator SELCAL from context, because someone else has changed cockpit (e.g. GUI, 3rd party) + //! \ingroup crosscontextfunction void xCtxUpdateSimulatorSelcalFromContext(const BlackMisc::Aviation::CSelcal &selcal, const BlackMisc::CIdentifier &originator); //! Raw data when a new aircraft was requested, used for statistics + //! \ingroup crosscontextfunction void xCtxNetworkRequestedNewAircraft(const BlackMisc::Aviation::CCallsign &callsign, const QString &aircraftIcao, const QString &airlineIcao, const QString &livery); //! Text message received + //! \ingroup crosscontextfunction void xCtxTextMessagesReceived(const BlackMisc::Network::CTextMessageList &textMessages); - //! @} // ------------ slots connected with network or other contexts --------- //! Handle new connection status of simulator diff --git a/src/blackcore/fsd/atcdataupdate.h b/src/blackcore/fsd/atcdataupdate.h index e24f362a9..6f7f33d17 100644 --- a/src/blackcore/fsd/atcdataupdate.h +++ b/src/blackcore/fsd/atcdataupdate.h @@ -35,8 +35,8 @@ namespace BlackCore::Fsd //! 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 db2973e8e..28ea06af1 100644 --- a/src/blackcore/fsd/clientidentification.h +++ b/src/blackcore/fsd/clientidentification.h @@ -35,8 +35,8 @@ namespace BlackCore::Fsd //! 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 53e94ab58..ef1108593 100644 --- a/src/blackcore/fsd/clientquery.h +++ b/src/blackcore/fsd/clientquery.h @@ -37,8 +37,8 @@ namespace BlackCore::Fsd //! 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 0ab4f7e44..eff929dbc 100644 --- a/src/blackcore/fsd/clientresponse.h +++ b/src/blackcore/fsd/clientresponse.h @@ -35,8 +35,8 @@ namespace BlackCore::Fsd //! 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 a0e512131..7b953e75a 100644 --- a/src/blackcore/fsd/enums.h +++ b/src/blackcore/fsd/enums.h @@ -176,8 +176,8 @@ namespace BlackCore::Fsd AircraftConfig = (1 << 9) }; - //! Operators //! @{ + //! Operators inline Capabilities operator | (Capabilities lhs, Capabilities rhs) { return static_cast(static_cast(lhs) | static_cast(rhs)); diff --git a/src/blackcore/fsd/euroscopesimdata.h b/src/blackcore/fsd/euroscopesimdata.h index b94567ca8..71c92bc0a 100644 --- a/src/blackcore/fsd/euroscopesimdata.h +++ b/src/blackcore/fsd/euroscopesimdata.h @@ -35,8 +35,8 @@ namespace BlackCore::Fsd //! PDU identifier static QString pdu() { return QStringLiteral("SIMDATA"); } - //! Properties //! @{ + //! Properties QString m_model; QString m_livery; quint64 m_timestamp = 0; diff --git a/src/blackcore/fsd/flightplan.h b/src/blackcore/fsd/flightplan.h index 7d4aa5f51..5c68d0c0f 100644 --- a/src/blackcore/fsd/flightplan.h +++ b/src/blackcore/fsd/flightplan.h @@ -35,8 +35,8 @@ namespace BlackCore::Fsd //! PDU identifier static QString pdu() { return "$FP"; } - //! Properties //! @{ + //! Properties FlightType m_flightType {}; QString m_aircraftIcaoType; int m_trueCruisingSpeed = 0; diff --git a/src/blackcore/fsd/fsdclient.h b/src/blackcore/fsd/fsdclient.h index a2ad6adbb..93574c203 100644 --- a/src/blackcore/fsd/fsdclient.h +++ b/src/blackcore/fsd/fsdclient.h @@ -50,8 +50,8 @@ #include -//! Protocol version //! @{ +//! Protocol version #define PROTOCOL_REVISION_CLASSIC 9 #define PROTOCOL_REVISION_VATSIM_ATC 10 #define PROTOCOL_REVISION_VATSIM_AUTH 100 @@ -96,10 +96,10 @@ namespace BlackCore::Fsd BlackMisc::Simulation::IRemoteAircraftProvider *remoteAircraftProvider, QObject *owner = nullptr); + //! @{ //! Preset functions //! \remark Necessary functions to setup client. Set them all! //! \threadsafe - //! @{ void setClientName(const QString &clientName) { QWriteLocker l(&m_lockUserClientBuffered); m_clientName = clientName; } void setHostApplication(const QString &hostApplication) { QWriteLocker l(&m_lockUserClientBuffered); m_hostApplication = hostApplication; } void setVersion(int major, int minor) { QWriteLocker l(&m_lockUserClientBuffered); m_versionMajor = major; m_versionMinor = minor; } @@ -143,22 +143,22 @@ namespace BlackCore::Fsd //! \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); } //! @} + //! @{ //! Convenience functions for sendClientQuery //! \remark pseudo private, used in CAirspaceMonitor and network context //! \private - //! @{ void sendClientQueryCapabilities(const BlackMisc::Aviation::CCallsign &callsign); void sendClientQueryCom1Freq(const BlackMisc::Aviation::CCallsign &callsign); void sendClientQueryRealName(const BlackMisc::Aviation::CCallsign &callsign); @@ -175,22 +175,22 @@ namespace BlackCore::Fsd 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; } //! @} @@ -208,8 +208,8 @@ namespace BlackCore::Fsd 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); @@ -256,11 +256,9 @@ namespace BlackCore::Fsd private: //! \cond friend BlackFsdTest::CTestFSDClient; - //! \endcond - //! Convenience functions for sendClientQuery - //! \remark really private, ONLY used by UNIT test, not CAirspaceMonitor - //! @{ + // Convenience functions for sendClientQuery + // really private, ONLY used by UNIT test, not CAirspaceMonitor void sendLogin(const QString &token = {}); void sendDeletePilot(); void sendDeleteAtc(); @@ -279,10 +277,10 @@ namespace BlackCore::Fsd // void sendMessageString(const QString &message); void sendQueuedMessage(); - //! @} + //! \endcond - //! 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); //! @} @@ -308,8 +306,8 @@ namespace BlackCore::Fsd this->sendMessageString(messageToFSDString(message)); } - //! Unit test/debug functions //! @{ + //! Unit test/debug functions void sendFsdMessage(const QString &message); void setUnitTestMode(bool on) { m_unitTestMode = on; } //! @} @@ -360,8 +358,8 @@ namespace BlackCore::Fsd // 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); @@ -441,8 +439,8 @@ namespace BlackCore::Fsd //! 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 a5139ec7d..f73506694 100644 --- a/src/blackcore/fsd/fsdidentification.h +++ b/src/blackcore/fsd/fsdidentification.h @@ -31,8 +31,8 @@ namespace BlackCore::Fsd //! 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 90e7e8a53..583d8ffe0 100644 --- a/src/blackcore/fsd/interimpilotdataupdate.h +++ b/src/blackcore/fsd/interimpilotdataupdate.h @@ -33,8 +33,8 @@ namespace BlackCore::Fsd //! 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 61e078c3b..a1c47097f 100644 --- a/src/blackcore/fsd/pilotdataupdate.h +++ b/src/blackcore/fsd/pilotdataupdate.h @@ -35,8 +35,8 @@ namespace BlackCore::Fsd //! 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 ff3dae0fb..b41de77ad 100644 --- a/src/blackcore/fsd/planeinforequestfsinn.h +++ b/src/blackcore/fsd/planeinforequestfsinn.h @@ -36,8 +36,8 @@ namespace BlackCore::Fsd //! 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 c7b3e54ba..eaf5ce1f7 100644 --- a/src/blackcore/fsd/planeinformation.h +++ b/src/blackcore/fsd/planeinformation.h @@ -32,8 +32,8 @@ namespace BlackCore::Fsd //! 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 eb63349b1..37351e2a7 100644 --- a/src/blackcore/fsd/planeinformationfsinn.h +++ b/src/blackcore/fsd/planeinformationfsinn.h @@ -36,8 +36,8 @@ namespace BlackCore::Fsd //! PDU identifier static QString pdu() { return "#SB"; } - //! Properties //! @{ + //! Properties QString m_airlineIcao; QString m_aircraftIcao; QString m_aircraftIcaoCombinedType; diff --git a/src/blackcore/fsd/rehost.h b/src/blackcore/fsd/rehost.h index db4bf8181..ee8b69f19 100644 --- a/src/blackcore/fsd/rehost.h +++ b/src/blackcore/fsd/rehost.h @@ -32,8 +32,8 @@ namespace BlackCore::Fsd //! PDU identifier static QString pdu() { return "$XX"; } - //! Properties //! @{ + //! Properties QString m_hostname; //! @} diff --git a/src/blackcore/fsd/revbclientparts.h b/src/blackcore/fsd/revbclientparts.h index 28cf284b6..0c425b1a3 100644 --- a/src/blackcore/fsd/revbclientparts.h +++ b/src/blackcore/fsd/revbclientparts.h @@ -36,15 +36,10 @@ namespace BlackCore::Fsd //! PDU identifier static QString pdu() { return "-MD"; } - //! Properties //! @{ + //! Properties ClientQueryType m_queryType = ClientQueryType::Unknown; QStringList m_queryData; - //! @} - - - //! Properties - //! @{ QString m_partsval1; QString m_partsval2; QString m_partsval3; diff --git a/src/blackcore/fsd/servererror.h b/src/blackcore/fsd/servererror.h index b897cda39..7e34ecf1f 100644 --- a/src/blackcore/fsd/servererror.h +++ b/src/blackcore/fsd/servererror.h @@ -35,14 +35,14 @@ namespace BlackCore::Fsd //! 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/fsd/visualpilotdataperiodic.h b/src/blackcore/fsd/visualpilotdataperiodic.h index 8ee6323d6..01e3d5bac 100644 --- a/src/blackcore/fsd/visualpilotdataperiodic.h +++ b/src/blackcore/fsd/visualpilotdataperiodic.h @@ -39,8 +39,8 @@ namespace BlackCore::Fsd //! Return a regular visual update with the same values VisualPilotDataUpdate toUpdate() const; - //! Properties //! @{ + //! Properties double m_latitude = 0.0; double m_longitude = 0.0; double m_altitudeTrue = 0.0; diff --git a/src/blackcore/fsd/visualpilotdatastopped.h b/src/blackcore/fsd/visualpilotdatastopped.h index aa0251ea5..6ed05dcf5 100644 --- a/src/blackcore/fsd/visualpilotdatastopped.h +++ b/src/blackcore/fsd/visualpilotdatastopped.h @@ -38,8 +38,8 @@ namespace BlackCore::Fsd //! Return a regular visual update with the same values VisualPilotDataUpdate toUpdate() const; - //! Properties //! @{ + //! Properties double m_latitude = 0.0; double m_longitude = 0.0; double m_altitudeTrue = 0.0; diff --git a/src/blackcore/fsd/visualpilotdatatoggle.h b/src/blackcore/fsd/visualpilotdatatoggle.h index bac626cc2..e3caab27d 100644 --- a/src/blackcore/fsd/visualpilotdatatoggle.h +++ b/src/blackcore/fsd/visualpilotdatatoggle.h @@ -32,8 +32,8 @@ namespace BlackCore::Fsd //! PDU identifier static QString pdu() { return "$SF"; } - //! Properties //! @{ + //! Properties QString m_client; bool m_active = false; //! @} diff --git a/src/blackcore/fsd/visualpilotdataupdate.h b/src/blackcore/fsd/visualpilotdataupdate.h index 17a41a367..8c623f36f 100644 --- a/src/blackcore/fsd/visualpilotdataupdate.h +++ b/src/blackcore/fsd/visualpilotdataupdate.h @@ -43,8 +43,8 @@ namespace BlackCore::Fsd //! Return a stopped update with the same values VisualPilotDataStopped toStopped() const; - //! Properties //! @{ + //! Properties double m_latitude = 0.0; double m_longitude = 0.0; double m_altitudeTrue = 0.0; diff --git a/src/blackcore/simulator.h b/src/blackcore/simulator.h index 659d31218..2d0edcd91 100644 --- a/src/blackcore/simulator.h +++ b/src/blackcore/simulator.h @@ -286,7 +286,6 @@ namespace BlackCore bool isEmulatedDriver() const; //! \addtogroup swiftdotcommands - //! @{ //! 
         //! .drv cg length clear|modelstring  set overridden CG for model string      BlackCore::ISimulator
         //! .drv unload                       unload plugin                           BlackCore::ISimulator
@@ -302,7 +301,6 @@ namespace BlackCore
         //! .drv aircraft rm callsign         remove aircraft                         BlackCore::ISimulator
         //! .drv fsuipc   on|off              enable/disable FSUIPC (if applicable)   BlackSimPlugin::FsCommon::CSimulatorFsCommon
         //!
- //! @} //! Parse command line for simulator drivers, derived classes can add specific parsing by overriding ISimulator::parseDetails virtual bool parseCommandLine(const QString &commandLine, const BlackMisc::CIdentifier &originator); @@ -423,8 +421,8 @@ namespace BlackCore BlackMisc::Network::IClientProvider *clientProvider, QObject *parent = nullptr); - //! When swift DB data are read //! @{ + //! When swift DB data are read virtual void onSwiftDbAllDataRead(); virtual void onSwiftDbModelMatchingEntitiesRead(); virtual void onSwiftDbAirportsRead(); @@ -445,11 +443,8 @@ namespace BlackCore //! Max.airports in range int maxAirportsInRange() const; - //! 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); - //! @} //! Add new remote aircraft physically to the simulator //! \sa changeRemoteAircraftEnabled to hide a remote aircraft @@ -738,8 +733,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/vatsim/vatsimbookingreader.h b/src/blackcore/vatsim/vatsimbookingreader.h index aef8b37b5..6ff11441f 100644 --- a/src/blackcore/vatsim/vatsimbookingreader.h +++ b/src/blackcore/vatsim/vatsimbookingreader.h @@ -48,10 +48,8 @@ namespace BlackCore::Vatsim void dataRead(BlackMisc::Network::CEntityFlags::Entity entity, BlackMisc::Network::CEntityFlags::ReadState state, int number, const QUrl &url); protected: - //! \name BlackCore::CThreadedReader overrides - //! @{ + // CThreadedReader overrides virtual void doWorkImpl() override; - //! @} private: //! Bookings have been read diff --git a/src/blackcore/vatsim/vatsimdatafilereader.h b/src/blackcore/vatsim/vatsimdatafilereader.h index 6b1f981ed..2dff17b15 100644 --- a/src/blackcore/vatsim/vatsimdatafilereader.h +++ b/src/blackcore/vatsim/vatsimdatafilereader.h @@ -124,10 +124,8 @@ namespace BlackCore::Vatsim void dataRead(BlackMisc::Network::CEntityFlags::Entity entity, BlackMisc::Network::CEntityFlags::ReadState state, int number, const QUrl &url); protected: - //! \name BlackCore::CThreadedReader overrides - //! @{ + // CThreadedReader overrides virtual void doWorkImpl() override; - //! @} private: //! Section in file diff --git a/src/blackcore/vatsim/vatsimmetarreader.h b/src/blackcore/vatsim/vatsimmetarreader.h index ce1a5509a..61b64713f 100644 --- a/src/blackcore/vatsim/vatsimmetarreader.h +++ b/src/blackcore/vatsim/vatsimmetarreader.h @@ -60,10 +60,8 @@ namespace BlackCore::Vatsim void dataRead(BlackMisc::Network::CEntityFlags::Entity entity, BlackMisc::Network::CEntityFlags::ReadState state, int number, const QUrl &url); protected: - //! \name BlackCore::CThreadedReader overrides - //! @{ + // CThreadedReader overrides virtual void doWorkImpl() override; - //! @} private: //! Decode METARs diff --git a/src/blackcore/webdataservicesms.h b/src/blackcore/webdataservicesms.h index dabb195f2..bbbca0631 100644 --- a/src/blackcore/webdataservicesms.h +++ b/src/blackcore/webdataservicesms.h @@ -30,8 +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 6184b9618..a30d2577d 100644 --- a/src/blackgui/components/audioadvanceddistributedcomponent.h +++ b/src/blackgui/components/audioadvanceddistributedcomponent.h @@ -43,8 +43,8 @@ namespace BlackGui::Components //! 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 ca3065c98..8eee2aeba 100644 --- a/src/blackgui/components/audiodevicevolumesetupcomponent.h +++ b/src/blackgui/components/audiodevicevolumesetupcomponent.h @@ -40,24 +40,24 @@ namespace BlackGui::Components //! 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; int getOutValueCom1(int from = BlackMisc::Audio::CSettings::OutMin, int to = BlackMisc::Audio::CSettings::OutMax) const; int getOutValueCom2(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::InMin, int to = BlackMisc::Audio::CSettings::InMax); void setOutValueCom1(int value, int from = BlackMisc::Audio::CSettings::OutMin, int to = BlackMisc::Audio::CSettings::OutMax); void setOutValueCom2(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); //! @} @@ -134,8 +134,8 @@ namespace BlackGui::Components 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 941984eeb..ed63727db 100644 --- a/src/blackgui/components/cgsourceselector.h +++ b/src/blackgui/components/cgsourceselector.h @@ -30,8 +30,8 @@ namespace BlackGui::Components //! 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 4b669dabd..379ec73fc 100644 --- a/src/blackgui/components/cockpitcomcomponent.h +++ b/src/blackgui/components/cockpitcomcomponent.h @@ -55,8 +55,8 @@ namespace BlackGui::Components //! \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 899c6abb3..ef3a04f78 100644 --- a/src/blackgui/components/cockpitcomponent.h +++ b/src/blackgui/components/cockpitcomponent.h @@ -64,8 +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 f7dbb6a3a..a3ce0f8ff 100644 --- a/src/blackgui/components/dbmappingcomponentaware.h +++ b/src/blackgui/components/dbmappingcomponentaware.h @@ -42,8 +42,8 @@ namespace BlackGui::Components //! 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 e92cc15ea..8234a656d 100644 --- a/src/blackgui/components/networkdetailscomponent.h +++ b/src/blackgui/components/networkdetailscomponent.h @@ -85,8 +85,8 @@ namespace BlackGui::Components //! 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 fa742defd..94761e191 100644 --- a/src/blackgui/components/settingstextmessagestyle.h +++ b/src/blackgui/components/settingstextmessagestyle.h @@ -42,8 +42,8 @@ namespace BlackGui::Components //! 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 455fd554a..8768e42f6 100644 --- a/src/blackgui/components/textmessagecomponent.h +++ b/src/blackgui/components/textmessagecomponent.h @@ -56,8 +56,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(); //! @} @@ -169,8 +169,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 7530614a6..a1868b3c4 100644 --- a/src/blackgui/dockwidget.h +++ b/src/blackgui/dockwidget.h @@ -151,8 +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 55255fa27..4c45d6b76 100644 --- a/src/blackgui/editors/cockpitcomform.h +++ b/src/blackgui/editors/cockpitcomform.h @@ -79,8 +79,8 @@ namespace BlackGui::Editors //! 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 8c189bba0..8ff621607 100644 --- a/src/blackgui/editors/matchingform.h +++ b/src/blackgui/editors/matchingform.h @@ -69,8 +69,8 @@ namespace BlackGui::Editors //! Airline group changed void onAirlineGroupChanged(); - //! Reset //! @{ + //! Reset void resetByAlgorithm(); void resetAll(); //! @} diff --git a/src/blackgui/editors/pbhsform.h b/src/blackgui/editors/pbhsform.h index 94a858158..f745f0ec2 100644 --- a/src/blackgui/editors/pbhsform.h +++ b/src/blackgui/editors/pbhsform.h @@ -86,8 +86,8 @@ namespace BlackGui::Editors //! 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 7474bfc12..2d58ffcae 100644 --- a/src/blackgui/editors/situationform.h +++ b/src/blackgui/editors/situationform.h @@ -84,8 +84,8 @@ namespace BlackGui::Editors //! 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 0f44c4d59..41ebe794e 100644 --- a/src/blackgui/guiapplication.h +++ b/src/blackgui/guiapplication.h @@ -122,13 +122,11 @@ namespace BlackGui //! Set window title QString setExtraWindowTitle(const QString &extraInfo, QWidget *mainWindowWidget = mainApplicationWidget()) const; - //! \name print warning message - //! @{ + //! print warning message virtual bool cmdLineWarningMessage(const QString &text, const QString &informativeText) const override; - //! @} - //! \name print messages generated during parsing / cmd handling //! @{ + //! print messages generated during parsing / cmd handling virtual bool cmdLineErrorMessage(const QString &text, const QString &informativeText = "", bool retry = false) const override; virtual bool cmdLineErrorMessage(const BlackMisc::CStatusMessageList &msgs, bool retry = false) const override; //! @} @@ -136,8 +134,8 @@ namespace BlackGui //! Window size reset mode set bool isCmdWindowSizeResetSet() const; - //! \name direct access to main application window //! @{ + //! direct access to main application window virtual bool displayInStatusBar(const BlackMisc::CStatusMessage &message) override; virtual bool displayTextInConsole(const QString &text) override; virtual bool displayInOverlayWindow(const BlackMisc::CStatusMessage &message, int timeOutMs = -1) override; @@ -152,8 +150,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); //! @} @@ -242,8 +240,8 @@ namespace BlackGui //! Toggle stay on top bool toggleStayOnTop(); - //! Window to front/back //! @{ + //! Window to front/back void windowToFront(); void windowToBack(); void windowToFrontBackToggle(); @@ -327,8 +325,8 @@ namespace BlackGui void alwaysOnTop(bool onTop); protected: - //! \name print messages generated during parsing / cmd handling //! @{ + //! print messages generated during parsing / cmd handling virtual void cmdLineHelpMessage() override; virtual void cmdLineVersionMessage() const override; //! @} diff --git a/src/blackgui/guiutility.h b/src/blackgui/guiutility.h index 50dd61c5b..74508e90b 100644 --- a/src/blackgui/guiutility.h +++ b/src/blackgui/guiutility.h @@ -85,8 +85,8 @@ namespace BlackGui //! Orientation as string static const QString &orientationAsString(Qt::ScreenOrientation orientation); - //! QRect, QSize as string //! @{ + //! QRect, QSize as string static QString rectAsString(const QRect &rect); static QString rectAsString(const QRectF &rect); static QString sizeAsString(const QSize &size); @@ -216,8 +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 4e658c765..05626a090 100644 --- a/src/blackgui/levelmeter.h +++ b/src/blackgui/levelmeter.h @@ -31,8 +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) @@ -54,8 +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 add9ea5e2..b7e9f291f 100644 --- a/src/blackgui/menus/fontmenus.h +++ b/src/blackgui/menus/fontmenus.h @@ -45,8 +45,8 @@ namespace BlackGui::Menus 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 e8b19ae81..8bea861bd 100644 --- a/src/blackgui/menus/menuaction.h +++ b/src/blackgui/menus/menuaction.h @@ -222,8 +222,8 @@ namespace BlackGui::Menus static const QString &pathDockWidgetNested() { static const QString p("DockWidget.Nested"); return p; } //! @} - //! Predefined sub sub menus //! @{ + //! Predefined sub sub menus static const CMenuAction &subMenuDatabase(); static const CMenuAction &subMenuSimulator(); static const CMenuAction &subMenuConsolidateModels(); diff --git a/src/blackgui/models/actionitem.h b/src/blackgui/models/actionitem.h index de9a60112..7d8c93307 100644 --- a/src/blackgui/models/actionitem.h +++ b/src/blackgui/models/actionitem.h @@ -34,8 +34,8 @@ namespace BlackGui::Models //! Destructor ~CActionItem(); - //! Not copyable //! @{ + //! Not copyable CActionItem(const CActionItem &) = delete; CActionItem &operator =(const CActionItem &) = delete; //! @} diff --git a/src/blackgui/models/columnformatters.h b/src/blackgui/models/columnformatters.h index 06d311163..050255b1c 100644 --- a/src/blackgui/models/columnformatters.h +++ b/src/blackgui/models/columnformatters.h @@ -144,8 +144,8 @@ namespace BlackGui::Models //! \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 e8f52dba5..e1eb02184 100644 --- a/src/blackgui/models/columns.h +++ b/src/blackgui/models/columns.h @@ -217,8 +217,8 @@ namespace BlackGui::Models //! 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 4d573b2e6..ba1ad74c9 100644 --- a/src/blackgui/views/atcstationtreeview.h +++ b/src/blackgui/views/atcstationtreeview.h @@ -109,8 +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 727905015..ec409eea9 100644 --- a/src/blackgui/views/simulatedaircraftview.h +++ b/src/blackgui/views/simulatedaircraftview.h @@ -86,14 +86,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 9bf8fe123..13d3c7b99 100644 --- a/src/blackgui/views/viewbase.h +++ b/src/blackgui/views/viewbase.h @@ -504,8 +504,8 @@ namespace BlackGui //! Settings have been changed void settingsChanged(); - //! Change selection modes //! @{ + //! Change selection modes void setMultiSelection(); void setExtendedSelection(); void setSingleSelection(); @@ -519,8 +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 f8f0d17bc..706d2a1f4 100644 --- a/src/blackmisc/audio/audiodeviceinfolist.h +++ b/src/blackmisc/audio/audiodeviceinfolist.h @@ -85,8 +85,8 @@ namespace BlackMisc::Audio //! 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 53c237835..4e79dbbbe 100644 --- a/src/blackmisc/audio/audiosettings.h +++ b/src/blackmisc/audio/audiosettings.h @@ -29,16 +29,16 @@ namespace BlackMisc::Audio 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); //! @} @@ -58,8 +58,8 @@ namespace BlackMisc::Audio //! 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 ca3088a13..cd40c4eb2 100644 --- a/src/blackmisc/aviation/aircraftsituation.h +++ b/src/blackmisc/aviation/aircraftsituation.h @@ -322,8 +322,8 @@ namespace BlackMisc //! \sa CAircraftSituation::presetGroundElevation bool interpolateElevation(const Aviation::CAircraftSituation &oldSituation, const Aviation::CAircraftSituation &newSituation); - //! Is on ground by elevation data, requires elevation and CG //! @{ + //! Is on ground by elevation data, requires elevation and CG IsOnGround isOnGroundByElevation() const; IsOnGround isOnGroundByElevation(const PhysicalQuantities::CLength &cg) const; //! @} @@ -368,15 +368,15 @@ namespace BlackMisc //! Get altitude unit PhysicalQuantities::CLengthUnit getAltitudeOrDefaultUnit() const; + //! @{ //! Get altitude under consideration of ground elevation and ground flag //! \remark with dragToGround it will also compensate overflows, otherwise only underflow - //! @{ CAltitude getCorrectedAltitude(bool enableDragToGround = true, AltitudeCorrection *correction = nullptr) const; CAltitude getCorrectedAltitude(const PhysicalQuantities::CLength ¢erOfGravity, bool enableDragToGround = true, AltitudeCorrection *correction = nullptr) const; //! @} - //! Set the corrected altitude from CAircraftSituation::getCorrectedAltitude //! @{ + //! Set the corrected altitude from CAircraftSituation::getCorrectedAltitude AltitudeCorrection correctAltitude(bool enableDragToGround = true); AltitudeCorrection correctAltitude(const PhysicalQuantities::CLength ¢erOfGravity = PhysicalQuantities::CLength::null(), bool enableDragToGround = true); //! @} @@ -521,7 +521,7 @@ namespace BlackMisc //! A default CG if not other value is available static const PhysicalQuantities::CLength &defaultCG(); - //! Ground flag comparisons + //! \name Ground flag comparisons //! @{ //! Both on ground diff --git a/src/blackmisc/aviation/aircraftvelocity.h b/src/blackmisc/aviation/aircraftvelocity.h index 447ddaf1f..079039c17 100644 --- a/src/blackmisc/aviation/aircraftvelocity.h +++ b/src/blackmisc/aviation/aircraftvelocity.h @@ -45,14 +45,14 @@ namespace BlackMisc::Aviation CAircraftVelocity(double x, double y, double z, PhysicalQuantities::CSpeedUnit xyzUnit, double pitch, double roll, double heading, PhysicalQuantities::CAngleUnit pbhAngleUnit, PhysicalQuantities::CTimeUnit pbhTimeUnit); - //! Setter //! @{ + //! Setter void setLinearVelocity(double x, double y, double z, PhysicalQuantities::CSpeedUnit xyzUnit); void setAngularVelocity(double pitch, double roll, double heading, PhysicalQuantities::CAngleUnit pbhAngleUnit, PhysicalQuantities::CTimeUnit pbhTimeUnit); //! @} - //! Getter //! @{ + //! Getter double getVelocityX(PhysicalQuantities::CSpeedUnit unit) const; double getVelocityY(PhysicalQuantities::CSpeedUnit unit) const; double getVelocityZ(PhysicalQuantities::CSpeedUnit unit) const; @@ -73,8 +73,8 @@ namespace BlackMisc::Aviation //! \copydoc Mixin::Index::comparePropertyByIndex int comparePropertyByIndex(CPropertyIndexRef index, const CAircraftVelocity &compareValue) const; - //! Unit constants //! @{ + //! Unit constants static const PhysicalQuantities::CSpeedUnit c_xyzSpeedUnit; static const PhysicalQuantities::CLengthUnit c_xyzLengthUnit; static const PhysicalQuantities::CAngleUnit c_pbhAngleUnit; // TODO Create a dedicated PQ class for angular velocity diff --git a/src/blackmisc/aviation/altitude.h b/src/blackmisc/aviation/altitude.h index 051d22a22..b8486d53f 100644 --- a/src/blackmisc/aviation/altitude.h +++ b/src/blackmisc/aviation/altitude.h @@ -206,8 +206,8 @@ namespace BlackMisc::Aviation //! \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 7c5814930..0c6d3422e 100644 --- a/src/blackmisc/aviation/callsign.h +++ b/src/blackmisc/aviation/callsign.h @@ -127,8 +127,8 @@ 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; diff --git a/src/blackmisc/aviation/flightplan.h b/src/blackmisc/aviation/flightplan.h index a33963118..04cb7d2d5 100644 --- a/src/blackmisc/aviation/flightplan.h +++ b/src/blackmisc/aviation/flightplan.h @@ -414,14 +414,14 @@ namespace BlackMisc::Aviation //! All rules as string static const QStringList &flightRules(); - //! Is rule a VFR rule? //! @{ + //! Is rule a VFR rule? static bool isVFRRules(FlightRules rule); static bool isVFRRules(const QString &rule); //! @} - //! Is rule a IFR rule? //! @{ + //! Is rule a IFR rule? static bool isIFRRules(FlightRules rule); static bool isIFRRules(const QString &rule); //! @} diff --git a/src/blackmisc/collection.h b/src/blackmisc/collection.h index f302293bf..8968cceca 100644 --- a/src/blackmisc/collection.h +++ b/src/blackmisc/collection.h @@ -99,8 +99,8 @@ namespace BlackMisc public Mixin::Icon> { public: - //! STL compatibility //! @{ + //! STL compatibility typedef T key_type; typedef T value_type; typedef T &reference; diff --git a/src/blackmisc/connectionguard.h b/src/blackmisc/connectionguard.h index 3193414e8..42e564aef 100644 --- a/src/blackmisc/connectionguard.h +++ b/src/blackmisc/connectionguard.h @@ -38,8 +38,8 @@ namespace BlackMisc //! Move assignment operator CConnectionGuard &operator =(CConnectionGuard &&) = default; - //! Not copyable //! @{ + //! Not copyable CConnectionGuard(const CConnectionGuard &) = delete; CConnectionGuard &operator =(const CConnectionGuard &) = delete; //! @} diff --git a/src/blackmisc/containerbase.h b/src/blackmisc/containerbase.h index 09de24de7..82b80b360 100644 --- a/src/blackmisc/containerbase.h +++ b/src/blackmisc/containerbase.h @@ -73,12 +73,14 @@ namespace BlackMisc //! Return a new container of a different type, containing the same elements as this one. //! \tparam Other the type of the new container. - //! @{ template