From 2dbc347bd7c33c74de1b5ba812cf9a313d659ca8 Mon Sep 17 00:00:00 2001
From: Mat Sutcliffe <oktal3700@gmail.com>
Date: Thu, 3 Oct 2019 19:09:26 +0100
Subject: [PATCH] [FSD] Doxygen

---
 src/blackcore/context/contextaudio.h     | 20 ++++++++++++--------
 src/blackmisc/network/connectionstatus.h |  6 +++---
 src/blackmisc/network/loginmode.h        |  6 ++++--
 3 files changed, 19 insertions(+), 13 deletions(-)

diff --git a/src/blackcore/context/contextaudio.h b/src/blackcore/context/contextaudio.h
index 81fdff2dd..4eff18a70 100644
--- a/src/blackcore/context/contextaudio.h
+++ b/src/blackcore/context/contextaudio.h
@@ -91,7 +91,8 @@ namespace BlackCore
             //! Reference to voice client
             BlackCore::Afv::Clients::CAfvClient &voiceClient() { return m_voiceClient; }
 
-            //! Audio devices @{
+            //! Audio devices
+            //! @{
             BlackMisc::Audio::CAudioDeviceInfoList getAudioDevices() const;
             BlackMisc::Audio::CAudioDeviceInfoList getAudioInputDevices()  const { return this->getAudioDevices().getInputDevices(); }
             BlackMisc::Audio::CAudioDeviceInfoList getAudioOutputDevices() const { return this->getAudioDevices().getOutputDevices(); }
@@ -105,7 +106,8 @@ namespace BlackCore
             //! \param audioDevice can be input or audio device
             void setCurrentAudioDevices(const BlackMisc::Audio::CAudioDeviceInfo &audioDevice, const BlackMisc::Audio::CAudioDeviceInfo &outputDevice);
 
-            //! Volume @{
+            //! Volume
+            //! @{
             void setVoiceOutputVolume(int volume);
             int  getVoiceOutputVolume() const;
             void setMute(bool muted);
@@ -118,12 +120,14 @@ namespace BlackCore
             //! Notification sounds
             void playNotification(BlackMisc::Audio::CNotificationSounds::NotificationFlag notification, bool considerSettings, int volume = -1);
 
-            //! Loopback @{
+            //! Loopback
+            //! @{
             void enableAudioLoopback(bool enable = true);
             bool isAudioLoopbackEnabled() const;
             //! @}
 
-            //! Voice setup @{
+            //! Voice setup
+            //! @{
             BlackMisc::Audio::CVoiceSetup getVoiceSetup() const;
             void setVoiceSetup(const BlackMisc::Audio::CVoiceSetup &setup);
             //! @}
@@ -161,20 +165,19 @@ namespace BlackCore
             // ------------- DBus ---------------
 
             //! \addtogroup swiftdotcommands
-            //! @{
             //! <pre>
             //! .mute                          mute             BlackCore::Context::CContextAudio
             //! .unmute                        unmute           BlackCore::Context::CContextAudio
             //! .vol .volume   volume 0..100   set volume       BlackCore::Context::CContextAudio
             //! </pre>
-            //! @}
             //! \copydoc IContextAudio::parseCommandLine
             virtual bool parseCommandLine(const QString &commandLine, const BlackMisc::CIdentifier &originator) override;
 
             // ------------- DBus ---------------
 
         private:
-            //! Enable/disable voice transmission, nornally used with hotkey @{
+            //! Enable/disable voice transmission, nornally used with hotkey
+            //! @{
             void setVoiceTransmission(bool enable, BlackMisc::Audio::PTTCOM com);
             void setVoiceTransmissionCom1(bool enabled);
             void setVoiceTransmissionCom2(bool enabled);
@@ -187,7 +190,8 @@ namespace BlackCore
             //! Changed audio settings
             void onChangedAudioSettings();
 
-            //! Audio increase/decrease volume @{
+            //! Audio increase/decrease volume
+            //! @{
             void audioIncreaseVolume(bool enabled);
             void audioDecreaseVolume(bool enabled);
             //! @}
diff --git a/src/blackmisc/network/connectionstatus.h b/src/blackmisc/network/connectionstatus.h
index 6fce25042..d44cc3968 100644
--- a/src/blackmisc/network/connectionstatus.h
+++ b/src/blackmisc/network/connectionstatus.h
@@ -37,13 +37,13 @@ namespace BlackMisc
             //! Constructor
             CConnectionStatus(ConnectionStatus status) : m_connectionStatus(status) {}
 
+            //! Query status
+            //! @{
             bool isConnected() const { return m_connectionStatus == Connected; }
-
             bool isConnecting() const { return m_connectionStatus == Connecting; }
-
             bool isDisconnecting() const { return m_connectionStatus == Disconnecting; }
-
             bool isDisconnected() const { return m_connectionStatus == Disconnected; }
+            //! @}
 
             //! Get status
             ConnectionStatus getConnectionStatus() const { return m_connectionStatus; }
diff --git a/src/blackmisc/network/loginmode.h b/src/blackmisc/network/loginmode.h
index 69e8fe6f0..f49624ed4 100644
--- a/src/blackmisc/network/loginmode.h
+++ b/src/blackmisc/network/loginmode.h
@@ -35,14 +35,16 @@ namespace BlackMisc
             //! Constructor
             CLoginMode(LoginMode mode) : m_loginMode(mode) {}
 
+            //! Is login as pilot?
             bool isPilot() const { return m_loginMode == Pilot; }
 
+            //! Is login as observer?
             bool isObserver() const { return m_loginMode == Observer; }
 
-            //! Get status
+            //! Get login mode
             LoginMode getLoginMode() const { return m_loginMode; }
 
-            //! Set status
+            //! Set login mode
             void setLoginMode(LoginMode mode) { m_loginMode = mode; }
 
             //! \copydoc BlackMisc::Mixin::String::toQString