From f95df7455b7e18ea401b3fc34037656c5d851f8a Mon Sep 17 00:00:00 2001 From: Mat Sutcliffe Date: Sat, 29 Jun 2019 15:34:00 +0100 Subject: [PATCH] Improved doxygen comments for CSimulatorInternals. --- src/blackcore/simulator.h | 6 +++--- src/blackmisc/simulation/simulatorinternals.h | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/blackcore/simulator.h b/src/blackcore/simulator.h index 9b3b01ea5..d2f5c88d7 100644 --- a/src/blackcore/simulator.h +++ b/src/blackcore/simulator.h @@ -96,7 +96,7 @@ namespace BlackCore //! Is time synchronization on? virtual bool isTimeSynchronized() const = 0; - //! Get the setup (simulator environment) + //! Get the simulator current internal state virtual const BlackMisc::Simulation::CSimulatorInternals &getSimulatorInternals() const { return m_simulatorInternals; } //! Connect to simulator @@ -391,7 +391,7 @@ namespace BlackCore virtual void onSwiftDbAirportsRead(); //! @} - //! Init the internals info + //! Init the internals info from the simulator virtual void initSimulatorInternals(); //! Parsed in derived classes @@ -562,7 +562,7 @@ namespace BlackCore qint64 m_statsLastUpdateAircraftRequestedMs = 0; //!< when was the last aircraft update requested qint64 m_statsUpdateAircraftRequestedDeltaMs = 0; //!< delta time between 2 aircraft updates - BlackMisc::Simulation::CSimulatorInternals m_simulatorInternals; //!< setup object + BlackMisc::Simulation::CSimulatorInternals m_simulatorInternals; //!< setup read from the sim BlackMisc::Simulation::CInterpolationLogger m_interpolationLogger; //!< log.interpolation BlackMisc::Simulation::CAutoPublishData m_autoPublishing; //!< for the DB BlackMisc::Aviation::CAircraftSituationPerCallsign m_lastSentSituations; //!< last situations sent to simulator diff --git a/src/blackmisc/simulation/simulatorinternals.h b/src/blackmisc/simulation/simulatorinternals.h index 0caa0790b..6aabad8e5 100644 --- a/src/blackmisc/simulation/simulatorinternals.h +++ b/src/blackmisc/simulation/simulatorinternals.h @@ -30,7 +30,7 @@ namespace BlackMisc namespace Simulation { //! Simulator internals for flight simulators. - //! Those are set up at runtime and represent information about the simulator (like a small registry) + //! Those are obtained from a running simulator and represent information about the simulator (like a small registry) class BLACKMISC_EXPORT CSimulatorInternals : public CValueObject { public: