diff --git a/docs/src/wiki/developersguide.dox b/docs/src/wiki/developersguide.dox index e5d15f884..890ab3aa7 100644 --- a/docs/src/wiki/developersguide.dox +++ b/docs/src/wiki/developersguide.dox @@ -3,8 +3,6 @@ \page developersguide Developers Guide \ingroup developersguide -Introduction - -\ref inputandhotkeys +see developer documentation here */ diff --git a/docs/src/wiki/inputandhotkeys.dox b/docs/src/wiki/inputandhotkeys.dox deleted file mode 100644 index 13bf55e69..000000000 --- a/docs/src/wiki/inputandhotkeys.dox +++ /dev/null @@ -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 - -*/ diff --git a/src/blackcore/context/contextaudioimpl.h b/src/blackcore/context/contextaudioimpl.h index d8e363ed5..dc9e9c14b 100644 --- a/src/blackcore/context/contextaudioimpl.h +++ b/src/blackcore/context/contextaudioimpl.h @@ -126,7 +126,7 @@ namespace BlackCore //! \copydoc IContextAudio::isAudioLoopbackEnabled virtual bool isAudioLoopbackEnabled() const override; - //! \addtogroup commandline + //! \addtogroup swiftdotcommands //! @{ //!
             //! .mute                          mute             BlackCore::Context::CContextAudio
diff --git a/src/blackcore/context/contextnetworkimpl.h b/src/blackcore/context/contextnetworkimpl.h
index 1a6f8af2d..8bc6d5e60 100644
--- a/src/blackcore/context/contextnetworkimpl.h
+++ b/src/blackcore/context/contextnetworkimpl.h
@@ -132,13 +132,13 @@ namespace BlackCore
             bool isPendingConnection() const;
 
             // --------------------- IContextNetwork implementations ---------------------
-            //! \copydoc IContextNetwork::parseCommandLine
-            //! \ingroup commandline
+            //! \addtogroup swiftdotcommands
             //! @{
             //! 
             //! .m .msg   message text
             //! 
//! @} + //! \copydoc IContextNetwork::parseCommandLine virtual bool parseCommandLine(const QString &commandLine, const BlackMisc::CIdentifier &originator) override; //! \publicsection diff --git a/src/blackcore/context/contextownaircraftimpl.h b/src/blackcore/context/contextownaircraftimpl.h index 36609ea86..16a8e1a39 100644 --- a/src/blackcore/context/contextownaircraftimpl.h +++ b/src/blackcore/context/contextownaircraftimpl.h @@ -137,7 +137,7 @@ namespace BlackCore //! \copydoc IContextOwnAircraft::enableAutomaticVoiceRoomResolution virtual void enableAutomaticVoiceRoomResolution(bool enable) override; - //! \addtogroup commandline + //! \addtogroup swiftdotcommands //! @{ //!
             //! .x    .xpdr  code       set transponder code    BlackCore::Context::CContextOwnAircraft
diff --git a/src/blackcore/context/contextsimulatorimpl.h b/src/blackcore/context/contextsimulatorimpl.h
index e762d64a0..dc0b75560 100644
--- a/src/blackcore/context/contextsimulatorimpl.h
+++ b/src/blackcore/context/contextsimulatorimpl.h
@@ -104,14 +104,14 @@ namespace BlackCore
             BlackMisc::Simulation::CMatchingStatistics getCurrentMatchingStatistics(bool missingOnly) const override;
             //! @}
 
-            //! \copydoc IContextSimulator::parseCommandLine
-            //! \ingroup commandline
+            //! \addtogroup swiftdotcommands
             //! @{
             //! 
             //! .plugin        forwarded to plugin, see details there
             //! .driver .drv   forwarded to plugin (same as above)
             //! 
//! @} + //! \copydoc IContextSimulator::parseCommandLine virtual bool parseCommandLine(const QString &commandLine, const BlackMisc::CIdentifier &originator) override; // ----------------------------- context interface ----------------------------- diff --git a/src/blackcore/simulator.h b/src/blackcore/simulator.h index 751c9e235..047de1e53 100644 --- a/src/blackcore/simulator.h +++ b/src/blackcore/simulator.h @@ -147,10 +147,10 @@ namespace BlackCore //! Driver will be unloaded virtual void unload() = 0; - //! \addtogroup commandline + //! \addtogroup swiftdotcommands //! @{ //!
-        //! .drv    unload                  unload driver                           CSimulatorCommon
+        //! .drv    unload                  unload driver                           BlackCore::CSimulatorCommon
         //! .drv    fsuipc      on|off      enable/disable FSUIPC (if applicable)   BlackSimPlugin::FsCommon::CSimulatorFsCommon
         //! 
//! @} diff --git a/src/blackcore/simulatorcommon.h b/src/blackcore/simulatorcommon.h index fc651a167..aa3cc7e17 100644 --- a/src/blackcore/simulatorcommon.h +++ b/src/blackcore/simulatorcommon.h @@ -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 //! @{ //!
-        //! .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
         //! 
//! @} + //! \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 diff --git a/src/blackmisc/simplecommandparser.h b/src/blackmisc/simplecommandparser.h index be47c99dd..0c2ded4a8 100644 --- a/src/blackmisc/simplecommandparser.h +++ b/src/blackmisc/simplecommandparser.h @@ -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 diff --git a/src/plugins/simulator/fscommon/simulatorfscommon.h b/src/plugins/simulator/fscommon/simulatorfscommon.h index 291e72ce7..5e2a1aa8a 100644 --- a/src/plugins/simulator/fscommon/simulatorfscommon.h +++ b/src/plugins/simulator/fscommon/simulatorfscommon.h @@ -62,8 +62,7 @@ namespace BlackSimPlugin //! Init the internal objects virtual void initSimulatorInternals(); - //! \copydoc BlackCore::CSimulatorCommon::parseDetails - //! \ingroup commandline + //! \addtogroup swiftdotcommands //! @{ //!
             //! .plugin fsuipc  on|off      FSUIPC on/off