mirror of
https://github.com/swift-project/pilotclient.git
synced 2026-04-23 05:45:35 +08:00
refs #192, Doxygen and other cosmetic changes
This commit is contained in:
@@ -24,54 +24,32 @@ namespace BlackMisc
|
||||
{
|
||||
public:
|
||||
|
||||
/*!
|
||||
* Default constructor.
|
||||
*/
|
||||
CVoiceRoom() :
|
||||
m_connected(false), m_audioPlaying(false) {}
|
||||
//! \brief Default constructor.
|
||||
CVoiceRoom() : m_connected(false), m_audioPlaying(false) {}
|
||||
|
||||
/*!
|
||||
* Constructor.
|
||||
* \param hostname
|
||||
* \param channel
|
||||
*/
|
||||
//! \brief Constructor.
|
||||
CVoiceRoom(const QString &hostname, const QString &channel) :
|
||||
m_hostname(hostname), m_channel(channel), m_connected(false), m_audioPlaying(false) {}
|
||||
|
||||
/*!
|
||||
* Constructor.
|
||||
* \param serverUrl
|
||||
* \param connected
|
||||
*/
|
||||
//! \brief Constructor.
|
||||
CVoiceRoom(const QString &serverUrl, bool connected = false);
|
||||
|
||||
/*!
|
||||
* \copydoc CValueObject::toQVariant
|
||||
*/
|
||||
//! \copydoc CValueObject::toQVariant
|
||||
virtual QVariant toQVariant() const override
|
||||
{
|
||||
return QVariant::fromValue(*this);
|
||||
}
|
||||
|
||||
/*!
|
||||
* Get the host name
|
||||
* \return
|
||||
*/
|
||||
//! \brief Get the host name
|
||||
const QString &getHostName() const { return m_hostname; }
|
||||
|
||||
/*!
|
||||
* Get the voice room
|
||||
*/
|
||||
//! \brief Get the voice room channel
|
||||
const QString &getChannel() const { return m_channel; }
|
||||
|
||||
/*!
|
||||
* \brief Set the host name
|
||||
*/
|
||||
//! \brief Set the host name
|
||||
void setHostName(const QString &hostName) { m_hostname = hostName; }
|
||||
|
||||
/*!
|
||||
* \brief Set the voice channel
|
||||
*/
|
||||
//! \brief Set the voice channel
|
||||
void setChannel(const QString &channel) { m_channel = channel; }
|
||||
|
||||
/*!
|
||||
@@ -81,59 +59,31 @@ namespace BlackMisc
|
||||
*/
|
||||
QString getVoiceRoomUrl(bool noProtocol = true) const;
|
||||
|
||||
/*!
|
||||
* \brief Valid voice room object?
|
||||
* \return
|
||||
*/
|
||||
//! \brief Valid voice room object?
|
||||
bool isValid() const { return !this->m_hostname.isEmpty() && !this->m_channel.isEmpty(); }
|
||||
|
||||
/*!
|
||||
* \brief Is connected
|
||||
* \return
|
||||
*/
|
||||
//! \brief Is connected?
|
||||
bool isConnected() const { return this->isValid() && this->m_connected; }
|
||||
|
||||
/*!
|
||||
* \brief Set connected status
|
||||
* \param isConnected
|
||||
*/
|
||||
//! \brief Set connection status
|
||||
void setConnected(bool isConnected) { this->m_connected = isConnected; }
|
||||
|
||||
/*!
|
||||
* \brief Is audio playing in this room?
|
||||
* \return
|
||||
*/
|
||||
//! \brief Is audio playing in this room?
|
||||
bool isAudioPlaying() const { return this->m_audioPlaying; }
|
||||
|
||||
/*!
|
||||
* \brief Set audio playing
|
||||
* \param playing
|
||||
*/
|
||||
//! \brief Set audio playing
|
||||
void setAudioPlaying(bool playing) { this->m_audioPlaying = playing; }
|
||||
|
||||
/*!
|
||||
* \brief Is ATIS voice channel
|
||||
* \return
|
||||
*/
|
||||
//! \brief Is ATIS voice channel
|
||||
bool isAtis() const;
|
||||
|
||||
/*!
|
||||
* \brief Equal operator ==
|
||||
* \param other
|
||||
* @return
|
||||
*/
|
||||
//! \brief Equal operator ==
|
||||
bool operator ==(const CVoiceRoom &other) const;
|
||||
|
||||
/*!
|
||||
* \brief Unequal operator ==
|
||||
* \param other
|
||||
* @return
|
||||
*/
|
||||
//! \brief Unequal operator !=
|
||||
bool operator !=(const CVoiceRoom &other) const;
|
||||
|
||||
/*!
|
||||
* \copydoc CValueObject::getValueHash
|
||||
*/
|
||||
//! \copydoc CValueObject::getValueHash
|
||||
virtual uint getValueHash() const override;
|
||||
|
||||
/*!
|
||||
|
||||
Reference in New Issue
Block a user