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

Fix doxygen copydoc documentation

Browse Source 
The following issues were fixed
* Fixed wrong/missing namespaces
* Fixed obvious typos in documentation
* Documentation not in sync with source code

refs #544
This commit is contained in:
Roland Winklmeier
2016-02-07 18:40:11 +01:00
parent dfb6798d31
commit 794bf0cd74
154 changed files with 399 additions and 399 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/blackcore/contextapplicationproxy.h
View File

@@ -64,7 +64,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

14
src/blackcore/contextaudioimpl.h
View File

@@ -82,28 +82,28 @@ namespace BlackCore
//! \copydoc IContextAudio::setCurrentAudioDevice()
virtual void setCurrentAudioDevice(const BlackMisc::Audio::CAudioDeviceInfo &audioDevice) override;
//! \copydoc IContext::setVoiceOutputVolume
//! \copydoc IContextAudio::setVoiceOutputVolume
virtual void setVoiceOutputVolume(int volume) override;
//! \copydoc IContext::getVoiceOutputVolume
//! \copydoc IContextAudio::getVoiceOutputVolume
virtual int getVoiceOutputVolume() const override;
//! \copydoc ICOntext::setMute
//! \copydoc IContextAudio::setMute
virtual void setMute(bool muted) override;
//! \copydoc IContextAudio::isMuted()
virtual bool isMuted() const override;
//! \copydoc IContextAudio::playSelcalTone()
//! \copydoc IContextAudio::playSelcalTone
virtual void playSelcalTone(const BlackMisc::Aviation::CSelcal &selcal) const override;
//! \copydoc IContextAudio::playNotification()
//! \copydoc IContextAudio::playNotification
virtual void playNotification(BlackMisc::Audio::CNotificationSounds::Notification notification, bool considerSettings) const override;
//! \copydoc IContextAudio::enableAudioLoopback()
//! \copydoc IContextAudio::enableAudioLoopback
virtual void enableAudioLoopback(bool enable = true) override;
//! \copydoc ICOntextAudio::isAudioLoopbackEnabled
//! \copydoc IContextAudio::isAudioLoopbackEnabled
virtual bool isAudioLoopbackEnabled() const override;
//! \addtogroup commandline

4
src/blackcore/contextaudioproxy.h
View File

@@ -84,10 +84,10 @@ namespace BlackCore
//! \copydoc IContextAudio::setCurrentAudioDevice()
virtual void setCurrentAudioDevice(const BlackMisc::Audio::CAudioDeviceInfo &audioDevice) override;
//!\copydoc IContext::setVoiceOutputVolume
//!\copydoc IContextAudio::setVoiceOutputVolume
virtual void setVoiceOutputVolume(int volume) override;
//! \copydoc IContext::getVoiceOutputVolume
//! \copydoc IContextAudio::getVoiceOutputVolume
virtual int getVoiceOutputVolume() const override;
//! \copydoc IContextAudio::setMute

12
src/blackcore/contextnetworkimpl.h
View File

@@ -70,7 +70,7 @@ namespace BlackCore
//! \ingroup remoteaircraftprovider
virtual BlackMisc::Aviation::CCallsignSet remoteAircraftSupportingParts() const override;
//! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::connectSignals
//! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::connectRemoteAircraftProviderSignals
//! \ingroup remoteaircraftprovider
virtual QList<QMetaObject::Connection> connectRemoteAircraftProviderSignals(
QObject *receiver,
@@ -117,7 +117,7 @@ namespace BlackCore
//! \copydoc IContextNetwork::getAtcStationsBooked()
virtual BlackMisc::Aviation::CAtcStationList getAtcStationsBooked() const override;
//! \copydoc IContextNetwork::getAircraftInRange
//! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::getAircraftInRange
//! \ingroup remoteaircraftprovider
virtual BlackMisc::Simulation::CSimulatedAircraftList getAircraftInRange() const override;
@@ -125,11 +125,11 @@ namespace BlackCore
//! \ingroup remoteaircraftprovider
virtual int getAircraftInRangeCount() const override;
//! \copydoc IContextNetwork::getAircraftInRangeForCallsign
//! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::getAircraftInRangeForCallsign
//! \ingroup remoteaircraftprovider
virtual BlackMisc::Simulation::CSimulatedAircraft getAircraftInRangeForCallsign(const BlackMisc::Aviation::CCallsign &callsign) const override;
//! \copydoc IContextNetwork::getAircraftinRangeModelForCallsign
//! \copydoc BlackMisc::Simulation::IRemoteAircraftProvider::getAircraftInRangeModelForCallsign
//! \ingroup remoteaircraftprovider
virtual BlackMisc::Simulation::CAircraftModel getAircraftInRangeModelForCallsign(const BlackMisc::Aviation::CCallsign &callsign) const override;
@@ -186,13 +186,13 @@ namespace BlackCore
//! \copydoc IContextNetwork::getUsersForCallsigns
virtual BlackMisc::Network::CUserList getUsersForCallsigns(const BlackMisc::Aviation::CCallsignSet &callsigns) const override;
//! \copydoc IContextNetwork::getUsersForCallsign
//! \copydoc IContextNetwork::getUserForCallsign
virtual BlackMisc::Network::CUser getUserForCallsign(const BlackMisc::Aviation::CCallsign &callsign) const override;
//! \copydoc IContextNetwork::getOtherClients
virtual BlackMisc::Network::CClientList getOtherClients() const override;
//! \copydoc IContextNetwork::getOtherClientForCallsigns
//! \copydoc IContextNetwork::getOtherClientsForCallsigns
virtual BlackMisc::Network::CClientList getOtherClientsForCallsigns(const BlackMisc::Aviation::CCallsignSet &callsigns) const override;
//! \copydoc IContextNetwork::getVatsimFsdServers

2
src/blackcore/contextnetworkproxy.h
View File

@@ -126,7 +126,7 @@ namespace BlackCore
//! \copydoc IContextNetwork::getVatsimFsdServers
virtual BlackMisc::Network::CServerList getVatsimFsdServers() const override;
//! \copydoc IContextNetwork::getOtherClientForCallsigns
//! \copydoc IContextNetwork::getOtherClientsForCallsigns
virtual BlackMisc::Network::CClientList getOtherClientsForCallsigns(const BlackMisc::Aviation::CCallsignSet &callsigns) const override;
//! \copydoc IContextNetwork::requestDataUpdates

20
src/blackcore/contextownaircraftimpl.h
View File

@@ -41,31 +41,31 @@ namespace BlackCore
//! Destructor
virtual ~CContextOwnAircraft();
//! \copydoc IOwnAircraftProvider::getOwnAircraftPosition
//! \copydoc BlackMisc::Simulation::IOwnAircraftProvider::getOwnAircraftPosition
//! \ingroup ownaircraftprovider
virtual BlackMisc::Geo::CCoordinateGeodetic getOwnAircraftPosition() const override;
//! \copydoc IOwnAircraftProvider::getOwnAircraftParts
//! \copydoc BlackMisc::Simulation::IOwnAircraftProvider::getOwnAircraftParts
//! \ingroup ownaircraftprovider
virtual BlackMisc::Aviation::CAircraftParts getOwnAircraftParts() const;
//! \copydoc IOwnAircraftProvider::getOwnAircraftModel
//! \copydoc BlackMisc::Simulation::IOwnAircraftProvider::getOwnAircraftModel
//! \ingroup ownaircraftprovider
virtual BlackMisc::Simulation::CAircraftModel getOwnAircraftModel() const;
//! \copydoc IOwnAircraftProvider::getDistanceToOwnAircraft
//! \copydoc BlackMisc::Simulation::IOwnAircraftProvider::getDistanceToOwnAircraft
//! \ingroup ownaircraftprovider
virtual BlackMisc::PhysicalQuantities::CLength getDistanceToOwnAircraft(const BlackMisc::Geo::ICoordinateGeodetic &position) const override;
//! \copydoc IOwnAircraftProvider::updateOwnModel
//! \copydoc BlackMisc::Simulation::IOwnAircraftProvider::updateOwnModel
//! \ingroup ownaircraftprovider
virtual bool updateOwnModel(const BlackMisc::Simulation::CAircraftModel &model) override;
//! \copydoc IOwnAircraftProvider::updateOwnSituation
//! \copydoc BlackMisc::Simulation::IOwnAircraftProvider::updateOwnSituation
//! \ingroup ownaircraftprovider
virtual bool updateOwnSituation(const BlackMisc::Aviation::CAircraftSituation &situation) override;
//! \copydoc IOwnAircraftProvider::updateOwnParts
//! \copydoc BlackMisc::Simulation::IOwnAircraftProvider::updateOwnParts
//! \ingroup ownaircraftprovider
virtual bool updateOwnParts(const BlackMisc::Aviation::CAircraftParts &parts) override;
@@ -82,7 +82,7 @@ namespace BlackCore
//! \ingroup ownaircraftprovider
virtual bool updateOwnIcaoCodes(const BlackMisc::Aviation::CAircraftIcaoCode &aircraftIcaoCode, const BlackMisc::Aviation::CAirlineIcaoCode &airlineIcaoCode) override;
//! \copydoc IContextOwnAircraft::updatePosition
//! \copydoc IContextOwnAircraft::updateOwnPosition
virtual bool updateOwnPosition(const BlackMisc::Geo::CCoordinateGeodetic &position, const BlackMisc::Aviation::CAltitude &altitude) override;
//! \copydoc IContextOwnAircraft::updateCockpit
@@ -91,10 +91,10 @@ namespace BlackCore
//! \copydoc IContextOwnAircraft::updateSelcal
virtual bool updateSelcal(const BlackMisc::Aviation::CSelcal &selcal, const BlackMisc::CIdentifier &originator) override;
//! \copydoc IContextOwnAircraft::updateComFrequency
//! \copydoc IContextOwnAircraft::updateActiveComFrequency
virtual bool updateActiveComFrequency(const BlackMisc::PhysicalQuantities::CFrequency &frequency, BlackMisc::Aviation::CComSystem::ComUnit comUnit, const BlackMisc::CIdentifier &originator) override;
//! \copydoc IContextOwnAircraft::updatePilot
//! \copydoc IContextOwnAircraft::updateOwnAircraftPilot
virtual bool updateOwnAircraftPilot(const BlackMisc::Network::CUser &pilot) override;
//! \copydoc IContextOwnAircraft::setAudioOutputVolume

8
src/blackcore/contextownaircraftproxy.h
View File

@@ -35,16 +35,16 @@ namespace BlackCore
//! \copydoc IContextOwnAircraft::getOwnAircraft()
virtual BlackMisc::Simulation::CSimulatedAircraft getOwnAircraft() const override;
//! \copydoc IContextOwnAircraft::updatePosition
//! \copydoc IContextOwnAircraft::updateOwnPosition
virtual bool updateOwnPosition(const BlackMisc::Geo::CCoordinateGeodetic &position, const BlackMisc::Aviation::CAltitude &altitude) override;
//! \copydoc IContextOwnAircraft::updateCockpit
virtual bool updateCockpit(const BlackMisc::Aviation::CComSystem &com1, const BlackMisc::Aviation::CComSystem &com2, const BlackMisc::Aviation::CTransponder &transponder, const BlackMisc::CIdentifier &originator) override;
//! \copydoc IContextOwnAircraft::updateComFrequency
//! \copydoc IContextOwnAircraft::updateActiveComFrequency
virtual bool updateActiveComFrequency(const BlackMisc::PhysicalQuantities::CFrequency &frequency, BlackMisc::Aviation::CComSystem::ComUnit comUnit, const BlackMisc::CIdentifier &originator) override;
//! \copydoc IContextOwnAircraft::updatePilot
//! \copydoc IContextOwnAircraft::updateOwnAircraftPilot
virtual bool updateOwnAircraftPilot(const BlackMisc::Network::CUser &pilot) override;
//! \copydoc IContextOwnAircraft::updateSelcal
@@ -56,7 +56,7 @@ namespace BlackCore
//! \copydoc IContextOwnAircraft::updateOwnIcaoCodes
virtual bool updateOwnIcaoCodes(const BlackMisc::Aviation::CAircraftIcaoCode &aircraftIcaoCode, const BlackMisc::Aviation::CAirlineIcaoCode &airlineIcaoCode) override;
//! \copydoc IContextOwnAircraft::setAudioOutputVolumes
//! \copydoc IContextOwnAircraft::setAudioOutputVolume
virtual void setAudioOutputVolume(int outputVolume) override;
//! \copydoc IContextOwnAircraft::setAudioVoiceRoomOverrideUrls

2
src/blackcore/contextsimulatorimpl.h
View File

@@ -117,7 +117,7 @@ namespace BlackCore
//! \copydoc IContextSimulator::iconForModel
virtual BlackMisc::CPixmap iconForModel(const QString &modelString) const override;
//! \copydoc ISimulator::enableDebuggingMessages
//! \copydoc ISimulator::enableDebugMessages
virtual void enableDebugMessages(bool driver, bool interpolator) override;
//! \copydoc IContextSimulator::highlightAircraft

4
src/blackcore/contextsimulatorproxy.h
View File

@@ -86,7 +86,7 @@ namespace BlackCore
//! \copydoc IContextSimulator::getMaxRenderedAircraft
virtual int getMaxRenderedAircraft() const override;
//! \copydoc IContextSimulator::setMaxRenderedRemoteAircraft
//! \copydoc IContextSimulator::setMaxRenderedAircraft
virtual void setMaxRenderedAircraft(int number) override;
//! \copydoc IContextSimulator::setMaxRenderedDistance
@@ -119,7 +119,7 @@ namespace BlackCore
//! \copydoc IContextSimulator::highlightAircraft
virtual void highlightAircraft(const BlackMisc::Simulation::CSimulatedAircraft &aircraftToHighlight, bool enableHighlight, const BlackMisc::PhysicalQuantities::CTime &displayTime) override;
//! \copydoc ISimulator::enableDebuggingMessages
//! \copydoc ISimulator::enableDebugMessages
virtual void enableDebugMessages(bool driver, bool interpolator) override;
};
} // namespace BlackCore

6
src/blackcore/data/globalsetup.h
View File

@@ -115,16 +115,16 @@ namespace BlackCore
//! Productive settings?
void setDevelopment(bool development) { m_development = development; }
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
//! To string
QString convertToQString(const QString &separator, bool i18n = false) const;
//! \copydoc CValueObject::propertyByIndex
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
BlackMisc::CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
//! \copydoc CValueObject::setPropertyByIndex
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const BlackMisc::CVariant &variant, const BlackMisc::CPropertyIndex &index);
//! Schema version

6
src/blackcore/data/updateinfo.h
View File

@@ -78,16 +78,16 @@ namespace BlackCore
//! Productive settings?
void setDevelopment(bool development) { m_development = development; }
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
//! To string
QString convertToQString(const QString &separator, bool i18n = false) const;
//! \copydoc CValueObject::propertyByIndex
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
BlackMisc::CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
//! \copydoc CValueObject::setPropertyByIndex
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const BlackMisc::CVariant &variant, const BlackMisc::CPropertyIndex &index);
private:

2
src/blackcore/interpolatorlinear.h
View File

@@ -30,7 +30,7 @@ namespace BlackCore
IInterpolator(provider, "CInterpolatorLinear", parent)
{}
//! \copydoc IInterpolator::getCurrentInterpolatedSituation
//! \copydoc IInterpolator::getInterpolatedSituation
virtual BlackMisc::Aviation::CAircraftSituation getInterpolatedSituation(const BlackMisc::Aviation::CCallsign &callsign, qint64 currentTimeSinceEpoc, bool vtolAiracraft, InterpolationStatus &status) const override;
//! Log category

4
src/blackcore/setupreader.h
View File

@@ -41,10 +41,10 @@ namespace BlackCore
void versionSynchronized(bool success);
protected slots:
//! \copydoc CThreadedReader::initialize
//! \copydoc BlackMisc::CThreadedReader::initialize
virtual void initialize() override;
//! \copydoc CThreadedReader::cleanup
//! \copydoc BlackMisc::CThreadedReader::cleanup
virtual void cleanup() override;
private slots:

2
src/blackcore/simulator.h
View File

@@ -276,7 +276,7 @@ namespace BlackCore
//! Create a new instance of a driver
//! \param info metadata about simulator
//! \param ownAircraftProvider in memory access to own aircraft data
//! \param renderedAircraftProvider in memory access to rendered aircraft data such as situation history and aircraft itself
//! \param remoteAircraftProvider in memory access to rendered aircraft data such as situation history and aircraft itself
//! \param pluginStorageProvider in memory access to persistent plugin data store
//! \return driver instance
virtual ISimulator *create(

20
src/blackcore/simulatorcommon.h
View File

@@ -66,34 +66,34 @@ namespace BlackCore
//! \copydoc ISimulator::isMaxDistanceRestricted
virtual bool isMaxDistanceRestricted() const override;
//! \copydoc ISimulator::enableDebuggingMessages
//! \copydoc ISimulator::enableDebugMessages
virtual void enableDebugMessages(bool driverMessages, bool interpolatorMessages) override;
//! \copydoc ISimulator::getInstalledModelsCount
virtual int getInstalledModelsCount() const override;
//! \copydoc IContextSimulator::highlightAircraft
//! \copydoc ISimulator::highlightAircraft
virtual void highlightAircraft(const BlackMisc::Simulation::CSimulatedAircraft &aircraftToHighlight, bool enableHighlight, const BlackMisc::PhysicalQuantities::CTime &displayTime) override;
//! \copydoc IContextSimulator::isRenderingEnabled
//! \copydoc ISimulator::isRenderingEnabled
virtual bool isRenderingEnabled() const override;
//! \copydoc IContextSimulator::isRenderingRestricted
//! \copydoc ISimulator::isRenderingRestricted
virtual bool isRenderingRestricted() const override;
//! \copydoc IContextSimulator::getSimulatorPluginInfo
//! \copydoc ISimulator::getSimulatorPluginInfo
virtual const BlackMisc::Simulation::CSimulatorPluginInfo &getSimulatorPluginInfo() const override;
//! \copydoc IContextSimulator::getSimulatorSetup
//! \copydoc ISimulator::getSimulatorSetup
virtual const BlackMisc::Simulation::CSimulatorSetup &getSimulatorSetup() const override;
//! \copydoc IContextSimulator::unload
//! \copydoc ISimulator::unload
virtual void unload();
//! \copydoc IContextSimulator::deleteAllRenderingRestrictions
virtual void deleteAllRenderingRestrictions() override;
//! \copydoc IContextSimulator::physicallyRemoveRemoteAircraft
//! \copydoc ISimulator::physicallyRemoveMultipleRemoteAircraft
virtual int physicallyRemoveMultipleRemoteAircraft(const BlackMisc::Aviation::CCallsignSet &callsigns) override;
protected slots:
@@ -120,10 +120,10 @@ namespace BlackCore
BlackMisc::IPluginStorageProvider *pluginStorageProvider,
QObject *parent);
//! \copydoc IContextSimulator::logicallyAddRemoteAircraft
//! \copydoc ISimulator::logicallyAddRemoteAircraft
virtual bool logicallyAddRemoteAircraft(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft) override;
//! \copydoc IContextSimulator::logicallyRemoveRemoteAircraft
//! \copydoc ISimulator::logicallyRemoveRemoteAircraft
virtual bool logicallyRemoveRemoteAircraft(const BlackMisc::Aviation::CCallsign &callsign) override;
//! Blink the highlighted aircraft

2
src/blackcore/vatsimbookingreader.h
View File

@@ -44,7 +44,7 @@ namespace BlackCore
void dataRead(BlackMisc::Network::CEntityFlags::Entity entity, BlackMisc::Network::CEntityFlags::ReadState state, int number);
protected:
//! \copydoc CThreadedReader::cleanup
//! \copydoc BlackMisc::CThreadedReader::cleanup
virtual void cleanup() override;
private slots:

2
src/blackcore/vatsimdatafilereader.h
View File

@@ -113,7 +113,7 @@ namespace BlackCore
void dataRead(BlackMisc::Network::CEntityFlags::Entity entity, BlackMisc::Network::CEntityFlags::ReadState state, int number);
protected:
//! \copydoc CThreadedReader::cleanup
//! \copydoc BlackMisc::CThreadedReader::cleanup
virtual void cleanup() override;
private slots:

2
src/blackcore/vatsimmetarreader.h
View File

@@ -57,7 +57,7 @@ namespace BlackCore
void dataRead(BlackMisc::Network::CEntityFlags::Entity entity, BlackMisc::Network::CEntityFlags::ReadState state, int number);
protected:
//! \copydoc CThreadedReader::cleanup
//! \copydoc BlackMisc::CThreadedReader::cleanup
virtual void cleanup() override;
private slots:

2
src/blackcore/voicechannelvatlib.h
View File

@@ -47,7 +47,7 @@ namespace BlackCore
//! \copydoc IVoiceChannel::getVoiceRoomCallsigns
virtual BlackMisc::Aviation::CCallsignSet getVoiceRoomCallsigns() const override;
//! \copydoc IVoiceChannel::setMyAircraftCallsign
//! \copydoc IVoiceChannel::setOwnAircraftCallsign
virtual void setOwnAircraftCallsign(const BlackMisc::Aviation::CCallsign &callsign) override;
//! \copydoc IVoiceChannel::getVoiceRoom