Fix doxygen copydoc documentation

The following issues were fixed * Fixed wrong/missing namespaces * Fixed obvious typos in documentation * Documentation not in sync with source code refs #544
2026-04-05 09:15:34 +08:00 · 2016-02-07 18:40:11 +01:00
parent dfb6798d31
commit 794bf0cd74
154 changed files with 399 additions and 399 deletions
--- a/src/blackgui/components/aircraftcomponent.h
+++ b/src/blackgui/components/aircraftcomponent.h
@@ -62,7 +62,7 @@ namespace BlackGui
            void stopTimer() { Q_ASSERT(this->m_updateTimer); this->m_updateTimer->stopTimer(); }

        protected:
-            //! \copydoc CRuntimeBasedComponent::runtimeHasBeenSet
+            //! \copydoc CEnableForRuntime::runtimeHasBeenSet
            void runtimeHasBeenSet() override;

        private slots:
--- a/src/blackgui/components/atcstationcomponent.h
+++ b/src/blackgui/components/atcstationcomponent.h
@@ -68,7 +68,7 @@ namespace BlackGui
            //! Get METAR for given ICAO airport code
            void getMetar(const QString &airportIcaoCode);

-            //! \copydoc CAtcStationListModel::changedAtcStationConnectionStatus
+            //! \copydoc Models::CAtcStationListModel::changedAtcStationConnectionStatus
            void changedAtcStationOnlineConnectionStatus(const BlackMisc::Aviation::CAtcStation &station, bool added);

        protected:
--- a/src/blackgui/components/audiosetupcomponent.h
+++ b/src/blackgui/components/audiosetupcomponent.h
@@ -43,7 +43,7 @@ namespace BlackGui
            bool playNotificationSounds() const;

        protected:
-            //! \copydoc CRuntimeBasedComponent::runtimeHasBeenSet
+            //! \copydoc CEnableForRuntime::runtimeHasBeenSet
            virtual void runtimeHasBeenSet() override;

        private slots:
--- a/src/blackgui/components/cockpitcomponent.h
+++ b/src/blackgui/components/cockpitcomponent.h
@@ -37,7 +37,7 @@ namespace BlackGui
            //! Destructor
            ~CCockpitComponent();

-            //! \copydoc CDockWidgetInfoArea::setParentDockWidgetInfoArea
+            //! \copydoc CEnableForDockWidgetInfoArea::setParentDockWidgetInfoArea
            virtual bool setParentDockWidgetInfoArea(BlackGui::CDockWidgetInfoArea *parentDockableWidget) override;

            //! Is the info area shown?
--- a/src/blackgui/components/dbaircrafticaoselectorcomponent.h
+++ b/src/blackgui/components/dbaircrafticaoselectorcomponent.h
@@ -43,7 +43,7 @@ namespace BlackGui
            //! Destructor
            ~CDbAircraftIcaoSelectorComponent();

-            //! \copydoc CWebDataReaderAware::setProvider
+            //! \copydoc BlackMisc::Network::CWebDataServicesAware::setProvider
            virtual void setProvider(BlackMisc::Network::IWebDataServicesProvider *webDataReaderProvider) override;

            //! Current aircraft ICAO
--- a/src/blackgui/components/dbairlineicaoselectorbase.h
+++ b/src/blackgui/components/dbairlineicaoselectorbase.h
@@ -37,7 +37,7 @@ namespace BlackGui
            //! Destructor
            virtual ~CDbAirlineIcaoSelectorBase();

-            //! \copydoc CWebDataReaderAware::setProvider
+            //! \copydoc BlackMisc::Network::CWebDataServicesAware::setProvider
            virtual void setProvider(BlackMisc::Network::IWebDataServicesProvider *webDataReaderProvider) override;

            //! Current airline ICAO
--- a/src/blackgui/components/dbautostashingcomponent.h
+++ b/src/blackgui/components/dbautostashingcomponent.h
@@ -49,7 +49,7 @@ namespace BlackGui
            //! Destructor
            ~CDbAutoStashingComponent();

-            //! \copydoc CWebDataServicesAware::setProvider
+            //! \copydoc BlackMisc::Network::CWebDataServicesAware::setProvider
            virtual void setProvider(BlackMisc::Network::IWebDataServicesProvider *webDataReaderProvider) override;

            //! At least run once and completed
--- a/src/blackgui/components/dbcountryselectorcomponent.h
+++ b/src/blackgui/components/dbcountryselectorcomponent.h
@@ -43,7 +43,7 @@ namespace BlackGui
            //! Destructor
            ~CDbCountrySelectorComponent();

-            //! \copydoc CWebDataReaderAware::setProvider
+            //! \copydoc BlackMisc::Network::CWebDataServicesAware::setProvider
            virtual void setProvider(BlackMisc::Network::IWebDataServicesProvider *webDataReaderProvider) override;

            //! Current country
--- a/src/blackgui/components/dbdistributorselectorcomponent.h
+++ b/src/blackgui/components/dbdistributorselectorcomponent.h
@@ -43,7 +43,7 @@ namespace BlackGui
            //! Destructor
            ~CDbDistributorSelectorComponent();

-            //! \copydoc CWebDataReaderAware::setProvider
+            //! \copydoc BlackMisc::Network::CWebDataServicesAware::setProvider
            virtual void setProvider(BlackMisc::Network::IWebDataServicesProvider *webDataReaderProvider) override;

            //! Current distributor
--- a/src/blackgui/components/dbliveryselectorcomponent.h
+++ b/src/blackgui/components/dbliveryselectorcomponent.h
@@ -43,7 +43,7 @@ namespace BlackGui
            //! Destructor
            ~CDbLiverySelectorComponent();

-            //! \copydoc CWebDataReaderAware::setProvider
+            //! \copydoc BlackMisc::Network::CWebDataServicesAware::setProvider
            virtual void setProvider(BlackMisc::Network::IWebDataServicesProvider *webDataReaderProvider) override;

            //! Current livery
--- a/src/blackgui/components/dbmappingcomponent.h
+++ b/src/blackgui/components/dbmappingcomponent.h
@@ -64,7 +64,7 @@ namespace BlackGui
            //! Destructor
            ~CDbMappingComponent();

-            //! \copydoc CWebDataReaderAware::setProvider
+            //! \copydoc BlackMisc::Network::CWebDataServicesAware::setProvider
            virtual void setProvider(BlackMisc::Network::IWebDataServicesProvider *provider) override;

            //! Graceful shutdown
--- a/src/blackgui/components/dbstashcomponent.h
+++ b/src/blackgui/components/dbstashcomponent.h
@@ -49,7 +49,7 @@ namespace BlackGui
            //! Destructor
            ~CDbStashComponent();

-            //! \copydoc CWebDataReaderAware::setProvider
+            //! \copydoc BlackMisc::Network::CWebDataServicesAware::setProvider
            virtual void setProvider(BlackMisc::Network::IWebDataServicesProvider *provider) override;

            //! Graceful shutdown
--- a/src/blackgui/components/enableforruntime.h
+++ b/src/blackgui/components/enableforruntime.h
@@ -108,7 +108,7 @@ namespace BlackGui
            //! \remarks use this methods to hook up signal/slots with runtime
            virtual void runtimeHasBeenSet() {}

-            //! \copydoc CRuntime::hasRemoteApplicationContext
+            //! \copydoc BlackCore::CRuntime::hasRemoteApplicationContext
            bool hasRemoteApplicationContext() const { return this->m_runtime->hasRemoteApplicationContext(); }

            //! Play a given notification sound
--- a/src/blackgui/components/infobarstatuscomponent.h
+++ b/src/blackgui/components/infobarstatuscomponent.h
@@ -48,7 +48,7 @@ namespace BlackGui
            void setDBusTooltip(const QString &tooltip);

        protected:
-            //! \copydoc CRuntimeBasedComponent::runtimeHasBeenSet
+            //! \copydoc CEnableForRuntime::runtimeHasBeenSet
            virtual void runtimeHasBeenSet() override;

        private:
--- a/src/blackgui/components/mainkeypadareacomponent.h
+++ b/src/blackgui/components/mainkeypadareacomponent.h
@@ -69,7 +69,7 @@ namespace BlackGui
            void onMainInfoAreaChanged(int currentTabIndex, QList<int> dockedIndexes, QList<int> floatingIndexes);

        protected:
-            //! \copydoc CRuntimeBasedComponent::runtimeHasBeenSet
+            //! \copydoc CEnableForRuntime::runtimeHasBeenSet
            virtual void runtimeHasBeenSet() override;

        private slots:
--- a/src/blackgui/components/mappingcomponent.h
+++ b/src/blackgui/components/mappingcomponent.h
@@ -52,7 +52,7 @@ namespace BlackGui
            //! Numer of models
            int countAircraftModels() const;

-            //! \copydoc CListModelBase::getModelsStartsWith
+            //! Find models starting with
            BlackMisc::Simulation::CAircraftModelList findModelsStartingWith(const QString modelName, Qt::CaseSensitivity cs);

        signals:
@@ -60,7 +60,7 @@ namespace BlackGui
            void requestTextMessageWidget(const BlackMisc::Aviation::CCallsign &callsign);

        protected:
-            //! \copydoc CRuntimeBasedComponent::runtimeHasBeenSet
+            //! \copydoc CEnableForRuntime::runtimeHasBeenSet
            virtual void runtimeHasBeenSet() override;

        private slots:
--- a/src/blackgui/components/registercomponent.h
+++ b/src/blackgui/components/registercomponent.h
@@ -35,7 +35,7 @@ namespace BlackGui
            ~CRegisterComponent();

        protected:
-            //! \copydoc CRuntimeBasedComponent::runtimeHasBeenSet
+            //! \copydoc CEnableForRuntime::runtimeHasBeenSet
            virtual void runtimeHasBeenSet() override;

        private slots:
--- a/src/blackgui/components/settingscomponent.h
+++ b/src/blackgui/components/settingscomponent.h
@@ -85,7 +85,7 @@ namespace BlackGui
            void setSettingsTab(SettingTab tab);

        protected:
-            //! \copydoc CRuntimeBasedComponent::runtimeHasBeenSet
+            //! \copydoc CEnableForRuntime::runtimeHasBeenSet
            virtual void runtimeHasBeenSet() override;

        private slots:
--- a/src/blackgui/components/settingsnetworkcomponent.h
+++ b/src/blackgui/components/settingsnetworkcomponent.h
@@ -38,7 +38,7 @@ namespace BlackGui
            ~CSettingsNetworkComponent();

        protected:
-            //! \copydoc CRuntimeBasedComponent::runtimeHasBeenSet
+            //! \copydoc CEnableForRuntime::runtimeHasBeenSet
            virtual void runtimeHasBeenSet() override;

        private:
--- a/src/blackgui/components/settingssimulatorcomponent.h
+++ b/src/blackgui/components/settingssimulatorcomponent.h
@@ -36,7 +36,7 @@ namespace BlackGui
            ~CSettingsSimulatorComponent();

        protected:
-            //! \copydoc CRuntimeBasedComponent::runtimeHasBeenSet()
+            //! \copydoc CEnableForRuntime::runtimeHasBeenSet()
            virtual void runtimeHasBeenSet() override;

        private slots:
--- a/src/blackgui/components/textmessagecomponent.h
+++ b/src/blackgui/components/textmessagecomponent.h
@@ -75,7 +75,7 @@ namespace BlackGui
            void showCorrespondingTab(const BlackMisc::Aviation::CCallsign &callsign);

        protected:
-            //! \copydoc CRuntimeBasedComponent::runtimeHasBeenSet
+            //! \copydoc CEnableForRuntime::runtimeHasBeenSet
            void runtimeHasBeenSet() override;

        private: