flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-04-12 15:25:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Doxygen fixes refs #544

Browse Source
This commit is contained in:
Klaus Basan
2015-12-07 02:11:20 +01:00
parent 22ca6ae922
commit 291c95160f
22 changed files with 117 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/blackcore/audiodevicevatlib.h
View File

@@ -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

2
src/blackcore/contextapplicationempty.h
View File

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

2
src/blackcore/contextapplicationimpl.h
View File

@@ -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

8
src/blackcore/contextaudioempty.h
View File

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

6
src/blackcore/contextnetworkempty.h
View File

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

8
src/blackcore/contextownaircraftempty.h
View File

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

4
src/blackcore/contextsimulatorempty.h
View File

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

76
src/blackcore/webdataservices.h
View File

@@ -77,157 +77,157 @@ namespace BlackCore
// ------------------------ provider functionality start ------------------------------
//! \copydoc IWebDataReaderProvider::connectDataReadSignal
//! \copydoc IWebDataServicesProvider::connectDataReadSignal
//! \ingroup webdatareaderprovider
virtual QList<QMetaObject::Connection> connectDataReadSignal(
QObject *receiver,
std::function<void (BlackMisc::Network::CEntityFlags::Entity, BlackMisc::Network::CEntityFlags::ReadState, int)> 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;