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

@@ -695,14 +695,7 @@ INPUT_ENCODING = UTF-8
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
# *.f90 *.f *.for *.vhd *.vhdl
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
*.cpp \
*.c++ \
*.d \
*.java \
*.ii \
FILE_PATTERNS = *.ii \
*.ixx \
*.ipp \
*.i++ \
@@ -713,22 +706,11 @@ FILE_PATTERNS = *.c \
*.hpp \
*.h++ \
*.idl \
*.odl \
*.cs \
*.php \
*.php3 \
*.inc \
*.m \
*.markdown \
*.md \
*.mm \
*.dox \
*.py \
*.f90 \
*.f \
*.for \
*.vhd \
*.vhdl
*.dox
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.

View File

@@ -695,14 +695,7 @@ INPUT_ENCODING = UTF-8
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
# *.f90 *.f *.for *.vhd *.vhdl
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
*.cpp \
*.c++ \
*.d \
*.java \
*.ii \
FILE_PATTERNS = *.ii \
*.ixx \
*.ipp \
*.i++ \
@@ -713,22 +706,11 @@ FILE_PATTERNS = *.c \
*.hpp \
*.h++ \
*.idl \
*.odl \
*.cs \
*.php \
*.php3 \
*.inc \
*.m \
*.markdown \
*.md \
*.mm \
*.dox \
*.py \
*.f90 \
*.f \
*.for \
*.vhd \
*.vhdl
*.dox
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.

View File

@@ -117,12 +117,6 @@ namespace BlackCore
*/
virtual bool isConnected() const = 0;
signals:
/*!
* \brief Connection has been terminated
*/
void terminate();
public slots:
////////////////////////////////////////////////////////////////
//! \name Network slots
@@ -404,11 +398,9 @@ 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
*/
void capabilitiesReplyReceived(const BlackMisc::Aviation::CCallsign &callsign, quint32 flags);
void capabilitiesReplyReceived(const BlackMisc::Aviation::CCallsign &callsign, quint32 capabilitiesFlags);
/*!
* We received a reply to one of our queries.

View File

@@ -26,10 +26,8 @@ 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),
@@ -176,11 +174,6 @@ 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)
@@ -583,11 +576,6 @@ namespace BlackCore
/********************************** shimlib callbacks ************************************/
/********************************** * * * * * * * * * * * * * * * * * * * ************************************/
/*!
* \brief Cast from *void to *CNetworkVatlib
* \param cbvar
* \return
*/
CNetworkVatlib *cbvar_cast(void *cbvar)
{
return static_cast<CNetworkVatlib *>(cbvar);

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