flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-03-22 06:45:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

Doxygen, added link to dev wiki and fixed group

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/src/wiki/developersguide.dox
View File

@@ -3,8 +3,6 @@
\page developersguide Developers Guide
\ingroup developersguide
Introduction
\ref inputandhotkeys
see developer documentation <a href="https://dev.swift-project.org/w/dev/"> here</a>
*/

21
docs/src/wiki/inputandhotkeys.dox
View File

@@ -1,21 +0,0 @@
/*!
\page inputandhotkeys Input Device and Hotkey Management
\ingroup developersguide
\section general General
TBW
\subsection inputdevices Input Devices (Keyboard and Joysticks)
\image html inputkeyboardjoystick.png
\ref BlackCore::CInputManager is receiving all device press and release events. Each time an event is received, the overall
status is combined into a \ref BlackMisc::Input::CHotkeyCombination object.
\subsection hotkey_settings Hotkey Settings
TBW
*/

2
src/blackcore/context/contextaudioimpl.h
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

4
src/blackcore/context/contextnetworkimpl.h
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

2
src/blackcore/context/contextownaircraftimpl.h
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

4
src/blackcore/context/contextsimulatorimpl.h
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 -----------------------------

4
src/blackcore/simulator.h
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>
//! @}

16
src/blackcore/simulatorcommon.h
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

2
src/blackmisc/simplecommandparser.h
View File

@@ -18,6 +18,8 @@
namespace BlackMisc
{
//! \defgroup swiftdotcommands dot commands
//! Utility methods for simple line parsing used with the command line
//! \remarks case insensitive parsing, commands start with . as ".msg"
class BLACKMISC_EXPORT CSimpleCommandParser

3
src/plugins/simulator/fscommon/simulatorfscommon.h
View File

@@ -62,8 +62,7 @@ namespace BlackSimPlugin
//! Init the internal objects
virtual void initSimulatorInternals();
//! \copydoc BlackCore::CSimulatorCommon::parseDetails
//! \ingroup commandline
//! \addtogroup swiftdotcommands
//! @{
//! <pre>
//! .plugin fsuipc on|off FSUIPC on/off