flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-03-30 20:15: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

4
src/plugins/simulator/fs9/fs9client.h
View File

@@ -65,10 +65,10 @@ namespace BlackSimPlugin
virtual void timerEvent(QTimerEvent *event) override;
protected:
//! \copydoc CContinuousWorker::initialize
//! \copydoc BlackMisc::CContinuousWorker::initialize
virtual void initialize() override;
//! \copydoc CContinuousWorker::cleanup
//! \copydoc BlackMisc::CContinuousWorker::cleanup
virtual void cleanup() override;
private:

4
src/plugins/simulator/fs9/fs9host.h
View File

@@ -52,10 +52,10 @@ namespace BlackSimPlugin
void statusChanged(BlackSimPlugin::Fs9::CFs9Host::HostStatus);
protected:
//! \copydoc CContinuousWorker::initialize
//! \copydoc BlackMisc::CContinuousWorker::initialize
virtual void initialize() override;
//! \copydoc CContinuousWorker::cleanup
//! \copydoc BlackMisc::CContinuousWorker::cleanup
virtual void cleanup() override;
private:

24
src/plugins/simulator/fs9/simulatorfs9.h
View File

@@ -50,41 +50,41 @@ namespace BlackSimPlugin
//! Destructor
virtual ~CSimulatorFs9() = default;
//! \copydoc ISimulator::connectTo()
//! \copydoc BlackCore::ISimulator::connectTo()
virtual bool connectTo() override;
//! \copydoc ISimulator::disconnectFrom()
//! \copydoc BlackCore::ISimulator::disconnectFrom()
virtual bool disconnectFrom() override;
//! \copydoc ISimulator::physicallyAddRemoteAircraft()
//! \copydoc BlackCore::ISimulator::physicallyAddRemoteAircraft()
virtual bool physicallyAddRemoteAircraft(const BlackMisc::Simulation::CSimulatedAircraft &newRemoteAircraft) override;
//! \copydoc ISimulator::physicallyRemoveRemoteAircraft()
//! \copydoc BlackCore::ISimulator::physicallyRemoveRemoteAircraft()
virtual bool physicallyRemoveRemoteAircraft(const BlackMisc::Aviation::CCallsign &callsign) override;
//! \copydoc BlackCore::ISimulator::physicallyRemoveAllRemoteAircraft
virtual int physicallyRemoveAllRemoteAircraft() override;
//! \copydoc ISimulator::physicallyRenderedAircraft
//! \copydoc BlackCore::ISimulator::physicallyRenderedAircraft
virtual BlackMisc::Aviation::CCallsignSet physicallyRenderedAircraft() const override;
//! \copydoc ISimulator::isPhysicallyRenderedAircraft
//! \copydoc BlackCore::ISimulator::isPhysicallyRenderedAircraft
virtual bool isPhysicallyRenderedAircraft(const BlackMisc::Aviation::CCallsign &callsign) const override;
//! \copydoc ISimulator::updateOwnSimulatorCockpit()
//! \copydoc BlackCore::ISimulator::updateOwnSimulatorCockpit()
virtual bool updateOwnSimulatorCockpit(const BlackMisc::Simulation::CSimulatedAircraft &ownAircraft, const BlackMisc::CIdentifier &originator) override;
//! \copydoc ISimulator::displayStatusMessage()
//! \copydoc BlackCore::ISimulator::displayStatusMessage()
virtual void displayStatusMessage(const BlackMisc::CStatusMessage &message) const override;
//! \copydoc ISimulator::displayTextMessage()
//! \copydoc BlackCore::ISimulator::displayTextMessage()
virtual void displayTextMessage(const BlackMisc::Network::CTextMessage &message) const override;
protected:
//! \copydoc ISimulator::isConnected()
//! \copydoc BlackCore::ISimulator::isConnected()
virtual bool isConnected() const override;
//! \copydoc ISimulator::isSimulating
//! \copydoc BlackCore::ISimulator::isSimulating
virtual bool isSimulating() const override { return isConnected(); }
//! Timer event
@@ -156,7 +156,7 @@ namespace BlackSimPlugin
//! Destructor
virtual ~CSimulatorFs9Factory();
//! \copydoc BlackCore::ISimulatorFactory::create(ownAircraftProvider, remoteAircraftProvider, parent)
//! \copydoc BlackCore::ISimulatorFactory::create
virtual BlackCore::ISimulator *create(
const BlackMisc::Simulation::CSimulatorPluginInfo &info,
BlackMisc::Simulation::IOwnAircraftProvider *ownAircraftProvider,

2
src/plugins/simulator/fsx/simulatorfsxfactory.h
View File

@@ -39,7 +39,7 @@ namespace BlackSimPlugin
BlackMisc::Simulation::IRemoteAircraftProvider *renderedAircraftProvider,
BlackMisc::IPluginStorageProvider *pluginStorageProvider) override;
//! \copydoc BlackCore::ISimulatorFactory::getListener
//! \copydoc BlackCore::ISimulatorFactory::createListener
virtual BlackCore::ISimulatorListener *createListener(const BlackMisc::Simulation::CSimulatorPluginInfo &info) override;
};

36
src/plugins/simulator/xplane/simulatorxplane.h
View File

@@ -36,14 +36,14 @@ namespace BlackSimPlugin
Q_OBJECT
public:
//! \copydoc BlackCore::ISimulatorFactory::create(ownAircraftProvider, remoteAircraftProvider, parent)
//! Constructor
CSimulatorXPlane(const BlackMisc::Simulation::CSimulatorPluginInfo &info,
BlackMisc::Simulation::IOwnAircraftProvider *ownAircraftProvider,
BlackMisc::Simulation::IRemoteAircraftProvider *remoteAircraftProvider,
BlackMisc::IPluginStorageProvider *pluginStorageProvider,
QObject *parent = nullptr);
//! \copydoc ISimulator::isTimeSynchronized
//! \copydoc BlackCore::ISimulator::isTimeSynchronized
virtual bool isTimeSynchronized() const override { return false; } // TODO: Can we query the XP intrinisc feature?
//! \copydoc BlackCore::ISimulator::connectTo
@@ -52,7 +52,7 @@ namespace BlackSimPlugin
//! \copydoc BlackCore::ISimulator::disconnectFrom
virtual bool disconnectFrom() override;
//! \copydoc ISimulator::physicallyAddRemoteAircraft()
//! \copydoc BlackCore::ISimulator::physicallyAddRemoteAircraft()
virtual bool physicallyAddRemoteAircraft(const BlackMisc::Simulation::CSimulatedAircraft &newRemoteAircraft) override;
//! \copydoc BlackCore::ISimulator::physicallyRemoveRemoteAircraft
@@ -61,16 +61,16 @@ namespace BlackSimPlugin
//! \copydoc BlackCore::ISimulator::physicallyRemoveAllRemoteAircraft
virtual int physicallyRemoveAllRemoteAircraft() override;
//! \copydoc ISimulator::physicallyRenderedAircraft
//! \copydoc BlackCore::ISimulator::physicallyRenderedAircraft
virtual BlackMisc::Aviation::CCallsignSet physicallyRenderedAircraft() const override;
//! \copydoc ISimulator::isPhysicallyRenderedAircraft
//! \copydoc BlackCore::ISimulator::isPhysicallyRenderedAircraft
virtual bool isPhysicallyRenderedAircraft(const BlackMisc::Aviation::CCallsign &callsign) const override;
//! \copydoc ISimulator::changeRenderedAircraftModel
//! \copydoc BlackCore::ISimulator::changeRemoteAircraftModel
virtual bool changeRemoteAircraftModel(const BlackMisc::Simulation::CSimulatedAircraft &aircraft, const BlackMisc::CIdentifier &originator) override;
//! \copydoc ISimulator::changeAircraftEnabled
//! \copydoc BlackCore::ISimulator::changeRemoteAircraftEnabled
virtual bool changeRemoteAircraftEnabled(const BlackMisc::Simulation::CSimulatedAircraft &aircraft, const BlackMisc::CIdentifier &originator) override;
//! \copydoc BlackCore::ISimulator::updateOwnSimulatorCockpit
@@ -79,52 +79,52 @@ namespace BlackSimPlugin
//! \copydoc BlackCore::ISimulator::displayStatusMessage
virtual void displayStatusMessage(const BlackMisc::CStatusMessage &message) const override;
//! \copydoc ISimulator::displayTextMessage
//! \copydoc BlackCore::ISimulator::displayTextMessage
virtual void displayTextMessage(const BlackMisc::Network::CTextMessage &message) const override;
//! \copydoc BlackCore::ISimulator::getInstalledModels
virtual BlackMisc::Simulation::CAircraftModelList getInstalledModels() const override;
//! \copydoc ISimulator::reloadInstalledModels
//! \copydoc BlackCore::ISimulator::reloadInstalledModels
virtual void reloadInstalledModels() override;
//! \copydoc BlackCore::ISimulator::getAirportsInRange
virtual BlackMisc::Aviation::CAirportList getAirportsInRange() const;
//! \copydoc ISimulator::setTimeSynchronization
//! \copydoc BlackCore::ISimulator::setTimeSynchronization
virtual bool setTimeSynchronization(bool enable, const BlackMisc::PhysicalQuantities::CTime &offset) override;
//! \copydoc ISimulator::getTimeSynchronizationOffset
//! \copydoc BlackCore::ISimulator::getTimeSynchronizationOffset
virtual BlackMisc::PhysicalQuantities::CTime getTimeSynchronizationOffset() const override { return BlackMisc::PhysicalQuantities::CTime(0, BlackMisc::PhysicalQuantities::CTimeUnit::hrmin()); }
//! \copydoc ISimulator::iconForModel
//! \copydoc BlackCore::ISimulator::iconForModel
virtual BlackMisc::CPixmap iconForModel(const QString &modelString) const override;
//! Creates an appropriate dbus connection from the string describing it
static QDBusConnection connectionFromString(const QString &str);
protected slots:
//! \copydoc CSimulatorCommon::ps_remoteProviderAddAircraftSituation
//! \copydoc BlackCore::CSimulatorCommon::ps_remoteProviderAddAircraftSituation
virtual void ps_remoteProviderAddAircraftSituation(const BlackMisc::Aviation::CAircraftSituation &situation) override;
//! \copydoc CSimulatorCommon::ps_remoteProvideraddAircraftParts
//! \copydoc BlackCore::CSimulatorCommon::ps_remoteProviderAddAircraftParts
virtual void ps_remoteProviderAddAircraftParts(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::Aviation::CAircraftParts &parts) override;
//! \copydoc CSimulatorCommon::ps_remoteProviderRemovedAircraft
//! \copydoc BlackCore::CSimulatorCommon::ps_remoteProviderRemovedAircraft
virtual void ps_remoteProviderRemovedAircraft(const BlackMisc::Aviation::CCallsign &callsign) override;
protected:
//! \copydoc BlackCore::ISimulator::isConnected
virtual bool isConnected() const override;
//! \copydoc ISimulator::isPaused
//! \copydoc BlackCore::ISimulator::isPaused
virtual bool isPaused() const override
{
//! \todo XP: provide correct pause state
return false;
}
//! \copydoc ISimulator::isSimulating
//! \copydoc BlackCore::ISimulator::isSimulating
virtual bool isSimulating() const override { return isConnected(); }
private slots:
@@ -226,7 +226,7 @@ namespace BlackSimPlugin
Q_INTERFACES(BlackCore::ISimulatorFactory)
public:
//! \copydoc BlackCore::ISimulatorFactory::create()
//! \copydoc BlackCore::ISimulatorFactory::create
virtual BlackCore::ISimulator *create(const BlackMisc::Simulation::CSimulatorPluginInfo &info,
BlackMisc::Simulation::IOwnAircraftProvider *ownAircraftProvider,
BlackMisc::Simulation::IRemoteAircraftProvider *renderedAircraftProvider,

2
src/plugins/simulator/xplane/xbusserviceproxy.h
View File

@@ -97,7 +97,7 @@ namespace BlackSimPlugin
void getAircraftModelFilenameAsync(QString *o_modelFilename);
//! @}
//! \copydoc XBus::CService::getAircraftModelLivery
//! \copydoc XBus::CService::getAircraftLivery
//! @{
QString getAircraftModelLivery() const;
void getAircraftModelLiveryAsync(QString *o_modelLivery);

2
src/plugins/simulator/xplane/xbustrafficproxy.h
View File

@@ -80,8 +80,8 @@ namespace BlackSimPlugin
//! \copydoc XBus::CTraffic::setMaxPlanes
void setMaxPlanes(int planes);
//! \copydoc XBus::CTraffic::setDrawDistance
void setDrawDistance(float nauticalMiles);
//! \copydoc XBus::CTraffic::setMaxDrawDistance
//! \copydoc XBus::CTraffic::addPlane
void addPlane(const QString &callsign, const QString &modelName, const QString &aircraftIcao, const QString &airlineIcao, const QString &livery);

4
src/plugins/simulator/xplaneconfig/simulatorxplaneconfig.h
View File

@@ -25,10 +25,10 @@ namespace BlackSimPlugin
*/
struct XBusServer : public BlackMisc::CSettingTrait<QString>
{
//! \copydoc BlackMisc::CSetting::key
//! \copydoc BlackMisc::CSettingTrait::key
static const char *key() { return "xbus/server"; }
//! \copydoc BlackMisc::CSetting::defaultValue
//! \copydoc BlackMisc::CSettingTrait::defaultValue
static QString defaultValue() { return QStringLiteral("session"); }
};