refs #91 & #124 Doxygen, override, and comment fixes in network.

Changed FILE_PATTERNS config in Doxyfile so Doxygen only looks at headers, not cpp files.
Reverts some changes of commit:116db9a (e.g. terminate() is an internal signal of CNetworkVatlib, but still needs a doxy comment because all signals are public).
This commit is contained in:
Mathew Sutcliffe
2014-02-08 14:19:29 +00:00
parent c966d487f0
commit 06a7b0b32f
5 changed files with 21 additions and 72 deletions

View File

@@ -22,7 +22,7 @@
namespace BlackCore
{
/*!
* \brief Our implementation for the VATSIM protocol
* \brief Implementation of INetwork using the vatlib shim
*/
class CNetworkVatlib : public INetwork
{
@@ -35,10 +35,10 @@ namespace BlackCore
//! \brief Destructor
virtual ~CNetworkVatlib();
//! \brief Is connected?
bool isConnected() const { return m_status == Cvatlib_Network::connStatus_Connected; }
//! \copydoc INetwork::isConnected()
virtual bool isConnected() const override { return m_status == Cvatlib_Network::connStatus_Connected; }
// INetwork slots overrides
// Network slots
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;
@@ -46,20 +46,18 @@ namespace BlackCore
virtual void initiateConnection() override;
virtual void terminateConnection() override;
virtual void sendPing(const BlackMisc::Aviation::CCallsign &callsign) override;
// 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
// Text message slots
virtual void sendTextMessages(const BlackMisc::Network::CTextMessageList &messages) override;
// ATC
// ATC slots
virtual void sendAtcQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
virtual void sendAtisQuery(const BlackMisc::Aviation::CCallsign &callsign);
virtual void sendAtisQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
// Aircraft
// Aircraft slots
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;
@@ -70,7 +68,7 @@ namespace BlackCore
const BlackMisc::Aviation::CComSystem &com2,
const BlackMisc::Aviation::CTransponder &xpdr) override;
// Weather
// Weather slots
virtual void sendMetarQuery(const QString &airportICAO) override;
virtual void sendWeatherDataQuery(const QString &airportICAO) override;
@@ -114,6 +112,13 @@ namespace BlackCore
void process();
void update();
signals:
/*!
* Used internally to terminate the connection from within a callback
* \internal
*/
void terminate();
public:
//! Deletion policy for QScopedPointer
struct VatlibQScopedPointerDeleter