flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-04-20 20:40:29 +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

2
src/blackcore/fsd/atcdataupdate.h
View File

@@ -35,8 +35,8 @@ namespace BlackCore::Fsd
//! Construct from tokens
static AtcDataUpdate fromTokens(const QStringList &tokens);
//! Properties
//! @{
//! Properties
int m_frequencykHz = 0.0;
BlackMisc::Network::CFacilityType m_facility;
int m_visibleRange = 0.0;

2
src/blackcore/fsd/clientidentification.h
View File

@@ -35,8 +35,8 @@ namespace BlackCore::Fsd
//! PDU identifier
static QString pdu() { return "$ID"; }
//! Properties
//! @{
//! Properties
std::uint16_t m_clientId = 0;
QString m_clientName;
int m_clientVersionMajor = BlackConfig::CBuildConfig::getVersion().majorVersion();

2
src/blackcore/fsd/clientquery.h
View File

@@ -37,8 +37,8 @@ namespace BlackCore::Fsd
//! PDU identifier
static QString pdu() { return "$CQ"; }
//! Properties
//! @{
//! Properties
ClientQueryType m_queryType = ClientQueryType::Unknown;
QStringList m_queryData;
//! @}

2
src/blackcore/fsd/clientresponse.h
View File

@@ -35,8 +35,8 @@ namespace BlackCore::Fsd
//! PDU identifier
static QString pdu() { return "$CR"; }
//! Properties
//! @{
//! Properties
ClientQueryType m_queryType {};
QStringList m_responseData;
//! @}

2
src/blackcore/fsd/enums.h
View File

@@ -176,8 +176,8 @@ namespace BlackCore::Fsd
AircraftConfig = (1 << 9)
};
//! Operators
//! @{
//! Operators
inline Capabilities operator | (Capabilities lhs, Capabilities rhs)
{
return static_cast<Capabilities>(static_cast<int>(lhs) | static_cast<int>(rhs));

2
src/blackcore/fsd/euroscopesimdata.h
View File

@@ -35,8 +35,8 @@ namespace BlackCore::Fsd
//! PDU identifier
static QString pdu() { return QStringLiteral("SIMDATA"); }
//! Properties
//! @{
//! Properties
QString m_model;
QString m_livery;
quint64 m_timestamp = 0;

2
src/blackcore/fsd/flightplan.h
View File

@@ -35,8 +35,8 @@ namespace BlackCore::Fsd
//! PDU identifier
static QString pdu() { return "$FP"; }
//! Properties
//! @{
//! Properties
FlightType m_flightType {};
QString m_aircraftIcaoType;
int m_trueCruisingSpeed = 0;

34
src/blackcore/fsd/fsdclient.h
View File

@@ -50,8 +50,8 @@
#include <atomic>
//! Protocol version
//! @{
//! Protocol version
#define PROTOCOL_REVISION_CLASSIC 9
#define PROTOCOL_REVISION_VATSIM_ATC 10
#define PROTOCOL_REVISION_VATSIM_AUTH 100
@@ -96,10 +96,10 @@ namespace BlackCore::Fsd
BlackMisc::Simulation::IRemoteAircraftProvider *remoteAircraftProvider,
QObject *owner = nullptr);
//! @{
//! Preset functions
//! \remark Necessary functions to setup client. Set them all!
//! \threadsafe
//! @{
void setClientName(const QString &clientName) { QWriteLocker l(&m_lockUserClientBuffered); m_clientName = clientName; }
void setHostApplication(const QString &hostApplication) { QWriteLocker l(&m_lockUserClientBuffered); m_hostApplication = hostApplication; }
void setVersion(int major, int minor) { QWriteLocker l(&m_lockUserClientBuffered); m_versionMajor = major; m_versionMinor = minor; }
@@ -143,22 +143,22 @@ namespace BlackCore::Fsd
//! \threadsafe
PilotRating getPilotRating() const { QReadLocker l(&m_lockUserClientBuffered); return m_pilotRating; }
//! Connenct/disconnect
//! @{
//! Connenct/disconnect
void connectToServer();
void disconnectFromServer();
//! @}
//! Interim positions
//! @{
//! Interim positions
void addInterimPositionReceiver(const BlackMisc::Aviation::CCallsign &receiver) { m_interimPositionReceivers.push_back(receiver); }
void removeInterimPositionReceiver(const BlackMisc::Aviation::CCallsign &receiver) { m_interimPositionReceivers.remove(receiver); }
//! @}
//! @{
//! Convenience functions for sendClientQuery
//! \remark pseudo private, used in CAirspaceMonitor and network context
//! \private
//! @{
void sendClientQueryCapabilities(const BlackMisc::Aviation::CCallsign &callsign);
void sendClientQueryCom1Freq(const BlackMisc::Aviation::CCallsign &callsign);
void sendClientQueryRealName(const BlackMisc::Aviation::CCallsign &callsign);
@@ -175,22 +175,22 @@ namespace BlackCore::Fsd
void sendPlaneInfoRequestFsinn(const BlackMisc::Aviation::CCallsign &callsign);
//! @}
//! Interim pos.receivers
//! @{
//! Interim pos.receivers
BlackMisc::Aviation::CCallsignSet getInterimPositionReceivers() const;
void setInterimPositionReceivers(const BlackMisc::Aviation::CCallsignSet &interimPositionReceivers);
//! @}
//! Connection status
//! @{
//! Connection status
BlackMisc::Network::CConnectionStatus getConnectionStatus() const { QReadLocker l(&m_lockConnectionStatus); return m_connectionStatus; }
bool isConnected() const { return this->getConnectionStatus().isConnected(); }
bool isDisconnected() const { return this->getConnectionStatus().isDisconnected(); }
bool isPendingConnection() const;
//! @}
//! Statistics enable functions
//! @{
//! Statistics enable functions
bool setStatisticsEnable(bool enabled) { m_statistics = enabled; return enabled; }
bool isStatisticsEnabled() const { return m_statistics; }
//! @}
@@ -208,8 +208,8 @@ namespace BlackCore::Fsd
void gracefulShutdown();
signals:
//! Client responses received
//! @{
//! Client responses received
void atcDataUpdateReceived(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::PhysicalQuantities::CFrequency &freq,
const BlackMisc::Geo::CCoordinateGeodetic &pos, const BlackMisc::PhysicalQuantities::CLength &range);
void deleteAtcReceived(const QString &cid);
@@ -256,11 +256,9 @@ namespace BlackCore::Fsd
private:
//! \cond
friend BlackFsdTest::CTestFSDClient;
//! \endcond
//! Convenience functions for sendClientQuery
//! \remark really private, ONLY used by UNIT test, not CAirspaceMonitor
//! @{
// Convenience functions for sendClientQuery
// really private, ONLY used by UNIT test, not CAirspaceMonitor
void sendLogin(const QString &token = {});
void sendDeletePilot();
void sendDeleteAtc();
@@ -279,10 +277,10 @@ namespace BlackCore::Fsd
//
void sendMessageString(const QString &message);
void sendQueuedMessage();
//! @}
//! \endcond
//! Increase the statistics value for given identifier
//! @{
//! Increase the statistics value for given identifier
int increaseStatisticsValue(const QString &identifier, const QString &appendix = {});
int increaseStatisticsValue(const QString &identifier, int value);
//! @}
@@ -308,8 +306,8 @@ namespace BlackCore::Fsd
this->sendMessageString(messageToFSDString(message));
}
//! Unit test/debug functions
//! @{
//! Unit test/debug functions
void sendFsdMessage(const QString &message);
void setUnitTestMode(bool on) { m_unitTestMode = on; }
//! @}
@@ -360,8 +358,8 @@ namespace BlackCore::Fsd
// Type to string
const QString &messageTypeToString(MessageType mt) const;
//! Handle response tokens
//! @{
//! Handle response tokens
void handleAtcDataUpdate(const QStringList &tokens);
void handleAuthChallenge(const QStringList &tokens);
void handleAuthResponse(const QStringList &tokens);
@@ -441,8 +439,8 @@ namespace BlackCore::Fsd
//! Save the statistics
bool saveNetworkStatistics(const QString &server);
//! Timers
//! @{
//! Timers
void startPositionTimers();
void stopPositionTimers();
//! @}

2
src/blackcore/fsd/fsdidentification.h
View File

@@ -31,8 +31,8 @@ namespace BlackCore::Fsd
//! PDU identifier
static QString pdu() { return "$DI"; }
//! Properties
//! @{
//! Properties
QString m_serverVersion;
QString m_initialChallenge;
//! @}

2
src/blackcore/fsd/interimpilotdataupdate.h
View File

@@ -33,8 +33,8 @@ namespace BlackCore::Fsd
//! PDU identifier
static QString pdu() { return "#SB"; }
//! Properties
//! @{
//! Properties
double m_latitude = 0.0;
double m_longitude = 0.0;
int m_altitudeTrue = 0.0;

2
src/blackcore/fsd/pilotdataupdate.h
View File

@@ -35,8 +35,8 @@ namespace BlackCore::Fsd
//! PDU identifier
static QString pdu() { return "@"; }
//! Properties
//! @{
//! Properties
BlackMisc::Aviation::CTransponder::TransponderMode m_transponderMode = BlackMisc::Aviation::CTransponder::StateStandby;
int m_transponderCode = 0;
PilotRating m_rating = PilotRating::Unknown;

2
src/blackcore/fsd/planeinforequestfsinn.h
View File

@@ -36,8 +36,8 @@ namespace BlackCore::Fsd
//! PDU identifier
static QString pdu() { return QStringLiteral("#SB"); }
//! Properties
//! @{
//! Properties
QString m_airlineIcao;
QString m_aircraftIcao;
QString m_aircraftIcaoCombinedType;

2
src/blackcore/fsd/planeinformation.h
View File

@@ -32,8 +32,8 @@ namespace BlackCore::Fsd
//! PDU identifier
static QString pdu() { return "#SB"; }
//! Properties
//! @{
//! Properties
QString m_aircraft;
QString m_airline;
QString m_livery;

2
src/blackcore/fsd/planeinformationfsinn.h
View File

@@ -36,8 +36,8 @@ namespace BlackCore::Fsd
//! PDU identifier
static QString pdu() { return "#SB"; }
//! Properties
//! @{
//! Properties
QString m_airlineIcao;
QString m_aircraftIcao;
QString m_aircraftIcaoCombinedType;

2
src/blackcore/fsd/rehost.h
View File

@@ -32,8 +32,8 @@ namespace BlackCore::Fsd
//! PDU identifier
static QString pdu() { return "$XX"; }
//! Properties
//! @{
//! Properties
QString m_hostname;
//! @}

7
src/blackcore/fsd/revbclientparts.h
View File

@@ -36,15 +36,10 @@ namespace BlackCore::Fsd
//! PDU identifier
static QString pdu() { return "-MD"; }
//! Properties
//! @{
//! Properties
ClientQueryType m_queryType = ClientQueryType::Unknown;
QStringList m_queryData;
//! @}
//! Properties
//! @{
QString m_partsval1;
QString m_partsval2;
QString m_partsval3;

4
src/blackcore/fsd/servererror.h
View File

@@ -35,14 +35,14 @@ namespace BlackCore::Fsd
//! PDU identifier
static QString pdu() { return "$ER"; }
//! Getter
//! @{
//! Getter
const QString &getCausingParameter() const { static const QString n("no details"); return m_causingParameter.isEmpty() ? n : m_causingParameter; }
const QString &getDescription() const { static const QString n("no description"); return m_description.isEmpty() ? n : m_description; }
//! @}
//! Properties
//! @{
//! Properties
ServerErrorCode m_errorNumber {};
QString m_causingParameter;
QString m_description;

2
src/blackcore/fsd/visualpilotdataperiodic.h
View File

@@ -39,8 +39,8 @@ namespace BlackCore::Fsd
//! Return a regular visual update with the same values
VisualPilotDataUpdate toUpdate() const;
//! Properties
//! @{
//! Properties
double m_latitude = 0.0;
double m_longitude = 0.0;
double m_altitudeTrue = 0.0;

2
src/blackcore/fsd/visualpilotdatastopped.h
View File

@@ -38,8 +38,8 @@ namespace BlackCore::Fsd
//! Return a regular visual update with the same values
VisualPilotDataUpdate toUpdate() const;
//! Properties
//! @{
//! Properties
double m_latitude = 0.0;
double m_longitude = 0.0;
double m_altitudeTrue = 0.0;

2
src/blackcore/fsd/visualpilotdatatoggle.h
View File

@@ -32,8 +32,8 @@ namespace BlackCore::Fsd
//! PDU identifier
static QString pdu() { return "$SF"; }
//! Properties
//! @{
//! Properties
QString m_client;
bool m_active = false;
//! @}

2
src/blackcore/fsd/visualpilotdataupdate.h
View File

@@ -43,8 +43,8 @@ namespace BlackCore::Fsd
//! Return a stopped update with the same values
VisualPilotDataStopped toStopped() const;
//! Properties
//! @{
//! Properties
double m_latitude = 0.0;
double m_longitude = 0.0;
double m_altitudeTrue = 0.0;