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

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:

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:

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,