From 291c95160fea15cc065c9f16e9566cc2e56d777b Mon Sep 17 00:00:00 2001 From: Klaus Basan Date: Mon, 7 Dec 2015 02:11:20 +0100 Subject: [PATCH] Doxygen fixes refs #544 --- src/blackcore/audiodevicevatlib.h | 2 +- src/blackcore/contextapplicationempty.h | 2 +- src/blackcore/contextapplicationimpl.h | 2 +- src/blackcore/contextaudioempty.h | 8 +- src/blackcore/contextnetworkempty.h | 6 +- src/blackcore/contextownaircraftempty.h | 8 +- src/blackcore/contextsimulatorempty.h | 4 +- src/blackcore/webdataservices.h | 76 +++++++++--------- src/blackgui/components/aircraftcomponent.h | 4 +- src/blackgui/components/atcstationcomponent.h | 6 +- src/blackgui/components/simulatorcomponent.h | 6 +- src/blackgui/components/usercomponent.h | 6 +- src/blackgui/editors/aircrafticaoform.h | 2 +- src/blackgui/editors/airlineicaoform.h | 2 +- src/blackgui/editors/distributorform.h | 2 +- src/blackgui/editors/liveryform.h | 4 +- src/blackgui/editors/modelmappingform.h | 2 +- src/blackgui/models/listmodelbase.h | 2 +- src/blackgui/views/viewbase.h | 8 +- .../network/webdataservicesprovider.h | 78 +++++++++---------- .../simulation/fscommon/aircraftcfgparser.h | 2 +- .../simulator/xplane/simulatorxplane.h | 2 +- 22 files changed, 117 insertions(+), 117 deletions(-) diff --git a/src/blackcore/audiodevicevatlib.h b/src/blackcore/audiodevicevatlib.h index 269739c6e..b3516a8d4 100644 --- a/src/blackcore/audiodevicevatlib.h +++ b/src/blackcore/audiodevicevatlib.h @@ -34,7 +34,7 @@ namespace BlackCore //! Destructor virtual ~CAudioInputDeviceVatlib() = default; - //! \copydoc IAudioInputDevice::getOutputDevices + //! \copydoc IAudioInputDevice::getInputDevices virtual const BlackMisc::Audio::CAudioDeviceInfoList &getInputDevices() const override; //! \copydoc IAudioInputDevice::getDefaultInputDevice diff --git a/src/blackcore/contextapplicationempty.h b/src/blackcore/contextapplicationempty.h index 1851d1ba7..e07054684 100644 --- a/src/blackcore/contextapplicationempty.h +++ b/src/blackcore/contextapplicationempty.h @@ -135,7 +135,7 @@ namespace BlackCore return BlackMisc::CIdentifier(); } - //! \copydoc IContextApplication::unRegisterApplication + //! \copydoc IContextApplication::unregisterApplication virtual void unregisterApplication(const BlackMisc::CIdentifier &application) override { Q_UNUSED(application); diff --git a/src/blackcore/contextapplicationimpl.h b/src/blackcore/contextapplicationimpl.h index 1cb28db50..69696fe3e 100644 --- a/src/blackcore/contextapplicationimpl.h +++ b/src/blackcore/contextapplicationimpl.h @@ -71,7 +71,7 @@ namespace BlackCore //! \copydoc IContextApplication::registerApplication virtual BlackMisc::CIdentifier registerApplication(const BlackMisc::CIdentifier &application) override; - //! \copydoc IContextApplication::unRegisterApplication + //! \copydoc IContextApplication::unregisterApplication virtual void unregisterApplication(const BlackMisc::CIdentifier &application) override; //! \copydoc IContextApplication::getRegisteredApplications diff --git a/src/blackcore/contextaudioempty.h b/src/blackcore/contextaudioempty.h index 20e22d386..0a0990090 100644 --- a/src/blackcore/contextaudioempty.h +++ b/src/blackcore/contextaudioempty.h @@ -109,21 +109,21 @@ namespace BlackCore logEmptyContextWarning(Q_FUNC_INFO); } - //! \copydoc IContext::setVoiceOutputVolume + //! \copydoc IContextAudio::setVoiceOutputVolume virtual void setVoiceOutputVolume(int volume) override { Q_UNUSED(volume); logEmptyContextWarning(Q_FUNC_INFO); } - //! \copydoc IContext::getVoiceOutputVolume + //! \copydoc IContextAudio::getVoiceOutputVolume virtual int getVoiceOutputVolume() const override { logEmptyContextWarning(Q_FUNC_INFO); return 0; } - //! \copydoc ICOntext::setMute + //! \copydoc IContextAudio::setMute virtual void setMute(bool muted) override { Q_UNUSED(muted); @@ -159,7 +159,7 @@ namespace BlackCore logEmptyContextWarning(Q_FUNC_INFO); } - //! \copydoc ICOntextAudio::isAudioLoopbackEnabled + //! \copydoc IContextAudio::isAudioLoopbackEnabled virtual bool isAudioLoopbackEnabled() const override { logEmptyContextWarning(Q_FUNC_INFO); diff --git a/src/blackcore/contextnetworkempty.h b/src/blackcore/contextnetworkempty.h index 2bdd533ec..5e2ca1fff 100644 --- a/src/blackcore/contextnetworkempty.h +++ b/src/blackcore/contextnetworkempty.h @@ -65,7 +65,7 @@ namespace BlackCore return BlackMisc::Simulation::CSimulatedAircraft(); } - //! \copydoc IRemoteAircraftProvider::getAircraftInRangeCount + //! \copydoc IContextNetwork::getAircraftInRangeCount virtual int getAircraftInRangeCount() const override { logEmptyContextWarning(Q_FUNC_INFO); @@ -132,7 +132,7 @@ namespace BlackCore return BlackMisc::Aviation::CFlightPlan(); } - //! \copydoc IContextNetwork::getMetar + //! \copydoc IContextNetwork::getMetarForAirport BlackMisc::Weather::CMetar getMetarForAirport(const BlackMisc::Aviation::CAirportIcaoCode &airportIcaoCode) const override { Q_UNUSED(airportIcaoCode); @@ -185,7 +185,7 @@ namespace BlackCore return BlackMisc::Network::CClientList(); } - //! \copydoc IContextNetwork::getOtherClientForCallsigns + //! \copydoc IContextNetwork::getOtherClientsForCallsigns virtual BlackMisc::Network::CClientList getOtherClientsForCallsigns(const BlackMisc::Aviation::CCallsignSet &callsigns) const override { Q_UNUSED(callsigns); diff --git a/src/blackcore/contextownaircraftempty.h b/src/blackcore/contextownaircraftempty.h index 63e0c30dd..96294932d 100644 --- a/src/blackcore/contextownaircraftempty.h +++ b/src/blackcore/contextownaircraftempty.h @@ -35,7 +35,7 @@ namespace BlackCore return BlackMisc::Simulation::CSimulatedAircraft(); } - //! \copydoc IContextOwnAircraft::updatePosition + //! \copydoc IContextOwnAircraft::updateOwnPosition virtual bool updateOwnPosition(const BlackMisc::Geo::CCoordinateGeodetic &position, const BlackMisc::Aviation::CAltitude &altitude) override { Q_UNUSED(position); @@ -55,7 +55,7 @@ namespace BlackCore return false; } - //! \copydoc IContextOwnAircraft::updateComFrequency + //! \copydoc IContextOwnAircraft::updateActiveComFrequency virtual bool updateActiveComFrequency(const BlackMisc::PhysicalQuantities::CFrequency &frequency, BlackMisc::Aviation::CComSystem::ComUnit comUnit, const BlackMisc::CIdentifier &originator) override { Q_UNUSED(frequency); @@ -65,7 +65,7 @@ namespace BlackCore return false; } - //! \copydoc IContextOwnAircraft::updatePilot + //! \copydoc IContextOwnAircraft::updateOwnAircraftPilot virtual bool updateOwnAircraftPilot(const BlackMisc::Network::CUser &pilot) override { Q_UNUSED(pilot); @@ -99,7 +99,7 @@ namespace BlackCore return false; } - //! \copydoc IContextOwnAircraft::setAudioOutputVolumes + //! \copydoc IContextOwnAircraft::setAudioOutputVolume virtual void setAudioOutputVolume(int outputVolume) override { Q_UNUSED(outputVolume); diff --git a/src/blackcore/contextsimulatorempty.h b/src/blackcore/contextsimulatorempty.h index d231df80b..4a2608094 100644 --- a/src/blackcore/contextsimulatorempty.h +++ b/src/blackcore/contextsimulatorempty.h @@ -129,7 +129,7 @@ namespace BlackCore return 0; } - //! \copydoc IContextSimulator::setMaxRenderedRemoteAircraft + //! \copydoc IContextSimulator::setMaxRenderedAircraft virtual void setMaxRenderedAircraft(int number) override { Q_UNUSED(number); @@ -208,7 +208,7 @@ namespace BlackCore logEmptyContextWarning(Q_FUNC_INFO); } - //! \copydoc ISimulator::enableDebuggingMessages + //! \copydoc ISimulator::enableDebugMessages virtual void enableDebugMessages(bool driver, bool interpolator) override { Q_UNUSED(driver); diff --git a/src/blackcore/webdataservices.h b/src/blackcore/webdataservices.h index 9bdcee413..3dd9d475b 100644 --- a/src/blackcore/webdataservices.h +++ b/src/blackcore/webdataservices.h @@ -77,157 +77,157 @@ namespace BlackCore // ------------------------ provider functionality start ------------------------------ - //! \copydoc IWebDataReaderProvider::connectDataReadSignal + //! \copydoc IWebDataServicesProvider::connectDataReadSignal //! \ingroup webdatareaderprovider virtual QList connectDataReadSignal( QObject *receiver, std::function dataRead) override; - //! \copydoc IWebDataReaderProvider::triggerRead + //! \copydoc IWebDataServicesProvider::triggerRead //! \ingroup webdatareaderprovider virtual BlackMisc::Network::CEntityFlags::Entity triggerRead(BlackMisc::Network::CEntityFlags::Entity whatToRead) override; - //! \copydoc IWebDataReaderProvider::getVatsimFsdServers + //! \copydoc IWebDataServicesProvider::getVatsimFsdServers //! \ingroup webdatareaderprovider virtual BlackMisc::Network::CServerList getVatsimFsdServers() const override; - //! \copydoc IWebDataReaderProvider::getVatsimVoiceServers + //! \copydoc IWebDataServicesProvider::getVatsimVoiceServers //! \ingroup webdatareaderprovider virtual BlackMisc::Network::CServerList getVatsimVoiceServers() const override; - //! \copydoc IWebDataReaderProvider::getDistributors + //! \copydoc IWebDataServicesProvider::getDistributors //! \ingroup webdatareaderprovider virtual BlackMisc::Simulation::CDistributorList getDistributors() const override; - //! \copydoc IWebDataReaderProvider::getDistributorsCount + //! \copydoc IWebDataServicesProvider::getDistributorsCount //! \ingroup webdatareaderprovider virtual int getDistributorsCount() const override; - //! \copydoc IWebDataReaderProvider::smartDistributorSelector + //! \copydoc IWebDataServicesProvider::smartDistributorSelector //! \ingroup webdatareaderprovider virtual BlackMisc::Simulation::CDistributor smartDistributorSelector(const BlackMisc::Simulation::CDistributor &distributor) const override; - //! \copydoc IWebDataReaderProvider::getLiveries + //! \copydoc IWebDataServicesProvider::getLiveries //! \ingroup webdatareaderprovider virtual BlackMisc::Aviation::CLiveryList getLiveries() const override; - //! \copydoc IWebDataReaderProvider::getLiveriesCount + //! \copydoc IWebDataServicesProvider::getLiveriesCount //! \ingroup webdatareaderprovider virtual int getLiveriesCount() const override; - //! \copydoc IWebDataReaderProvider::getLiveryForCombinedCode + //! \copydoc IWebDataServicesProvider::getLiveryForCombinedCode //! \ingroup webdatareaderprovider virtual BlackMisc::Aviation::CLivery getLiveryForCombinedCode(const QString &combinedCode) const override; - //! \copydoc IWebDataReaderProvider::getLiveryForDbKey + //! \copydoc IWebDataServicesProvider::getLiveryForDbKey //! \ingroup webdatareaderprovider virtual BlackMisc::Aviation::CLivery getLiveryForDbKey(int id) const override; - //! \copydoc IWebDataReaderProvider::smartLiverySelector + //! \copydoc IWebDataServicesProvider::smartLiverySelector //! \ingroup webdatareaderprovider virtual BlackMisc::Aviation::CLivery smartLiverySelector(const BlackMisc::Aviation::CLivery &livery) const override; - //! \copydoc IWebDataReaderProvider::getModels + //! \copydoc IWebDataServicesProvider::getModels //! \ingroup webdatareaderprovider virtual BlackMisc::Simulation::CAircraftModelList getModels() const override; - //! \copydoc IWebDataReaderProvider::getModelsCount + //! \copydoc IWebDataServicesProvider::getModelsCount //! \ingroup webdatareaderprovider virtual int getModelsCount() const override; - //! \copydoc IWebDataReaderProvider::getModelsForAircraftDesignatorAndLiveryCombinedCode + //! \copydoc IWebDataServicesProvider::getModelsForAircraftDesignatorAndLiveryCombinedCode //! \ingroup webdatareaderprovider virtual BlackMisc::Simulation::CAircraftModelList getModelsForAircraftDesignatorAndLiveryCombinedCode(const QString &aircraftDesignator, const QString &combinedCode) const override; - //! \copydoc IWebDataReaderProvider::getModelForModelString + //! \copydoc IWebDataServicesProvider::getModelForModelString //! \ingroup webdatareaderprovider virtual BlackMisc::Simulation::CAircraftModel getModelForModelString(const QString &modelString) const override; - //! \copydoc IWebDataReaderProvider::getAircraftIcaoCodes + //! \copydoc IWebDataServicesProvider::getAircraftIcaoCodes //! \ingroup webdatareaderprovider virtual BlackMisc::Aviation::CAircraftIcaoCodeList getAircraftIcaoCodes() const override; - //! \copydoc IWebDataReaderProvider::getAircraftIcaoCodesCount + //! \copydoc IWebDataServicesProvider::getAircraftIcaoCodesCount //! \ingroup webdatareaderprovider virtual int getAircraftIcaoCodesCount() const override; - //! \copydoc IWebDataReaderProvider::getAircraftIcaoCodeForDesignator + //! \copydoc IWebDataServicesProvider::getAircraftIcaoCodeForDesignator //! \ingroup webdatareaderprovider virtual BlackMisc::Aviation::CAircraftIcaoCode getAircraftIcaoCodeForDesignator(const QString &designator) const override; - //! \copydoc IWebDataReaderProvider::getAircraftIcaoCodeForDbKey + //! \copydoc IWebDataServicesProvider::getAircraftIcaoCodeForDbKey //! \ingroup webdatareaderprovider virtual BlackMisc::Aviation::CAircraftIcaoCode getAircraftIcaoCodeForDbKey(int key) const override; - //! \copydoc IWebDataReaderProvider::getAircraftIcaoCodeForDbKey + //! \copydoc IWebDataServicesProvider::getAircraftIcaoCodeForDbKey //! \ingroup webdatareaderprovider virtual BlackMisc::Aviation::CAircraftIcaoCode smartAircraftIcaoSelector(const BlackMisc::Aviation::CAircraftIcaoCode &icao) const override; - //! \copydoc IWebDataReaderProvider::getAirlineIcaoCodes + //! \copydoc IWebDataServicesProvider::getAirlineIcaoCodes //! \ingroup webdatareaderprovider virtual BlackMisc::Aviation::CAirlineIcaoCodeList getAirlineIcaoCodes() const override; - //! \copydoc IWebDataReaderProvider::getAirlineIcaoCodesCount + //! \copydoc IWebDataServicesProvider::getAirlineIcaoCodesCount //! \ingroup webdatareaderprovider virtual int getAirlineIcaoCodesCount() const override; - //! \copydoc IWebDataReaderProvider::getAirlineIcaoCodeForDbKey + //! \copydoc IWebDataServicesProvider::getAirlineIcaoCodeForDbKey //! \ingroup webdatareaderprovider virtual BlackMisc::Aviation::CAirlineIcaoCode getAirlineIcaoCodeForDbKey(int key) const override; - //! \copydoc IWebDataReaderProvider::getAirlineIcaoCodeForDesignator + //! \copydoc IWebDataServicesProvider::getAirlineIcaoCodeForDesignator //! \ingroup webdatareaderprovider virtual BlackMisc::Aviation::CAirlineIcaoCode getAirlineIcaoCodeForDesignator(const QString &designator) const override; - //! \copydoc IWebDataReaderProvider::getCountries + //! \copydoc IWebDataServicesProvider::getCountries //! \ingroup webdatareaderprovider virtual BlackMisc::CCountryList getCountries() const override; - //! \copydoc IWebDataReaderProvider::getCountries + //! \copydoc IWebDataServicesProvider::getCountries //! \ingroup webdatareaderprovider virtual int getCountriesCount() const override; - //! \copydoc IWebDataReaderProvider::getCountryForName + //! \copydoc IWebDataServicesProvider::getCountryForName //! \ingroup webdatareaderprovider virtual BlackMisc::CCountry getCountryForName(const QString &name) const override; - //! \copydoc IWebDataReaderProvider::getCountryForIsoCode + //! \copydoc IWebDataServicesProvider::getCountryForIsoCode //! \ingroup webdatareaderprovider virtual BlackMisc::CCountry getCountryForIsoCode(const QString &iso) const override; - //! \copydoc IWebDataReaderProvider::getMetars + //! \copydoc IWebDataServicesProvider::getMetars //! \ingroup webdatareaderprovider virtual BlackMisc::Weather::CMetarSet getMetars() const override; - //! \copydoc IWebDataReaderProvider::getMetarForAirport + //! \copydoc IWebDataServicesProvider::getMetarForAirport //! \ingroup webdatareaderprovider virtual BlackMisc::Weather::CMetar getMetarForAirport(const BlackMisc::Aviation::CAirportIcaoCode &icao) const override; - //! \copydoc IWebDataReaderProvider::getMetarForAirport + //! \copydoc IWebDataServicesProvider::getMetarForAirport //! \ingroup webdatareaderprovider virtual int getMetarsCount() const override; - //! \copydoc IWebDataReaderProvider::getUsersForCallsign + //! \copydoc IWebDataServicesProvider::getUsersForCallsign //! \ingroup webdatareaderprovider virtual BlackMisc::Network::CUserList getUsersForCallsign(const BlackMisc::Aviation::CCallsign &callsign) const override; - //! \copydoc IWebDataReaderProvider::getAtcStationsForCallsign + //! \copydoc IWebDataServicesProvider::getAtcStationsForCallsign //! \ingroup webdatareaderprovider virtual BlackMisc::Aviation::CAtcStationList getAtcStationsForCallsign(const BlackMisc::Aviation::CCallsign &callsign) const override; - //! \copydoc IWebDataReaderProvider::getVoiceCapabilityForCallsign + //! \copydoc IWebDataServicesProvider::getVoiceCapabilityForCallsign //! \ingroup webdatareaderprovider virtual BlackMisc::Network::CVoiceCapabilities getVoiceCapabilityForCallsign(const BlackMisc::Aviation::CCallsign &callsign) const override; - //! \copydoc IWebDataReaderProvider::updateWithWebData + //! \copydoc IWebDataServicesProvider::updateWithWebData //! \ingroup webdatareaderprovider virtual void updateWithVatsimDataFileData(BlackMisc::Simulation::CSimulatedAircraft &aircraftToBeUdpated) const override; - //! \copydoc IWebDataReaderProvider::asyncWriteModel + //! \copydoc IWebDataServicesProvider::asyncWriteModel //! \ingroup webdatareaderprovider virtual BlackMisc::CStatusMessageList asyncWriteModel(BlackMisc::Simulation::CAircraftModel &model) const override; - //! \copydoc IWebDataReaderProvider::canConnectSwiftDb + //! \copydoc IWebDataServicesProvider::canConnectSwiftDb //! \ingroup webdatareaderprovider virtual bool canConnectSwiftDb() const override; diff --git a/src/blackgui/components/aircraftcomponent.h b/src/blackgui/components/aircraftcomponent.h index 7d56ffb89..7de296e6d 100644 --- a/src/blackgui/components/aircraftcomponent.h +++ b/src/blackgui/components/aircraftcomponent.h @@ -55,10 +55,10 @@ namespace BlackGui //! Update aircrafts void update(); - //! \copydoc CTimerBasedComponent::setUpdateIntervalSeconds + //! \copydoc CUpdateTimer::setUpdateIntervalSeconds void setUpdateIntervalSeconds(int seconds) { Q_ASSERT(this->m_updateTimer); this->m_updateTimer->setUpdateIntervalSeconds(seconds); } - //! \copydoc CTimerBasedComponent::stopTimer + //! \copydoc CUpdateTimer::stopTimer void stopTimer() { Q_ASSERT(this->m_updateTimer); this->m_updateTimer->stopTimer(); } protected: diff --git a/src/blackgui/components/atcstationcomponent.h b/src/blackgui/components/atcstationcomponent.h index 94af7ae2d..56fe04a61 100644 --- a/src/blackgui/components/atcstationcomponent.h +++ b/src/blackgui/components/atcstationcomponent.h @@ -59,10 +59,10 @@ namespace BlackGui //! Update stations void update(); - //! \copydoc CTimerBasedComponent::setUpdateIntervalSeconds + //! \copydoc CUpdateTimer::setUpdateIntervalSeconds void setUpdateIntervalSeconds(int seconds) { Q_ASSERT(this->m_updateTimer); this->m_updateTimer->setUpdateIntervalSeconds(seconds); } - //! \copydoc CTimerBasedComponent::stopTimer + //! \copydoc CUpdateTimer::stopTimer void stopTimer() { Q_ASSERT(this->m_updateTimer); this->m_updateTimer->stopTimer(); } //! Get METAR for given ICAO airport code @@ -72,7 +72,7 @@ namespace BlackGui void changedAtcStationOnlineConnectionStatus(const BlackMisc::Aviation::CAtcStation &station, bool added); protected: - //! \copydoc CRuntimeBasedComponent::runtimeHasBeenSet + //! \copydoc CEnableForRuntime::runtimeHasBeenSet void runtimeHasBeenSet() override; private slots: diff --git a/src/blackgui/components/simulatorcomponent.h b/src/blackgui/components/simulatorcomponent.h index c077b015e..d12dec4eb 100644 --- a/src/blackgui/components/simulatorcomponent.h +++ b/src/blackgui/components/simulatorcomponent.h @@ -59,13 +59,13 @@ namespace BlackGui //! Update simulator void update(); - //! \copydoc CTimerBasedComponent::setUpdateIntervalSeconds + //! \copydoc CUpdateTimer::setUpdateIntervalSeconds void setUpdateIntervalSeconds(int seconds) { Q_ASSERT(this->m_updateTimer); this->m_updateTimer->setUpdateIntervalSeconds(seconds); } - //! \copydoc CTimerBasedComponent::setUpdateInterval + //! \copydoc CUpdateTimer::setUpdateInterval void setUpdateInterval(int milliSeconds) { Q_ASSERT(this->m_updateTimer); this->m_updateTimer->setUpdateInterval(milliSeconds); } - //! \copydoc CTimerBasedComponent::stopTimer + //! \copydoc CUpdateTimer::stopTimer void stopTimer() { Q_ASSERT(this->m_updateTimer); this->m_updateTimer->stopTimer(); } protected: diff --git a/src/blackgui/components/usercomponent.h b/src/blackgui/components/usercomponent.h index 06779c207..a62e83394 100644 --- a/src/blackgui/components/usercomponent.h +++ b/src/blackgui/components/usercomponent.h @@ -52,14 +52,14 @@ namespace BlackGui //! Update users void update(); - //! \copydoc CTimerBasedComponent::setUpdateIntervalSeconds + //! \copydoc CUpdateTimer::setUpdateIntervalSeconds void setUpdateIntervalSeconds(int seconds) { Q_ASSERT(this->m_updateTimer); this->m_updateTimer->setUpdateIntervalSeconds(seconds); } - //! \copydoc CTimerBasedComponent::stopTimer + //! \copydoc CUpdateTimer::stopTimer void stopTimer() { Q_ASSERT(this->m_updateTimer); this->m_updateTimer->stopTimer(); } protected: - //! \copydoc CRuntimeBasedComponent::runtimeHasBeenSet + //! \copydoc CEnableForRuntime::runtimeHasBeenSet void runtimeHasBeenSet() override; private slots: diff --git a/src/blackgui/editors/aircrafticaoform.h b/src/blackgui/editors/aircrafticaoform.h index f5dd7e7cd..235543e58 100644 --- a/src/blackgui/editors/aircrafticaoform.h +++ b/src/blackgui/editors/aircrafticaoform.h @@ -52,7 +52,7 @@ namespace BlackGui //! Is drop allowed? bool isDropAllowed() const; - //! \copydoc CEditor::setReadOnly + //! \copydoc CForm::setReadOnly virtual void setReadOnly(bool readOnly) override; //! Clear diff --git a/src/blackgui/editors/airlineicaoform.h b/src/blackgui/editors/airlineicaoform.h index 9b011ad6a..d1c855388 100644 --- a/src/blackgui/editors/airlineicaoform.h +++ b/src/blackgui/editors/airlineicaoform.h @@ -55,7 +55,7 @@ namespace BlackGui //! Is drop allowed? bool isDropAllowed() const; - //! \copydoc CEditor::setReadOnly + //! \copydoc CForm::setReadOnly virtual void setReadOnly(bool readOnly) override; //! Clear diff --git a/src/blackgui/editors/distributorform.h b/src/blackgui/editors/distributorform.h index 31ee81405..28749ebe2 100644 --- a/src/blackgui/editors/distributorform.h +++ b/src/blackgui/editors/distributorform.h @@ -52,7 +52,7 @@ namespace BlackGui //! Is drop allowed? bool isDropAllowed() const; - //! \copydoc CEditor::setReadOnly + //! \copydoc CForm::setReadOnly void setReadOnly(bool readOnly); //! Clear diff --git a/src/blackgui/editors/liveryform.h b/src/blackgui/editors/liveryform.h index 2f8f5e10b..75b434325 100644 --- a/src/blackgui/editors/liveryform.h +++ b/src/blackgui/editors/liveryform.h @@ -39,7 +39,7 @@ namespace BlackGui //! Destructor ~CLiveryForm(); - //! \copydoc CWebDataReaderAware::setProvider + //! \copydoc CWebDataServicesAware::setProvider virtual void setProvider(BlackMisc::Network::IWebDataServicesProvider *provider) override; //! Value @@ -57,7 +57,7 @@ namespace BlackGui //! Is drop allowed? bool isDropAllowed() const; - //! \copydoc CEditor::setReadOnly + //! \copydoc CForm::setReadOnly virtual void setReadOnly(bool readOnly) override; //! Mapping mode diff --git a/src/blackgui/editors/modelmappingform.h b/src/blackgui/editors/modelmappingform.h index f90d27310..51ecf1da6 100644 --- a/src/blackgui/editors/modelmappingform.h +++ b/src/blackgui/editors/modelmappingform.h @@ -42,7 +42,7 @@ namespace BlackGui //! Validate BlackMisc::CStatusMessageList validate(bool withNestedForms) const; - //! \copydoc CEditor::setReadOnly + //! \copydoc CForm::setReadOnly virtual void setReadOnly(bool readOnly) override; public slots: diff --git a/src/blackgui/models/listmodelbase.h b/src/blackgui/models/listmodelbase.h index 8e9ce60c2..4d3cd08b5 100644 --- a/src/blackgui/models/listmodelbase.h +++ b/src/blackgui/models/listmodelbase.h @@ -87,7 +87,7 @@ namespace BlackGui //! \copydoc QStandardItemModel::supportedDropActions virtual Qt::DropActions supportedDropActions() const override; - //! \copydoc QStandardItemModel::supportedDropActions + //! \copydoc QStandardItemModel::mimeTypes virtual QStringList mimeTypes() const override; //! Mark as about to be destroyed, normally marked from view diff --git a/src/blackgui/views/viewbase.h b/src/blackgui/views/viewbase.h index ed157a7f7..0df0ed4f5 100644 --- a/src/blackgui/views/viewbase.h +++ b/src/blackgui/views/viewbase.h @@ -356,13 +356,13 @@ namespace BlackGui //! Set the search indicator based on model void setSortIndicator(); - //! \copydoc CViewBaseNonTemplate::standardInit + //! Standard initialization void standardInit(ModelClass *model = nullptr); //! \copydoc CViewBaseNonTemplate::reachedResizeThreshold virtual bool reachedResizeThreshold(int containrerSize = -1) const override; - //! \copydoc CViewBaseNonTemplate::performResizing + //! \copydoc CViewBaseNonTemplate::performModeBasedResizeToContent virtual void performModeBasedResizeToContent() override; //! \copydoc CViewBaseNonTemplate::performUpdateContainer @@ -372,9 +372,9 @@ namespace BlackGui //! \remarks Actually a slot, but not defined as such as the template does not support Q_OBJECT virtual bool ps_filterDialogFinished(int status) override; - //! \copydoc CViewBaseNonTemplate::ps_FilterWidgetChangedFilter + //! \copydoc CViewBaseNonTemplate::ps_filterWidgetChangedFilter(bool) //! \remarks Actually a slot, but not defined as such as the template does not support Q_OBJECT - virtual bool ps_filterWidgetChangedFilter(bool enabled) override; + virtual bool ps_filterWidgetChangedFilter(bool enabled) override; //! \copydoc CViewBaseNonTemplate::ps_removeFilter //! \remarks Actually a slot, but not defined as such as the template does not support Q_OBJECT diff --git a/src/blackmisc/network/webdataservicesprovider.h b/src/blackmisc/network/webdataservicesprovider.h index 41d0f3dbf..234d39ea2 100644 --- a/src/blackmisc/network/webdataservicesprovider.h +++ b/src/blackmisc/network/webdataservicesprovider.h @@ -212,110 +212,110 @@ namespace BlackMisc ~CWebDataServicesAware(); public: - //! \copydoc IWebDataReaderProvider::getMetarForAirport + //! \copydoc IWebDataServicesProvider::getMetarForAirport BlackMisc::Weather::CMetar getMetarForAirport(const BlackMisc::Aviation::CAirportIcaoCode &icao) const; protected: //! Constructor CWebDataServicesAware(IWebDataServicesProvider *webDataReaderProvider = nullptr) : m_webDataReaderProvider(webDataReaderProvider) { } - //! \copydoc IWebDataReaderProvider::getVatsimFsdServers + //! \copydoc IWebDataServicesProvider::getVatsimFsdServers BlackMisc::Network::CServerList getVatsimFsdServers() const; - //! \copydoc IWebDataReaderProvider::getVatsimVoiceServers + //! \copydoc IWebDataServicesProvider::getVatsimVoiceServers BlackMisc::Network::CServerList getVatsimVoiceServers() const; - //! \copydoc IWebDataReaderProvider::getUsersForCallsign + //! \copydoc IWebDataServicesProvider::getUsersForCallsign BlackMisc::Network::CUserList getUsersForCallsign(const BlackMisc::Aviation::CCallsign &callsign) const; - //! \copydoc IWebDataReaderProvider::getAtcStationsForCallsign + //! \copydoc IWebDataServicesProvider::getAtcStationsForCallsign BlackMisc::Aviation::CAtcStationList getAtcStationsForCallsign(const BlackMisc::Aviation::CCallsign &callsign) const; - //! \copydoc IWebDataReaderProvider::getVoiceCapabilityForCallsign + //! \copydoc IWebDataServicesProvider::getVoiceCapabilityForCallsign BlackMisc::Network::CVoiceCapabilities getVoiceCapabilityForCallsign(const BlackMisc::Aviation::CCallsign &callsign) const; - //! \copydoc IWebDataReaderProvider::getDistributors + //! \copydoc IWebDataServicesProvider::getDistributors BlackMisc::Simulation::CDistributorList getDistributors() const; - //! \copydoc IWebDataReaderProvider::smartDistributorSelector + //! \copydoc IWebDataServicesProvider::smartDistributorSelector BlackMisc::Simulation::CDistributor smartDistributorSelector(const BlackMisc::Simulation::CDistributor &distributor) const; - //! \copydoc IWebDataReaderProvider::getDistributorsCount + //! \copydoc IWebDataServicesProvider::getDistributorsCount int getDistributorsCount() const; - //! \copydoc IWebDataReaderProvider::getLiveries + //! \copydoc IWebDataServicesProvider::getLiveries BlackMisc::Aviation::CLiveryList getLiveries() const; - //! \copydoc IWebDataReaderProvider::getLiveries + //! \copydoc IWebDataServicesProvider::getLiveries int getLiveriesCount() const; - //! \copydoc IWebDataReaderProvider::getLiveryForCombinedCode + //! \copydoc IWebDataServicesProvider::getLiveryForCombinedCode BlackMisc::Aviation::CLivery getLiveryForCombinedCode(const QString &combinedCode) const; - //! \copydoc IWebDataReaderProvider::smartLiverySelector + //! \copydoc IWebDataServicesProvider::smartLiverySelector BlackMisc::Aviation::CLivery smartLiverySelector(const Aviation::CLivery &livery) const; - //! \copydoc IWebDataReaderProvider::getModels + //! \copydoc IWebDataServicesProvider::getModels BlackMisc::Simulation::CAircraftModelList getModels() const; - //! \copydoc IWebDataReaderProvider::getModelsCount + //! \copydoc IWebDataServicesProvider::getModelsCount int getModelsCount() const; - //! \copydoc IWebDataReaderProvider::getModelsForAircraftDesignatorAndLiveryCombinedCode + //! \copydoc IWebDataServicesProvider::getModelsForAircraftDesignatorAndLiveryCombinedCode BlackMisc::Simulation::CAircraftModelList getModelsForAircraftDesignatorAndLiveryCombinedCode(const QString &aircraftDesignator, const QString &combinedCode) const; - //! \copydoc IWebDataReaderProvider::getModelForModelString + //! \copydoc IWebDataServicesProvider::getModelForModelString BlackMisc::Simulation::CAircraftModel getModelForModelString(const QString &modelString) const; - //! \copydoc IWebDataReaderProvider::getAircraftIcaoCodes + //! \copydoc IWebDataServicesProvider::getAircraftIcaoCodes BlackMisc::Aviation::CAircraftIcaoCodeList getAircraftIcaoCodes() const; - //! \copydoc IWebDataReaderProvider::getAircraftIcaoCodesCount + //! \copydoc IWebDataServicesProvider::getAircraftIcaoCodesCount int getAircraftIcaoCodesCount() const; - //! \copydoc IWebDataReaderProvider::getAircraftIcaoCodeForDesignator + //! \copydoc IWebDataServicesProvider::getAircraftIcaoCodeForDesignator BlackMisc::Aviation::CAircraftIcaoCode getAircraftIcaoCodeForDesignator(const QString &designator) const; - //! \copydoc IWebDataReaderProvider::getAircraftIcaoCodeForId + //! \copydoc IWebDataServicesProvider::getAircraftIcaoCodeForDbKey BlackMisc::Aviation::CAircraftIcaoCode getAircraftIcaoCodeForDbKey(int id) const; - //! \copydoc IWebDataReaderProvider::getAirlineIcaoCodes + //! \copydoc IWebDataServicesProvider::getAirlineIcaoCodes BlackMisc::Aviation::CAirlineIcaoCodeList getAirlineIcaoCodes() const; - //! \copydoc IWebDataReaderProvider::getAirlineIcaoCodesCount + //! \copydoc IWebDataServicesProvider::getAirlineIcaoCodesCount int getAirlineIcaoCodesCount() const; - //! \copydoc IWebDataReaderProvider::getAirlineIcaoCodeForDesignator + //! \copydoc IWebDataServicesProvider::getAirlineIcaoCodeForDesignator BlackMisc::Aviation::CAirlineIcaoCode getAirlineIcaoCodeForDesignator(const QString &designator) const; - //! \copydoc IWebDataReaderProvider::getAirlineIcaoCodeForId + //! \copydoc IWebDataServicesProvider::getAirlineIcaoCodeForDbKey BlackMisc::Aviation::CAirlineIcaoCode getAirlineIcaoCodeForDbKey(int id) const; - //! \copydoc IWebDataReaderProvider::smartAircraftIcaoSelector + //! \copydoc IWebDataServicesProvider::smartAircraftIcaoSelector BlackMisc::Aviation::CAircraftIcaoCode smartAircraftIcaoSelector(const BlackMisc::Aviation::CAircraftIcaoCode &icao) const; - //! \copydoc IWebDataReaderProvider::getCountries + //! \copydoc IWebDataServicesProvider::getCountries BlackMisc::CCountryList getCountries() const; - //! \copydoc IWebDataReaderProvider::getCountriesCount + //! \copydoc IWebDataServicesProvider::getCountriesCount int getCountriesCount() const; - //! \copydoc IWebDataReaderProvider::getCountryForIsoCode + //! \copydoc IWebDataServicesProvider::getCountryForIsoCode BlackMisc::CCountry getCountryForIsoCode(const QString &iso) const; - //! \copydoc IWebDataReaderProvider::getCountryForName + //! \copydoc IWebDataServicesProvider::getCountryForName BlackMisc::CCountry getCountryForName(const QString &name) const; - //! \copydoc IWebDataReaderProvider::getMetars + //! \copydoc IWebDataServicesProvider::getMetars BlackMisc::Weather::CMetarSet getMetars() const; - //! \copydoc IWebDataReaderProvider::getMetarCount + //! \copydoc IWebDataServicesProvider::getMetarCount int getMetarCount() const; - //! \copydoc IWebDataReaderProvider::updateWithWebData + //! \copydoc IWebDataServicesProvider::updateWithVatsimDataFileData void updateWithVatsimDataFileData(BlackMisc::Simulation::CSimulatedAircraft &aircraftToBeUdpated) const; - //! \copydoc IWebDataReaderProvider::asyncWriteModel + //! \copydoc IWebDataServicesProvider::asyncWriteModel BlackMisc::CStatusMessageList asyncWriteModelToDb(BlackMisc::Simulation::CAircraftModel &model) const; //! Set the provider @@ -327,21 +327,21 @@ namespace BlackMisc //! Called when provider should no longer be used void gracefulShutdown(); - //! \copydoc IWebDataReaderProvider::connectDataReadSignal + //! \copydoc IWebDataServicesProvider::connectDataReadSignal void connectDataReadSignal( QObject *receiver, std::function dataRead); - //! \copydoc IWebDataReaderProvider::triggerRead + //! \copydoc IWebDataServicesProvider::triggerRead BlackMisc::Network::CEntityFlags::Entity triggerRead(BlackMisc::Network::CEntityFlags::Entity whatToRead); - //! \copydoc IWebDataReaderProvider::canConnectSwiftDb + //! \copydoc IWebDataServicesProvider::canConnectSwiftDb bool canConnectSwiftDb() const; - //! \copydoc IWebDataReaderProvider::writeDbDataToDisk + //! \copydoc IWebDataServicesProvider::writeDbDataToDisk bool writeDbDataToDisk(const QString &dir) const; - //! \copydoc IWebDataReaderProvider::readDbDataFromDisk + //! \copydoc IWebDataServicesProvider::readDbDataFromDisk bool readDbDataFromDisk(const QString &dir, bool inBackround); private: diff --git a/src/blackmisc/simulation/fscommon/aircraftcfgparser.h b/src/blackmisc/simulation/fscommon/aircraftcfgparser.h index 796a5b409..31f07977b 100644 --- a/src/blackmisc/simulation/fscommon/aircraftcfgparser.h +++ b/src/blackmisc/simulation/fscommon/aircraftcfgparser.h @@ -50,7 +50,7 @@ namespace BlackMisc //! Get parsed aircraft cfg entries list const CAircraftCfgEntriesList &getAircraftCfgEntriesList() const { return m_parsedCfgEntriesList; } - //! \copydoc IAircraftModelLoader::getPixmapForModel + //! \copydoc IAircraftModelLoader::iconForModel virtual BlackMisc::CPixmap iconForModel(const QString &modelName, BlackMisc::CStatusMessage &statusMessage) const override; //! \copydoc IAircraftModelLoader::startLoading diff --git a/src/plugins/simulator/xplane/simulatorxplane.h b/src/plugins/simulator/xplane/simulatorxplane.h index b5de2dfec..431239ff7 100644 --- a/src/plugins/simulator/xplane/simulatorxplane.h +++ b/src/plugins/simulator/xplane/simulatorxplane.h @@ -117,7 +117,7 @@ namespace BlackSimPlugin //! \copydoc BlackCore::ISimulator::isConnected virtual bool isConnected() const override; - //! \copydoc ISimulator::isSimPaused + //! \copydoc ISimulator::isPaused virtual bool isPaused() const override { //! \todo XP: provide correct pause state