Doxygen, added link to dev wiki and fixed group

This commit is contained in:
Klaus Basan
2017-01-26 20:58:18 +01:00
committed by Mathew Sutcliffe
parent e3d81c6c44
commit 818cdfba59
10 changed files with 20 additions and 42 deletions

View File

@@ -126,7 +126,7 @@ namespace BlackCore
//! \copydoc IContextAudio::isAudioLoopbackEnabled
virtual bool isAudioLoopbackEnabled() const override;
//! \addtogroup commandline
//! \addtogroup swiftdotcommands
//! @{
//! <pre>
//! .mute mute BlackCore::Context::CContextAudio

View File

@@ -132,13 +132,13 @@ namespace BlackCore
bool isPendingConnection() const;
// --------------------- IContextNetwork implementations ---------------------
//! \copydoc IContextNetwork::parseCommandLine
//! \ingroup commandline
//! \addtogroup swiftdotcommands
//! @{
//! <pre>
//! .m .msg message text
//! </pre>
//! @}
//! \copydoc IContextNetwork::parseCommandLine
virtual bool parseCommandLine(const QString &commandLine, const BlackMisc::CIdentifier &originator) override;
//! \publicsection

View File

@@ -137,7 +137,7 @@ namespace BlackCore
//! \copydoc IContextOwnAircraft::enableAutomaticVoiceRoomResolution
virtual void enableAutomaticVoiceRoomResolution(bool enable) override;
//! \addtogroup commandline
//! \addtogroup swiftdotcommands
//! @{
//! <pre>
//! .x .xpdr code set transponder code BlackCore::Context::CContextOwnAircraft

View File

@@ -104,14 +104,14 @@ namespace BlackCore
BlackMisc::Simulation::CMatchingStatistics getCurrentMatchingStatistics(bool missingOnly) const override;
//! @}
//! \copydoc IContextSimulator::parseCommandLine
//! \ingroup commandline
//! \addtogroup swiftdotcommands
//! @{
//! <pre>
//! .plugin forwarded to plugin, see details there
//! .driver .drv forwarded to plugin (same as above)
//! </pre>
//! @}
//! \copydoc IContextSimulator::parseCommandLine
virtual bool parseCommandLine(const QString &commandLine, const BlackMisc::CIdentifier &originator) override;
// ----------------------------- context interface -----------------------------

View File

@@ -147,10 +147,10 @@ namespace BlackCore
//! Driver will be unloaded
virtual void unload() = 0;
//! \addtogroup commandline
//! \addtogroup swiftdotcommands
//! @{
//! <pre>
//! .drv unload unload driver CSimulatorCommon
//! .drv unload unload driver BlackCore::CSimulatorCommon
//! .drv fsuipc on|off enable/disable FSUIPC (if applicable) BlackSimPlugin::FsCommon::CSimulatorFsCommon
//! </pre>
//! @}

View File

@@ -84,17 +84,17 @@ namespace BlackCore
virtual void unload() override;
virtual int physicallyRemoveMultipleRemoteAircraft(const BlackMisc::Aviation::CCallsignSet &callsigns) override;
//! \copydoc ISimulator::parseCommandLine
//! \ingroup commandline
//! \addtogroup swiftdotcommands
//! @{
//! <pre>
//! .plugin unload unload plugin
//! .plugin logint callsign log interpolator for callsign
//! .plugin logint off no log information for interpolator
//! .plugin logint write write interpolator log to file
//! .plugin logint clear clear current log
//! .plugin unload unload plugin BlackCore::CSimulatorCommon
//! .plugin logint callsign log interpolator for callsign BlackCore::CSimulatorCommon
//! .plugin logint off no log information for interpolator BlackCore::CSimulatorCommon
//! .plugin logint write write interpolator log to file BlackCore::CSimulatorCommon
//! .plugin logint clear clear current log BlackCore::CSimulatorCommon
//! </pre>
//! @}
//! \copydoc ISimulator::parseCommandLine
virtual bool parseCommandLine(const QString &commandLine, const BlackMisc::CIdentifier &originator) override;
// --------- ISimulator implementations ------------
@@ -186,7 +186,7 @@ namespace BlackCore
qint64 m_statsUpdateAircraftTimeAvgMs = 0; //!< statistics update time
int m_statsUpdateAircraftCountMs = 0; //!< statistics update time
BlackMisc::Simulation::CSimulatorInternals m_simulatorInternals; //!< setup object
BlackMisc::Simulation::CInterpolationAndRenderingSetup m_interpolationRenderingSetup; //!< debug messages, rendering etc.
BlackMisc::Simulation::CInterpolationAndRenderingSetup m_interpolationRenderingSetup; //!< logging, rendering etc.
// some optional functionality which can be used by the sims as needed
BlackMisc::Simulation::CSimulatedAircraftList m_aircraftToAddAgainWhenRemoved; //!< add this model again when removed, normally used to change model