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

refs #91 & #124 doxygen fixes, style/comment changes, typos, and override / nullptr keywords

Browse Source 
Remark: Doxygen <70 warnings
This commit is contained in:
Klaus Basan
2014-02-07 01:09:31 +01:00
parent 6bf930650a
commit 116db9a425
18 changed files with 269 additions and 461 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/blackcore/context_application_interface.h
View File

@@ -84,14 +84,13 @@ namespace BlackCore
IContextApplication(QObject *parent = nullptr) : QObject(parent), m_dBusInterface(nullptr) {}
signals:
/*!
* \brief Status message
* \param message
*/
//! \brief Status message
void statusMessage(const BlackMisc::CStatusMessage &message);
//! Widget GUI is about to start
void widgetGuiStarting() const;
//! Widget GUI is about to terminate
void widgetGuiTerminating() const;
public slots:

8
src/blackcore/dbus_server.cpp
View File

@@ -145,14 +145,6 @@ namespace BlackCore
// Q_ASSERT_X(success, "CDBusServer::addObject", "Registration failed");
}
/*
* Print last error message
*/
void CDBusServer::printError() const
{
qWarning() << m_busServer.lastError().name();
}
/*
* Last error
*/

19
src/blackcore/dbus_server.h
View File

@@ -30,6 +30,7 @@ namespace BlackCore
Q_CLASSINFO("D-Bus Interface", BLACKCORE_DBUSERVER_SERVICENAME)
public:
//! \brief Service name of DBus serve
static const QString ServiceName;
/*!
@@ -73,24 +74,12 @@ namespace BlackCore
}
public:
/*!
* \brief Constructor
* \param parent
*/
CDBusServer(const QString &address, QObject *parent = 0);
//! \brief Constructor
CDBusServer(const QString &address, QObject *parent = nullptr);
/*!
* \brief Adds a QObject to be exposed to DBus
* \param name
* \param object
*/
//!! \brief Adds a QObject to be exposed to DBus
void addObject(const QString &name, QObject *object);
/*!
* \brief printError
*/
void printError() const;
/*!
* \brief Last error
* \return

7
src/blackcore/network.h
View File

@@ -117,6 +117,12 @@ namespace BlackCore
*/
virtual bool isConnected() const = 0;
signals:
/*!
* \brief Connection has been terminated
*/
void terminate();
public slots:
////////////////////////////////////////////////////////////////
//! \name Network slots
@@ -398,6 +404,7 @@ namespace BlackCore
/*!
* We received a reply to one of our queries.
* \param callsign capabilities for this callsign
* \param flags A combination of capabilities flags.
* \sa sendCapabilitiesQuery
*/

12
src/blackcore/network_vatlib.cpp
View File

@@ -26,8 +26,10 @@ namespace BlackCore
using namespace BlackMisc::Aviation;
using namespace BlackMisc::Network;
//! \brief dispatch exception
void exceptionDispatcher(const char *caller);
//! \brief Constructor
CNetworkVatlib::CNetworkVatlib(QObject *parent)
: INetwork(parent),
m_loginMode(LoginNormal),
@@ -174,6 +176,11 @@ namespace BlackCore
catch (...) { exceptionDispatcher(Q_FUNC_INFO); }
}
/*!
* \brief Convert connection status (from Cvatlib_Network to INetwork)
* \param status
* \return
*/
INetwork::ConnectionStatus convertConnectionStatus(Cvatlib_Network::connStatus status)
{
switch (status)
@@ -576,6 +583,11 @@ namespace BlackCore
/********************************** shimlib callbacks ************************************/
/********************************** * * * * * * * * * * * * * * * * * * * ************************************/
/*!
* \brief Cast from *void to *CNetworkVatlib
* \param cbvar
* \return
*/
CNetworkVatlib *cbvar_cast(void *cbvar)
{
return static_cast<CNetworkVatlib *>(cbvar);

61
src/blackcore/network_vatlib.h
View File

@@ -21,52 +21,58 @@
namespace BlackCore
{
/*!
* \brief Our implementation for the VATSIM protocol
*/
class CNetworkVatlib : public INetwork
{
Q_OBJECT
public:
//! \brief Constructor
CNetworkVatlib(QObject *parent = nullptr);
//! \brief Destructor
virtual ~CNetworkVatlib();
//! \brief Is connected?
bool isConnected() const { return m_status == Cvatlib_Network::connStatus_Connected; }
public: // INetwork slots overrides
// INetwork slots overrides
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;
// Network
virtual void presetServer(const BlackMisc::Network::CServer &server);
virtual void presetCallsign(const BlackMisc::Aviation::CCallsign &callsign);
virtual void presetIcaoCodes(const BlackMisc::Aviation::CAircraftIcao &icao);
virtual void presetLoginMode(LoginMode mode);
virtual void initiateConnection();
virtual void terminateConnection();
virtual void sendPing(const BlackMisc::Aviation::CCallsign &callsign);
virtual void sendRealNameQuery(const BlackMisc::Aviation::CCallsign &callsign);
virtual void sendIpQuery();
virtual void sendServerQuery(const BlackMisc::Aviation::CCallsign &callsign);
// queries
virtual void sendRealNameQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
virtual void sendIpQuery() override;
virtual void sendServerQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
// Text messages
virtual void sendTextMessages(const BlackMisc::Network::CTextMessageList &messages);
virtual void sendTextMessages(const BlackMisc::Network::CTextMessageList &messages) override;
// ATC
virtual void sendAtcQuery(const BlackMisc::Aviation::CCallsign &callsign);
virtual void sendAtcQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
virtual void sendAtisQuery(const BlackMisc::Aviation::CCallsign &callsign);
// Aircraft
virtual void sendCapabilitiesQuery(const BlackMisc::Aviation::CCallsign &callsign);
virtual void sendIcaoCodesQuery(const BlackMisc::Aviation::CCallsign &callsign);
virtual void sendFrequencyQuery(const BlackMisc::Aviation::CCallsign &callsign);
virtual void setOwnAircraft(const BlackMisc::Aviation::CAircraft &aircraft);
virtual void setOwnAircraftPosition(const BlackMisc::Geo::CCoordinateGeodetic &position, const BlackMisc::Aviation::CAltitude &altitude);
virtual void setOwnAircraftSituation(const BlackMisc::Aviation::CAircraftSituation &situation);
virtual void setOwnAircraftAvionics(const BlackMisc::Aviation::CComSystem &com1, const BlackMisc::Aviation::CComSystem &com2,
const BlackMisc::Aviation::CTransponder &xpdr);
virtual void sendCapabilitiesQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
virtual void sendIcaoCodesQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
virtual void sendFrequencyQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
virtual void setOwnAircraft(const BlackMisc::Aviation::CAircraft &aircraft) override;
virtual void setOwnAircraftPosition(const BlackMisc::Geo::CCoordinateGeodetic &position, const BlackMisc::Aviation::CAltitude &altitude) override;
virtual void setOwnAircraftSituation(const BlackMisc::Aviation::CAircraftSituation &situation) override;
virtual void setOwnAircraftAvionics(const BlackMisc::Aviation::CComSystem &com1,
const BlackMisc::Aviation::CComSystem &com2,
const BlackMisc::Aviation::CTransponder &xpdr) override;
// Weather
virtual void sendMetarQuery(const QString &airportICAO);
virtual void sendWeatherDataQuery(const QString &airportICAO);
virtual void sendMetarQuery(const QString &airportICAO) override;
virtual void sendWeatherDataQuery(const QString &airportICAO) override;
private slots:
void replyToFrequencyQuery(const BlackMisc::Aviation::CCallsign &callsign);
@@ -108,9 +114,6 @@ namespace BlackCore
void process();
void update();
signals:
void terminate();
public:
//! Deletion policy for QScopedPointer
struct VatlibQScopedPointerDeleter

6
src/blackcore/voice_vatlib.cpp
View File

@@ -586,8 +586,10 @@ namespace BlackCore
/********************************** shimlib callbacks ************************************/
/********************************** * * * * * * * * * * * * * * * * * * * ************************************/
/*
* Cast
/*!
* \brief Cast from *void to *CVoiceVatlib
* \param cbvar
* \return
*/
CVoiceVatlib *cbvar_cast_voice(void *cbvar)
{

2
src/blackcore/voice_vatlib.h
View File

@@ -152,7 +152,7 @@ namespace BlackCore
/*!
* \brief Room status update, used in callback
* \param comUnit
* \param upd
* \param roomStatus
*/
void changeRoomStatus(ComUnit comUnit, Cvatlib_Voice_Simple::roomStatusUpdate roomStatus);