From 57ae33a8d2d78880bc64da060e7640da2fac1c7e Mon Sep 17 00:00:00 2001
From: Mat Sutcliffe <oktal3700@gmail.com>
Date: Wed, 11 Jun 2025 14:27:55 +0100
Subject: [PATCH] fix: doxygen warnings

---
 src/gui/views/viewbase.h                  |  2 +-
 src/misc/simulation/ownaircraftprovider.h | 10 ++++++----
 src/misc/threadedtimer.h                  |  2 ++
 src/plugins/simulator/fsx/simulatorfsx.h  |  3 ++-
 tests/misc/aviation/testongroundinfo.cpp  |  1 +
 5 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/src/gui/views/viewbase.h b/src/gui/views/viewbase.h
index 9512a043c..965990963 100644
--- a/src/gui/views/viewbase.h
+++ b/src/gui/views/viewbase.h
@@ -397,7 +397,7 @@ namespace swift::gui
 
             //! Show loading indicator
             //! \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
             int showLoadIndicator(int containerSizeDependent = -1,
                                   std::chrono::milliseconds timeout = std::chrono::milliseconds { 0 },
diff --git a/src/misc/simulation/ownaircraftprovider.h b/src/misc/simulation/ownaircraftprovider.h
index f9ed29126..bb476bcd1 100644
--- a/src/misc/simulation/ownaircraftprovider.h
+++ b/src/misc/simulation/ownaircraftprovider.h
@@ -160,13 +160,15 @@ namespace swift::misc
             swift::misc::physical_quantities::CLength
             getDistanceToOwnAircraft(const swift::misc::geo::ICoordinateGeodetic &position) const;
 
-            //! \copydoc IOwnAircraftProvider::updateCockpit(const swift::misc::simulation::CSimulatedAircraft &, const
-            //! swift::misc::CIdentifier &)
+            // clang-format off
+            //! \copydoc IOwnAircraftProvider::updateCockpit(const swift::misc::simulation::CSimulatedAircraft &, const swift::misc::CIdentifier &)
+            // clang-format on
             bool updateCockpit(const swift::misc::simulation::CSimulatedAircraft &aircraft,
                                const swift::misc::CIdentifier &originator);
 
-            //! \copydoc IOwnAircraftProvider::updateCockpit(const aviation::CComSystem &, const aviation::CComSystem &,
-            //! const aviation::CTransponder &, const swift::misc::CIdentifier &);
+            // clang-format off
+            //! \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,
                                const aviation::CTransponder &transponder, const swift::misc::CIdentifier &originator);
 
diff --git a/src/misc/threadedtimer.h b/src/misc/threadedtimer.h
index 2fe8c5a95..4df0c5fc2 100644
--- a/src/misc/threadedtimer.h
+++ b/src/misc/threadedtimer.h
@@ -18,6 +18,7 @@ namespace swift::misc
     {
         Q_OBJECT
     public:
+        //! Constructor
         CThreadedTimer(QObject *owner, const QString &name, bool singleShot = false);
 
         //! Destructor
@@ -32,6 +33,7 @@ namespace swift::misc
         void stopTimer();
 
     signals:
+        //! Timer timed out
         void timeout();
 
     private:
diff --git a/src/plugins/simulator/fsx/simulatorfsx.h b/src/plugins/simulator/fsx/simulatorfsx.h
index 0637992ee..c79ecc6dd 100644
--- a/src/plugins/simulator/fsx/simulatorfsx.h
+++ b/src/plugins/simulator/fsx/simulatorfsx.h
@@ -22,7 +22,7 @@ namespace swift::simplugin::fsx
                       swift::misc::simulation::IRemoteAircraftProvider *remoteAircraftProvider,
                       swift::misc::network::IClientProvider *clientProvider, QObject *parent = nullptr);
 
-        //! \name ISimulator implementations
+        //! ISimulator implementations
         //! @{
         virtual bool connectTo() override;
         //! @}
@@ -38,6 +38,7 @@ namespace swift::simplugin::fsx
         using CSimulatorFsxCommonListener::CSimulatorFsxCommonListener;
 
     protected:
+        //! \copydoc swift::core::ISimulatorListener::startImpl
         virtual void startImpl() override;
     };
 } // namespace swift::simplugin::fsx
diff --git a/tests/misc/aviation/testongroundinfo.cpp b/tests/misc/aviation/testongroundinfo.cpp
index ff31fcf48..e84b3af59 100644
--- a/tests/misc/aviation/testongroundinfo.cpp
+++ b/tests/misc/aviation/testongroundinfo.cpp
@@ -77,6 +77,7 @@ namespace MiscTest
 
 } // namespace MiscTest
 
+//! main
 SWIFTTEST_APPLESS_MAIN(MiscTest::CMiscOnGroundInfo);
 
 #include "testongroundinfo.moc"