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

Doxygen fixes, improvements

Browse Source
This commit is contained in:
Klaus Basan
2014-07-08 18:17:04 +02:00
parent 161aec96a7
commit ecb2a6ff66
17 changed files with 92 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/blackcore/blackcore.h
View File

@@ -1,9 +1,15 @@
#ifndef BLACKCORE_H
#define BLACKCORE_H
//! \file
/**
* @namespace BlackCore
* To be written
* Backend services of the swift project, like dealing with the network or the simulators.
*/
#endif // BLACKCORE_H
/**
* \defgroup dbus DBus related functions, classes, or definitions.
*/
#endif // guard

5
src/blackcore/blackcorefreefunctions.h
View File

@@ -6,13 +6,10 @@
#ifndef BLACKCORE_FREEFUNCTIONS_H
#define BLACKCORE_FREEFUNCTIONS_H
/*!
* Free functions in BlackSim
*/
namespace BlackCore
{
/*!
* \brief Register all relevant metadata in BlackCore
* Register all relevant metadata in BlackCore
*/
void registerMetadata();

10
src/blackcore/context_application.h
View File

@@ -3,6 +3,8 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
//! \file
#ifndef BLACKCORE_CONTEXTAPPLICATION_H
#define BLACKCORE_CONTEXTAPPLICATION_H
@@ -11,9 +13,17 @@
#include <QObject>
#include <QReadWriteLock>
//! \addtogroup dbus
//! @{
//! DBus interface for context
#define BLACKCORE_CONTEXTAPPLICATION_INTERFACENAME "net.vatsim.PilotClient.BlackCore.ContextApplication"
//! DBus object path for context
#define BLACKCORE_CONTEXTAPPLICATION_OBJECTPATH "/Application"
//! @}
namespace BlackCore
{
/*!

4
src/blackcore/context_application_impl.h
View File

@@ -15,7 +15,7 @@ namespace BlackCore
class CRuntime;
/*!
* \brief Application context
* Application context
*/
class CContextApplication : public IContextApplication
{
@@ -28,7 +28,7 @@ namespace BlackCore
//! \copydoc IContextApplication::ping()
virtual qint64 ping(qint64 token) const override;
//! \brief Status message
//! Status message
virtual void sendStatusMessage(const BlackMisc::CStatusMessage &message) override;
//! Send status messages

7
src/blackcore/context_application_proxy.h
View File

@@ -12,9 +12,8 @@
namespace BlackCore
{
/*!
* \brief Application context proxy
*/
//! \brief Application context proxy
//! \ingroup dbus
class CContextApplicationProxy : public IContextApplication
{
Q_OBJECT
@@ -28,7 +27,7 @@ namespace BlackCore
//! \copydoc IContextApplication::ping()
virtual qint64 ping(qint64 token) const override;
//! \brief Status message
//! Status message
virtual void sendStatusMessage(const BlackMisc::CStatusMessage &message) override;
//! Send status messages

10
src/blackcore/context_audio.h
View File

@@ -3,6 +3,8 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
//! \file
#ifndef BLACKCORE_CONTEXTAUDIO_H
#define BLACKCORE_CONTEXTAUDIO_H
@@ -16,9 +18,17 @@
#include "blackmisc/avselcal.h"
#include <QObject>
//! \addtogroup dbus
//! @{
//! DBus interface for context
#define BLACKCORE_CONTEXTAUDIO_INTERFACENAME "net.vatsim.PilotClient.BlackCore.ContextAudio"
//! DBus object path for context
#define BLACKCORE_CONTEXTAUDIO_OBJECTPATH "/Audio"
//! @}
namespace BlackCore
{

1
src/blackcore/context_audio_proxy.h
View File

@@ -18,6 +18,7 @@ namespace BlackCore
{
//! \brief Audio context proxy
//! \ingroup dbus
class CContextAudioProxy : public IContextAudio
{
Q_OBJECT

8
src/blackcore/context_network.h
View File

@@ -18,9 +18,17 @@
#include "blackmisc/voiceroomlist.h"
#include "blackcore/network.h"
//! \addtogroup dbus
//! @{
//! DBus interface for context
#define BLACKCORE_CONTEXTNETWORK_INTERFACENAME "net.vatsim.PilotClient.BlackCore.ContextNetwork"
//! DBus object path for context
#define BLACKCORE_CONTEXTNETWORK_OBJECTPATH "/Network"
//! @}
namespace BlackCore
{

3
src/blackcore/context_network_proxy.h
View File

@@ -20,7 +20,8 @@
namespace BlackCore
{
//! Network context proxy
//! \brief Network context proxy
//! \ingroup dbus
class CContextNetworkProxy : public IContextNetwork
{
Q_OBJECT

15
src/blackcore/context_ownaircraft.h
View File

@@ -3,6 +3,8 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
//! \file
#ifndef BLACKCORE_CONTEXTOWNAIRCRAFT_H
#define BLACKCORE_CONTEXTOWNAIRCRAFT_H
@@ -10,13 +12,22 @@
#include "blackmisc/avallclasses.h"
#include "blackmisc/voiceroomlist.h"
//! \addtogroup dbus
//! @{
//! DBus interface for context
#define BLACKCORE_CONTEXTOWNAIRCRAFT_INTERFACENAME "net.vatsim.PilotClient.BlackCore.ContextOwnAircraft"
//! DBus object path for context
#define BLACKCORE_CONTEXTOWNAIRCRAFT_OBJECTPATH "/OwnAircraft"
//! @}
namespace BlackCore
{
//! \brief Own context proxy
//! \ingroup dbus
class IContextOwnAircraft : public CContext
{
Q_OBJECT
@@ -47,7 +58,7 @@ namespace BlackCore
virtual ~IContextOwnAircraft() {}
signals:
//! Aircraft changed
//! \brief Aircraft changed
//! \remarks local only
void changedAircraft(const BlackMisc::Aviation::CAircraft &aircraft, const QString &originator);
@@ -83,7 +94,7 @@ namespace BlackCore
//! Set current pilot
virtual bool updatePilot(const BlackMisc::Network::CUser &pilot, const QString &originator) = 0;
//! Output volumens, volumes 0..100
//! Output volumes, volumes 0..100
virtual void setAudioOutputVolumes(int outputVolumeCom1, int outputVolumeCom2) = 0;
//! Set individual voice rooms (overrides voice rooms)

1
src/blackcore/context_ownaircraft_proxy.h
View File

@@ -14,6 +14,7 @@ namespace BlackCore
{
//! \brief Network context proxy
//! \ingroup dbus
class CContextOwnAircraftProxy : public IContextOwnAircraft
{
Q_OBJECT

10
src/blackcore/context_settings.h
View File

@@ -3,6 +3,8 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
//! \file
#ifndef BLACKCORE_CONTEXTSETTINGS_H
#define BLACKCORE_CONTEXTSETTINGS_H
@@ -17,9 +19,17 @@
#include <QObject>
#include <QVariant>
//! \addtogroup dbus
//! @{
//! DBus interface for context
#define BLACKCORE_CONTEXTSETTINGS_INTERFACENAME "net.vatsim.PilotClient.BlackCore.ContextSettings"
//! DBus object path for context
#define BLACKCORE_CONTEXTSETTINGS_OBJECTPATH "/Settings"
//! @}
namespace BlackCore
{
/*!

17
src/blackcore/context_settings_proxy.h
View File

@@ -19,16 +19,15 @@
namespace BlackCore
{
/*!
* \brief Settings context proxy
*/
//! \brief Settings context proxy
//! \ingroup dbus
class CContextSettingsProxy : public IContextSettings
{
Q_OBJECT
friend class IContextSettings;
public:
//! \brief Destructor
//! Destructor
virtual ~CContextSettingsProxy() {}
private:
@@ -39,10 +38,10 @@ namespace BlackCore
void relaySignals(const QString &serviceName, QDBusConnection &connection);
protected:
//! \brief DBus version constructor
//! DBus version constructor
CContextSettingsProxy(const QString &serviceName, QDBusConnection &connection, CRuntimeConfig::ContextMode mode, CRuntime *runtime);
//! \brief Constructor
//! Constructor
CContextSettingsProxy(CRuntimeConfig::ContextMode mode, CRuntime *runtime) : IContextSettings(mode, runtime), m_dBusInterface(nullptr) {}
public slots:
@@ -64,16 +63,16 @@ namespace BlackCore
//! \copydoc IContextSettings::write
BlackMisc::CStatusMessage write() const override;
//! \brief read settings
//! read settings
virtual BlackMisc::CStatusMessage read() override;
//! \copydoc IContextSettings::reset
virtual BlackMisc::CStatusMessage reset(bool write = true) override;
//! \brief settings file name
//! settings file name
virtual QString getSettingsFileName() const override;
//! \brief as JSON string
//! as JSON string
virtual QString getSettingsAsJsonString() const override;
};

10
src/blackcore/context_simulator.h
View File

@@ -3,12 +3,22 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
//! \file
#ifndef BLACKCORE_CONTEXTSIMULATOR_H
#define BLACKCORE_CONTEXTSIMULATOR_H
//! \addtogroup dbus
//! @{
//! DBus interface for context
#define BLACKCORE_CONTEXTSIMULATOR_INTERFACENAME "net.vatsim.PilotClient.BlackCore.ContextSimulator"
//! DBus object path for context
#define BLACKCORE_CONTEXTSIMULATOR_OBJECTPATH "/Simulator"
//! @}
#include "context.h"
#include "blackcore/dbus_server.h"
#include "blackcore/context_runtime.h"

2
src/blackcore/context_simulator_impl.h
View File

@@ -97,7 +97,7 @@ namespace BlackCore
void ps_addAircraftSituation(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::Aviation::CAircraftSituation &initialSituation);
//! Update cockpit from context, because someone else has changed cockpit (e.g. GUI, 3rd party)
//! \remarks set by runtime, only locally
//! \remarks set by runtime, only to be used locally (not via DBus)
void ps_updateCockpitFromContext(const BlackMisc::Aviation::CAircraft &ownAircraft, const QString &originator);
//! Set new connection status

3
src/blackcore/context_simulator_proxy.h
View File

@@ -12,6 +12,7 @@
namespace BlackCore
{
//! \brief DBus proxy for Simulator Context
//! \ingroup dbus
class CContextSimulatorProxy : public IContextSimulator
{
Q_OBJECT
@@ -31,7 +32,7 @@ namespace BlackCore
//! Constructor
CContextSimulatorProxy(CRuntimeConfig::ContextMode mode, CRuntime *runtime) : IContextSimulator(mode, runtime), m_dBusInterface(0) {}
//! \brief DBus version constructor
//! DBus version constructor
CContextSimulatorProxy(const QString &serviceName, QDBusConnection &connection, CRuntimeConfig::ContextMode mode, CRuntime *runtime);
public slots:

3
src/blackcore/network_vatlib.h
View File

@@ -46,10 +46,11 @@ namespace BlackCore
virtual BlackMisc::Network::CServerList getKnownServers() const override;
// Network slots
//! \copydoc INetwork::presetLoginMode
virtual void presetLoginMode(LoginMode mode) override;
virtual void presetServer(const BlackMisc::Network::CServer &server) override;
virtual void presetCallsign(const BlackMisc::Aviation::CCallsign &callsign) override;
virtual void presetIcaoCodes(const BlackMisc::Aviation::CAircraftIcao &icao) override;
virtual void presetLoginMode(LoginMode mode) override;
virtual void initiateConnection() override;
virtual void terminateConnection() override;
virtual void sendPing(const BlackMisc::Aviation::CCallsign &callsign) override;