fix: doxygen warnings

This commit is contained in:
Mat Sutcliffe
2025-06-11 14:27:55 +01:00
committed by Lars Toenning
parent 2ed1161508
commit 57ae33a8d2
5 changed files with 12 additions and 6 deletions

View File

@@ -397,7 +397,7 @@ namespace swift::gui
//! Show loading indicator //! Show loading indicator
//! \param containerSizeDependent check against resize threshold if indicator makes sense //! \param containerSizeDependent check against resize threshold if indicator makes sense
//! \param timeoutMs timeout the loading indicator //! \param timeout timeout the loading indicator
//! \param processEvents force event processing to display indicator by updating GUI //! \param processEvents force event processing to display indicator by updating GUI
int showLoadIndicator(int containerSizeDependent = -1, int showLoadIndicator(int containerSizeDependent = -1,
std::chrono::milliseconds timeout = std::chrono::milliseconds { 0 }, std::chrono::milliseconds timeout = std::chrono::milliseconds { 0 },

View File

@@ -160,13 +160,15 @@ namespace swift::misc
swift::misc::physical_quantities::CLength swift::misc::physical_quantities::CLength
getDistanceToOwnAircraft(const swift::misc::geo::ICoordinateGeodetic &position) const; getDistanceToOwnAircraft(const swift::misc::geo::ICoordinateGeodetic &position) const;
//! \copydoc IOwnAircraftProvider::updateCockpit(const swift::misc::simulation::CSimulatedAircraft &, const // clang-format off
//! swift::misc::CIdentifier &) //! \copydoc IOwnAircraftProvider::updateCockpit(const swift::misc::simulation::CSimulatedAircraft &, const swift::misc::CIdentifier &)
// clang-format on
bool updateCockpit(const swift::misc::simulation::CSimulatedAircraft &aircraft, bool updateCockpit(const swift::misc::simulation::CSimulatedAircraft &aircraft,
const swift::misc::CIdentifier &originator); const swift::misc::CIdentifier &originator);
//! \copydoc IOwnAircraftProvider::updateCockpit(const aviation::CComSystem &, const aviation::CComSystem &, // clang-format off
//! const aviation::CTransponder &, const swift::misc::CIdentifier &); //! \copydoc IOwnAircraftProvider::updateCockpit(const aviation::CComSystem &, const aviation::CComSystem &, const aviation::CTransponder &, const swift::misc::CIdentifier &)
// clang-format on
bool updateCockpit(const aviation::CComSystem &com1, const aviation::CComSystem &com2, bool updateCockpit(const aviation::CComSystem &com1, const aviation::CComSystem &com2,
const aviation::CTransponder &transponder, const swift::misc::CIdentifier &originator); const aviation::CTransponder &transponder, const swift::misc::CIdentifier &originator);

View File

@@ -18,6 +18,7 @@ namespace swift::misc
{ {
Q_OBJECT Q_OBJECT
public: public:
//! Constructor
CThreadedTimer(QObject *owner, const QString &name, bool singleShot = false); CThreadedTimer(QObject *owner, const QString &name, bool singleShot = false);
//! Destructor //! Destructor
@@ -32,6 +33,7 @@ namespace swift::misc
void stopTimer(); void stopTimer();
signals: signals:
//! Timer timed out
void timeout(); void timeout();
private: private:

View File

@@ -22,7 +22,7 @@ namespace swift::simplugin::fsx
swift::misc::simulation::IRemoteAircraftProvider *remoteAircraftProvider, swift::misc::simulation::IRemoteAircraftProvider *remoteAircraftProvider,
swift::misc::network::IClientProvider *clientProvider, QObject *parent = nullptr); swift::misc::network::IClientProvider *clientProvider, QObject *parent = nullptr);
//! \name ISimulator implementations //! ISimulator implementations
//! @{ //! @{
virtual bool connectTo() override; virtual bool connectTo() override;
//! @} //! @}
@@ -38,6 +38,7 @@ namespace swift::simplugin::fsx
using CSimulatorFsxCommonListener::CSimulatorFsxCommonListener; using CSimulatorFsxCommonListener::CSimulatorFsxCommonListener;
protected: protected:
//! \copydoc swift::core::ISimulatorListener::startImpl
virtual void startImpl() override; virtual void startImpl() override;
}; };
} // namespace swift::simplugin::fsx } // namespace swift::simplugin::fsx

View File

@@ -77,6 +77,7 @@ namespace MiscTest
} // namespace MiscTest } // namespace MiscTest
//! main
SWIFTTEST_APPLESS_MAIN(MiscTest::CMiscOnGroundInfo); SWIFTTEST_APPLESS_MAIN(MiscTest::CMiscOnGroundInfo);
#include "testongroundinfo.moc" #include "testongroundinfo.moc"