Doxygen fixes

.github/workflows/build.yml

@@ -17,6 +17,7 @@ concurrency:
 env:
   do_vatsim_key: ${{ github.event_name == 'push' }}
   do_symbols:    ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+  do_doxygen:    ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
   qt_version:    6.8.0
   bitrock_version: qt-professional-24.7.0
   bitrock_url:     https://releases.installbuilder.com/installbuilder
@@ -81,16 +82,25 @@ jobs:
           cppcheck --template=gcc --inline-suppr --std=c++17 --enable=style,unusedFunction \
                    -i src/plugins/weatherdata/gfs/g2clib -DCPPCHECK --force --suppressions-list=cppcheck.supp \
                    --library=qt.cfg --library=posix.cfg .
+      - name: Install Qt docs
+        if: ${{ env.do_doxygen == 'true' }}
+        uses: jurplel/install-qt-action@v4
+        with:
+          version: ${{ env.qt_version }}
+          no-qt-binaries: true
+          documentation: true
+          cache: true
       - name: Run doxygen
-        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        if: ${{ env.do_doxygen == 'true' }}
         working-directory: docs
         run: |
           sudo apt-get -y install doxygen graphviz
           doxygen Doxyfile
         env:
           DOXY_SRC_ROOT: ..
+          DOXY_TAGFILES: ${{ runner.workspace }}/Qt/Docs/Qt-${{ env.qt_version }}
       - name: Upload doxygen
-        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        if: ${{ env.do_doxygen == 'true' }}
         uses: actions/upload-pages-artifact@v3
         with:
           path: docs/html/

docs/Doxyfile

@@ -2199,6 +2199,25 @@ SKIP_FUNCTION_MACROS   = YES
 # the path). If a tag file is not located in the directory in which doxygen is
 # run, you must also specify the path to the tagfile here.
 
+TAGFILES               = $(DOXY_TAGFILES)/qdoc/qdoc.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qmake/qmake.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qtconcurrent/qtconcurrent.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qtcore/qtcore.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qtdbus/qtdbus.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qtgui/qtgui.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qtnetwork/qtnetwork.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qtopengl/qtopengl.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qtqml/qtqml.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qtqmlcore/qtqmlcore.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qtqmlmodels/qtqmlmodels.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qtqmltest/qtqmltest.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qtqmlworkerscript/qtqmlworkerscript.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qtqmlxmllistmodel/qtqmlxmllistmodel.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qtsvg/qtsvg.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qttestlib/qttestlib.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qtwidgets/qtwidgets.tags=http://doc.qt.io/qt-6/ \
+                         $(DOXY_TAGFILES)/qtxml/qtxml.tags=http://doc.qt.io/qt-6/
+
 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
 # tag file that is based on the input files it reads. See section "Linking to
 # external documentation" for more information about the usage of tag files.

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 },

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);
 

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:

src/plugins/simulator/flightgear/simulatorflightgear.cpp

@@ -99,7 +99,6 @@ namespace swift::simplugin::flightgear
         connect(&m_pendingAddedTimer, &QTimer::timeout, this, &CSimulatorFlightgear::addNextPendingAircraft);
         m_fastTimer.start(100);
         m_slowTimer.start(1000);
-        m_airportUpdater.start(60 * 1000);
         m_pendingAddedTimer.start(5000);
 
         this->setDefaultModel(

src/plugins/simulator/flightgear/simulatorflightgear.h

@@ -228,7 +228,6 @@ namespace swift::simplugin::flightgear
         CFGSwiftBusTrafficProxy *m_trafficProxy { nullptr };
         QTimer m_fastTimer;
         QTimer m_slowTimer;
-        QTimer m_airportUpdater;
         QTimer m_pendingAddedTimer;
         swift::misc::CData<swift::misc::simulation::data::TModelSetCacheFG> m_modelSet {
             this

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

src/plugins/simulator/xplane/simulatorxplane.cpp

@@ -101,11 +101,9 @@ namespace swift::simplugin::xplane
         m_pendingAddedTimer.setObjectName(this->objectName().append(":m_pendingAddedTimer"));
         connect(&m_fastTimer, &QTimer::timeout, this, &CSimulatorXPlane::fastTimerTimeout);
         connect(&m_slowTimer, &QTimer::timeout, this, &CSimulatorXPlane::slowTimerTimeout);
-        connect(&m_airportUpdater, &QTimer::timeout, this, &CSimulatorXPlane::updateAirportsInRange);
         connect(&m_pendingAddedTimer, &QTimer::timeout, this, &CSimulatorXPlane::addNextPendingAircraft);
         m_fastTimer.start(100);
         m_slowTimer.start(1000);
-        m_airportUpdater.start(60 * 1000);
         m_pendingAddedTimer.start(5000);
 
         this->setDefaultModel({ "Jets A320_a A320_a_Austrian_Airlines A320_a_Austrian_Airlines",
@@ -498,7 +496,6 @@ namespace swift::simplugin::xplane
         setSimulatorDetails("X-Plane", {}, xplaneVersion);
         connect(m_serviceProxy, &CXSwiftBusServiceProxy::aircraftModelChanged, this,
                 &CSimulatorXPlane::emitOwnAircraftModelChanged);
-        m_serviceProxy->updateAirportsInRange();
         connect(m_trafficProxy, &CXSwiftBusTrafficProxy::simFrame, this, &CSimulatorXPlane::updateRemoteAircraft);
         connect(m_trafficProxy, &CXSwiftBusTrafficProxy::remoteAircraftAdded, this,
                 &CSimulatorXPlane::onRemoteAircraftAdded);
@@ -1155,12 +1152,6 @@ namespace swift::simplugin::xplane
         }
     }
 
-    void CSimulatorXPlane::updateAirportsInRange()
-    {
-        if (this->isShuttingDownOrDisconnected()) { return; }
-        m_serviceProxy->updateAirportsInRange();
-    }
-
     void CSimulatorXPlane::onRemoteAircraftAdded(const QString &callsign)
     {
         SWIFT_VERIFY_X(!callsign.isEmpty(), Q_FUNC_INFO, "Need callsign");

src/plugins/simulator/xplane/simulatorxplane.h

@@ -200,9 +200,6 @@ namespace swift::simplugin::xplane
         //! \remark this is where the interpolated data are set
         void updateRemoteAircraft();
 
-        //! Update airports
-        void updateAirportsInRange();
-
         //! @{
         //! Request elevation and CG from XPlane
         void requestRemoteAircraftDataFromXPlane();
@@ -275,7 +272,6 @@ namespace swift::simplugin::xplane
         CXSwiftBusTrafficProxy *m_trafficProxy { nullptr };
         QTimer m_fastTimer;
         QTimer m_slowTimer;
-        QTimer m_airportUpdater;
         QTimer m_pendingAddedTimer;
         unsigned int m_fastTimerCalls = 0; //!< how often called
         unsigned int m_slowTimerCalls = 0; //!< how often called

src/plugins/simulator/xplane/xswiftbusserviceproxy.cpp

@@ -210,11 +210,6 @@ namespace swift::simplugin::xplane
         m_dbusInterface->callDBus(QLatin1String("addTextMessage"), text, red, green, blue);
     }
 
-    void CXSwiftBusServiceProxy::updateAirportsInRange()
-    {
-        m_dbusInterface->callDBus(QLatin1String("updateAirportsInRange"));
-    }
-
     QString CXSwiftBusServiceProxy::getAircraftModelPath() const
     {
         return m_dbusInterface->callDBusRet<QString>(QLatin1String("getAircraftModelPath"));

src/plugins/simulator/xplane/xswiftbusserviceproxy.h

@@ -123,9 +123,6 @@ namespace swift::simplugin::xplane
         //! \copydoc XSwiftBus::CService::addTextMessage
         void addTextMessage(const QString &text, double red, double green, double blue);
 
-        //! \copydoc XSwiftBus::CService::updateAirportsInRange
-        void updateAirportsInRange();
-
         //! @{
         //! \copydoc XSwiftBus::CService::getAircraftModelPath
         QString getAircraftModelPath() const;

src/xswiftbus/org.swift_project.xswiftbus.service.xml

@@ -66,8 +66,6 @@ R"XML(<node>
       <arg name="path" type="s" direction="out"/>
       <arg name="icao" type="s" direction="out"/>
     </method>
-    <method name="updateAirportsInRange">
-    </method>
     <method name="getAircraftModelPath">
       <arg type="s" direction="out"/>
     </method>

tests/misc/aviation/testongroundinfo.cpp

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