flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-04-17 02:45:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix doxygen warnings

Browse Source 
Fixes #188
This commit is contained in:
Mat Sutcliffe
2023-02-05 16:32:51 +00:00
committed by Lars Toenning
parent 5e5b3f830d
commit 7691e42a5b
175 changed files with 570 additions and 664 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/blackcore/context/contextapplication.h
View File

@@ -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

3
src/blackcore/context/contextapplicationimpl.h
View File

@@ -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

3
src/blackcore/context/contextapplicationproxy.h
View File

@@ -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

25
src/blackcore/context/contextaudio.h
View File

@@ -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);

4
src/blackcore/context/contextaudioimpl.h
View File

@@ -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

5
src/blackcore/context/contextaudioproxy.h
View File

@@ -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;

7
src/blackcore/context/contextnetwork.h
View File

@@ -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
{

29
src/blackcore/context/contextnetworkimpl.h
View File

@@ -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<void(const BlackMisc::Aviation::CCallsign &)> removedAircraftSlot,
std::function<void(const BlackMisc::Simulation::CAirspaceAircraftSnapshot &)> 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
//! @{
//! <pre>
//! .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
//! </pre>
//! @}
//! \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:

7
src/blackcore/context/contextownaircraft.h
View File

@@ -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
{

4
src/blackcore/context/contextownaircraftimpl.h
View File

@@ -177,14 +177,12 @@ namespace BlackCore
virtual bool setTransponderMode(BlackMisc::Aviation::CTransponder::TransponderMode mode) override;
//! \addtogroup swiftdotcommands
//! @{
//! <pre>
//! .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
//! </pre>
//! @}
//! \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);
//! @}

3
src/blackcore/context/contextownaircraftproxy.h
View File

@@ -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

7
src/blackcore/context/contextsimulator.h
View File

@@ -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

18
src/blackcore/context/contextsimulatorimpl.h
View File

@@ -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
//! @{
//! <pre>
//! .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
//! </pre>
//! @}
//! \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 <n> 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