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

[doxygen] Fix broken groupings

Browse Source
This commit is contained in:
Mat Sutcliffe
2020-08-01 19:08:08 +01:00
parent faf7f2a2cf
commit 2ae0352e75
115 changed files with 474 additions and 248 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -37,7 +37,8 @@ namespace BlackCore
//! 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;

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

@@ -37,7 +37,8 @@ namespace BlackCore
//! 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();

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

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

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

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

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

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

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

@@ -37,7 +37,8 @@ namespace BlackCore
//! PDU identifier
static QString pdu() { return "$FP"; }
//! Properties @{
//! Properties
//! @{
FlightType m_flightType {};
QString m_aircraftIcaoType;
int m_trueCruisingSpeed = 0;
@@ -53,7 +54,7 @@ namespace BlackCore
QString m_altAirport;
QString m_remarks;
QString m_route;
//! @
//! @}
protected:
FlightPlan();

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

@@ -47,7 +47,8 @@
#include <atomic>
//! Protocol version @{
//! Protocol version
//! @{
#define PROTOCOL_REVISION_CLASSIC 9
#define PROTOCOL_REVISION_VATSIM_ATC 10
#define PROTOCOL_REVISION_VATSIM_AUTH 100
@@ -139,12 +140,14 @@ namespace BlackCore
//! \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); }
//! @}
@@ -169,19 +172,22 @@ namespace BlackCore
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; }
//! @}
@@ -199,7 +205,8 @@ namespace BlackCore
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);
@@ -269,7 +276,8 @@ namespace BlackCore
void sendQueuedMessage();
//! @}
//! 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);
//! @}
@@ -295,7 +303,8 @@ namespace BlackCore
this->sendMessageString(messageToFSDString(message));
}
//! Unit test/debug functions @{
//! Unit test/debug functions
//! @{
void sendFsdMessage(const QString &message);
void setUnitTestMode(bool on) { m_unitTestMode = on; }
//! @}
@@ -346,7 +355,8 @@ namespace BlackCore
// 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);
@@ -418,7 +428,8 @@ namespace BlackCore
//! Emit raw FSD message (mostly for debugging)
void emitRawFsdMessage(const QString &fsdMessage, bool isSent);
//! Additional offset time @{
//! Additional offset time
//! @{
qint64 getAdditionalOffsetTime() const;
void setAdditionalOffsetTime(qint64 addOffset);
//! @}
@@ -426,7 +437,8 @@ namespace BlackCore
//! Save the statistics
bool saveNetworkStatistics(const QString &server);
//! Timers @{
//! Timers
//! @{
void startPositionTimers();
void stopPositionTimers();
//! @}

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

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

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

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

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

@@ -36,7 +36,8 @@ namespace BlackCore
//! 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;

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

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

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

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

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

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

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

@@ -38,17 +38,19 @@ namespace BlackCore
//! PDU identifier
static QString pdu() { return "-MD"; }
//! Properties @{
//! Properties
//! @{
ClientQueryType m_queryType = ClientQueryType::Unknown;
QStringList m_queryData;
//! @}
//! Properties @{
//! Properties
//! @{
QString m_partsval1;
QString m_partsval2;
QString m_partsval3;
//! @
//! @}
private:
RevBClientParts();

3
src/blackcore/fsd/serializer.cpp
View File

@@ -21,7 +21,8 @@ namespace BlackCore
{
namespace Fsd
{
//! private @{
//! private
//! @{
namespace Private
{

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

@@ -37,12 +37,14 @@ namespace BlackCore
//! 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;