[FSD] Doxygen

This commit is contained in:
Mat Sutcliffe
2019-10-03 19:09:26 +01:00
parent 6eb008c0a0
commit 2dbc347bd7
3 changed files with 19 additions and 13 deletions

View File

@@ -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; }

View File

@@ -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