[doxygen] Fix broken groupings

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

View File

@@ -179,13 +179,15 @@ namespace BlackSimPlugin
//! \remark this is where the interpolated data are set
void updateRemoteAircraft();
//! Request elevation and CG from Flightgear @{
//! Request elevation and CG from Flightgear
//! @{
void requestRemoteAircraftDataFromFlightgear();
void requestRemoteAircraftDataFromFlightgear(const BlackMisc::Aviation::CCallsignSet &callsigns);
void triggerRequestRemoteAircraftDataFromFlightgear(const BlackMisc::Aviation::CCallsignSet &callsigns);
//! @}
//! Adding new aircraft @{
//! Adding new aircraft
//! @{
void addNextPendingAircraft();
void triggerAddNextPendingAircraft();
//! @}
@@ -202,7 +204,8 @@ namespace BlackSimPlugin
//! Can the next aircraft be added?
bool canAddAircraft() const;
//! Callbacks from simulator @{
//! Callbacks from simulator
//! @{
void onRemoteAircraftAdded(const QString &callsign);
void onRemoteAircraftAddingFailed(const QString &callsign);
void updateRemoteAircraftFromSimulator(const QStringList &callsigns, const QDoubleList &latitudesDeg, const QDoubleList &longitudesDeg,

View File

@@ -52,7 +52,8 @@ namespace BlackSimPlugin
//! Starts the FS9 client messaging
void start();
//! Get interpolator @{
//! Get interpolator
//! @{
BlackMisc::Simulation::CInterpolatorMulti *getInterpolator() { return &m_interpolator; }
const BlackMisc::Simulation::CInterpolatorMulti *getInterpolator() const { return &m_interpolator; }
//! @}

View File

@@ -51,7 +51,7 @@ namespace BlackSimPlugin
virtual ~CSimulatorFs9() override = default;
//! \name Interface implementations
//! \@{
//! @{
virtual bool connectTo() override;
virtual bool disconnectFrom() override;
virtual bool physicallyAddRemoteAircraft(const BlackMisc::Simulation::CSimulatedAircraft &newRemoteAircraft) override;
@@ -66,14 +66,14 @@ namespace BlackSimPlugin
virtual BlackMisc::CStatusMessageList getInterpolationMessages(const BlackMisc::Aviation::CCallsign &callsign) const override;
virtual bool testSendSituationAndParts(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::Aviation::CAircraftSituation &situation, const BlackMisc::Aviation::CAircraftParts &parts) override;
virtual void injectWeatherGrid(const BlackMisc::Weather::CWeatherGrid &weatherGrid) override;
//! \@}
//! @}
protected:
//! \name Interface implementations
//! \@{
//! @{
virtual bool isConnected() const override;
virtual bool isSimulating() const override { return isConnected(); }
//! \@}
//! @}
//! Timer event dispatching
//! \sa m_timerId

View File

@@ -18,7 +18,8 @@ namespace BlackSimPlugin
{
namespace FsCommon
{
//! Correctly casted values/checks @{
//! Correctly casted values/checks
//! @{
HRESULT inline s_ok() { return S_OK; }
HRESULT inline s_false() { return S_FALSE; }
static bool inline isOk(HRESULT result) { return result == s_ok(); }

View File

@@ -100,7 +100,8 @@ namespace BlackSimPlugin
char atcAirline[64]; //!< Airline used by ATC
char atcFlightNumber[8]; //!< Flight Number used by ATC
//! Copy the strings, length from docu @{
//! Copy the strings, length from docu
//! @{
void copyAtcId(const char *c) { strncpy_s(atcId, c, 10); atcId[9] = 0; }
void copyAtcAirline(const char *c) { strncpy_s(atcAirline, c, 50); atcAirline[49] = 0; }
void copyFlightNumber(const char *c) { strncpy_s(atcFlightNumber, c, 6); atcFlightNumber[5] = 0; }

View File

@@ -70,7 +70,8 @@ typedef HRESULT(__stdcall *PfnSimConnect_SetObserverLookAt)(HANDLE, const char *
#endif
//! The SimConnect Symbols
//! \private @{
//! \private
//! @{
struct SimConnectSymbols
{
PfnSimConnect_Open SimConnect_Open = nullptr;
@@ -113,7 +114,7 @@ struct SimConnectSymbols
PfnSimConnect_CloseView SimConnect_CloseView = nullptr;
#endif
};
//! @ }
//! @}
static SimConnectSymbols gSymbols;

View File

@@ -300,7 +300,8 @@ namespace BlackSimPlugin
//! Register help
static void registerHelp();
//! Word size @{
//! Word size
//! @{
static bool is32bit() { return (BlackConfig::CBuildConfig::buildWordSize() == 32); }
static bool is64bit() { return (BlackConfig::CBuildConfig::buildWordSize() == 64); }
//! @}
@@ -629,7 +630,8 @@ namespace BlackSimPlugin
static QString requestIdToString(DWORD requestId);
public:
//! Offsets @{
//! Offsets
//! @{
static DWORD offsetSimObjAircraft(CSimConnectDefinitions::SimObjectRequest req) { return MaxSimObjAircraft * static_cast<DWORD>(req); }
static DWORD offsetSimObjTerrainProbe(CSimConnectDefinitions::SimObjectRequest req) { return MaxSimObjProbes * static_cast<DWORD>(req); }
//! @}

View File

@@ -197,13 +197,15 @@ namespace BlackSimPlugin
//! Update airports
void updateAirportsInRange();
//! Request elevation and CG from XPlane @{
//! Request elevation and CG from XPlane
//! @{
void requestRemoteAircraftDataFromXPlane();
void requestRemoteAircraftDataFromXPlane(const BlackMisc::Aviation::CCallsignSet &callsigns);
void triggerRequestRemoteAircraftDataFromXPlane(const BlackMisc::Aviation::CCallsignSet &callsigns);
//! @}
//! Adding new aircraft @{
//! Adding new aircraft
//! @{
void addNextPendingAircraft();
void triggerAddNextPendingAircraft();
//! @}
@@ -220,7 +222,8 @@ namespace BlackSimPlugin
//! Can the next aircraft be added? No other aircraft adding in progress?
bool canAddAircraft() const;
//! Callbacks from simulator @{
//! Callbacks from simulator
//! @{
void onRemoteAircraftAdded(const QString &callsign);
void onRemoteAircraftAddingFailed(const QString &callsign);
void updateRemoteAircraftFromSimulator(const QStringList &callsigns, const QDoubleList &latitudesDeg, const QDoubleList &longitudesDeg,
@@ -230,7 +233,8 @@ namespace BlackSimPlugin
//! Disconnect from DBus
void disconnectFromDBus();
//! Send/receive settings @{
//! Send/receive settings
//! @{
bool sendXSwiftBusSettings();
BlackMisc::Simulation::Settings::CXSwiftBusSettings receiveXSwiftBusSettings(bool &ok);
//! @}