diff --git a/src/blackmisc/avatcstation.h b/src/blackmisc/avatcstation.h index 7c93e8648..b87353790 100644 --- a/src/blackmisc/avatcstation.h +++ b/src/blackmisc/avatcstation.h @@ -361,26 +361,23 @@ namespace BlackMisc BlackMisc::PhysicalQuantities::CTime bookedWhen() const; /*! - * \brief Get atis + * \brief Get ATIS * \return */ const CInformationMessage &getAtis() const { return m_atis; } /*! * \brief Set ATIS - * \param msg */ void setAtis(const CInformationMessage &atis) { this->m_atis = atis;} /*! * \brief Set ATIS Message - * \param atis */ void setAtisMessage(const QString &atis) { this->m_atis.setMessage(atis); } /*! * \brief Get METAR - * \return */ const CInformationMessage &getMetar() const { return m_metar; } diff --git a/src/blackmisc/aviocomsystem.h b/src/blackmisc/aviocomsystem.h index f3271fc76..1f74775d3 100644 --- a/src/blackmisc/aviocomsystem.h +++ b/src/blackmisc/aviocomsystem.h @@ -58,13 +58,11 @@ namespace BlackMisc /*! * \brief Copy constructor - * \param other */ CComSystem(const CComSystem &other) : CModulator(other) {} /*! - * \brief QVariant, required for DBus QVariant lists - * \return + * \copydoc CValueObject::toQVariant */ virtual QVariant toQVariant() const { @@ -72,7 +70,7 @@ namespace BlackMisc } /*! - * \brief Value hash + * \copydoc CValueObject::getValueHash * \return */ virtual uint getValueHash() const @@ -82,10 +80,6 @@ namespace BlackMisc /*! * \brief Constructor - * \param name - * \param activeFrequency - * \param standbyFrequency - * \param digits */ CComSystem(const QString &name, const BlackMisc::PhysicalQuantities::CFrequency &activeFrequency, const BlackMisc::PhysicalQuantities::CFrequency &standbyFrequency = CModulator::FrequencyNotSet(), int digits = 3): CModulator(name, activeFrequency, standbyFrequency == CModulator::FrequencyNotSet() ? activeFrequency : standbyFrequency, digits) @@ -95,13 +89,13 @@ namespace BlackMisc /*! * \brief Set active frequency - * \param frequencyMHz + * \remarks will be rounded to 25KHz */ void setFrequencyActiveMHz(double frequencyMHz); /*! * \brief Set standby frequency - * \param frequencyMHz + * \remarks will be rounded to 25KHz */ void setFrequencyStandbyMHz(double frequencyMHz); @@ -317,8 +311,6 @@ namespace BlackMisc /*! * \brief Valid civil aviation frequency? - * \param f - * \return */ static bool isValidCivilAviationFrequency(const BlackMisc::PhysicalQuantities::CFrequency &f) { @@ -328,8 +320,6 @@ namespace BlackMisc /*! * \brief Valid military aviation frequency? - * \param f - * \return */ static bool isValidMilitaryFrequency(const BlackMisc::PhysicalQuantities::CFrequency &f) { @@ -338,9 +328,7 @@ namespace BlackMisc } /*! - * \brief Round to 25KHz - * \param f - * \return + * \brief Round to 25KHz, set MHz as unit */ static void roundTo25KHz(BlackMisc::PhysicalQuantities::CFrequency &frequency); diff --git a/src/blackmisc/aviomodulator.h b/src/blackmisc/aviomodulator.h index 19a976ce4..9aaa993eb 100644 --- a/src/blackmisc/aviomodulator.h +++ b/src/blackmisc/aviomodulator.h @@ -302,13 +302,11 @@ namespace BlackMisc /*! * \brief Enabled? - * \return */ bool isEnabled() const { return this->m_enabled;} /*! * \brief Enabled? - * \param */ void setEnabled(bool enable) { this->m_enabled = enable;} diff --git a/src/blackmisc/aviotransponder.h b/src/blackmisc/aviotransponder.h index ccff84aa3..f3555ec32 100644 --- a/src/blackmisc/aviotransponder.h +++ b/src/blackmisc/aviotransponder.h @@ -375,22 +375,17 @@ namespace BlackMisc } /*! - * \brief Value hash - * \return + * \copydoc CValueObject::getValueHash() */ virtual uint getValueHash() const; /*! * \brief Is valid transponder code? - * \param transponderCode - * \return */ static bool isValidTransponderCode(const QString &transponderCode); /*! * \brief Is valid transponder code? - * \param transponderCode - * \return */ static bool isValidTransponderCode(qint32 transponderMode); diff --git a/src/blackmisc/nwtextmessage.h b/src/blackmisc/nwtextmessage.h index d02f553fa..dc95fb145 100644 --- a/src/blackmisc/nwtextmessage.h +++ b/src/blackmisc/nwtextmessage.h @@ -32,9 +32,6 @@ namespace BlackMisc /*! * Constructor, radio message - * \param message - * \param frequency - * \param senderCallsign */ CTextMessage(const QString &message, const BlackMisc::PhysicalQuantities::CFrequency &frequency, const BlackMisc::Aviation::CCallsign &senderCallsign = BlackMisc::Aviation::CCallsign()) : m_message(message), m_received(QDateTime::currentDateTimeUtc()), m_senderCallsign(senderCallsign), m_frequency(frequency) @@ -44,16 +41,12 @@ namespace BlackMisc /*! * Constructor, private message - * \param message - * \param senderCallsign - * \param recipientCallsign */ CTextMessage(const QString &message, const BlackMisc::Aviation::CCallsign &senderCallsign, const BlackMisc::Aviation::CCallsign &recipientCallsign = BlackMisc::Aviation::CCallsign()) : m_message(message), m_received(QDateTime::currentDateTimeUtc()), m_senderCallsign(senderCallsign), m_recipientCallsign(recipientCallsign), m_frequency(-1.0, BlackMisc::PhysicalQuantities::CFrequencyUnit::MHz()) {} /*! * \brief QVariant, required for DBus QVariant lists - * \return */ virtual QVariant toQVariant() const { @@ -62,7 +55,6 @@ namespace BlackMisc /*! * Get callsign (from) - * \return */ const BlackMisc::Aviation::CCallsign &getSenderCallsign() const { @@ -71,7 +63,6 @@ namespace BlackMisc /*! * Set callsign (from) - * \param */ void setSenderCallsign(const BlackMisc::Aviation::CCallsign &callsign) { @@ -80,7 +71,6 @@ namespace BlackMisc /*! * Get callsign (to) - * \return */ const BlackMisc::Aviation::CCallsign &getRecipientCallsign() const { @@ -89,35 +79,29 @@ namespace BlackMisc /*! * Set callsign (to) - * \param */ void setRecipientCallsign(const BlackMisc::Aviation::CCallsign &callsign) { m_recipientCallsign = callsign; } - /* - * Send to frequency? - * \param frequency - * \return + /*! + * Send to particular frequency? */ bool isSendToFrequency(const BlackMisc::PhysicalQuantities::CFrequency &frequency) const; /*! * Send to UNICOM? - * \return */ bool isSendToUnicom() const; /*! * \brief Valid receviver? - * \return */ bool hasValidRecipient() const; /*! * Get message - * \return */ const QString &getMessage() const { @@ -126,7 +110,6 @@ namespace BlackMisc /*! * Empty message - * \return */ bool isEmpty() const { @@ -135,7 +118,6 @@ namespace BlackMisc /*! * Set message - * \param */ void setMessage(const QString &message) { @@ -144,7 +126,6 @@ namespace BlackMisc /*! * Get frequency - * \return */ const BlackMisc::PhysicalQuantities::CFrequency &getFrequency() const { @@ -153,7 +134,6 @@ namespace BlackMisc /*! * Set frequency - * \param */ void setFrequency(const BlackMisc::PhysicalQuantities::CFrequency &frequency) { @@ -162,25 +142,21 @@ namespace BlackMisc /*! * \brief Is private message? - * \return */ bool isPrivateMessage() const; /*! * \brief Is radio message? - * \return */ bool isRadioMessage() const; /*! * \brief Initial message of server? - * \return */ bool isServerMessage() const; /*! * \brief Received (hh mm ss) - * \return */ QString receivedTime() const { @@ -191,9 +167,9 @@ namespace BlackMisc /*! * Whole message as formatted string. * Used to display message in a console window. - * \param withSender - * \param withRecipient - * \param separator + * \param withSender include sender information in string? + * \param withRecipient include recipient information in string? + * \param separator values separated by given value * \return */ QString asString(bool withSender, bool withRecipient, const QString separator = ", ") const; @@ -205,20 +181,16 @@ namespace BlackMisc /*! * \brief Equal operator == - * \param other - * @return */ bool operator ==(const CTextMessage &other) const; /*! - * \brief Unequal operator == - * \param other - * @return + * \brief Unequal operator != */ bool operator !=(const CTextMessage &other) const; /*! - * \brief Value hash + * \copydoc CValueObject::getValueHash() */ virtual uint getValueHash() const; @@ -229,9 +201,7 @@ namespace BlackMisc protected: /*! - * \brief Rounded value as string - * \param i18n - * \return + * \copydoc CValueObject::convertToQString */ virtual QString convertToQString(bool i18n = false) const; @@ -251,14 +221,12 @@ namespace BlackMisc virtual int compareImpl(const CValueObject &other) const; /*! - * \brief Stream to DBus << - * \param argument + * \copydoc CValueObject::marshallToDbus */ virtual void marshallToDbus(QDBusArgument &argument) const; /*! - * \brief Stream from DBus >> - * \param argument + * \copydoc CValueObject::unmarshallFomDbus */ virtual void unmarshallFromDbus(const QDBusArgument &argument); diff --git a/src/blackmisc/nwtextmessagelist.h b/src/blackmisc/nwtextmessagelist.h index 141a8bb51..9572048a1 100644 --- a/src/blackmisc/nwtextmessagelist.h +++ b/src/blackmisc/nwtextmessagelist.h @@ -34,50 +34,36 @@ namespace BlackMisc /*! * \brief Constructor, single private message - * \param message - * \param recipientCallsign */ CTextMessageList(const QString &message, const BlackMisc::Aviation::CCallsign &recipientCallsign); /*! * \brief Constructor, single private message - * \param message - * \param senderCallsign - * \param recipientCallsign */ CTextMessageList(const QString &message, const BlackMisc::Aviation::CCallsign &senderCallsign, const BlackMisc::Aviation::CCallsign &recipientCallsign); /*! * \brief Constructor, single radio message - * \param message - * \param frequency - * \param sender */ CTextMessageList(const QString &message, const BlackMisc::PhysicalQuantities::CFrequency &frequency, const BlackMisc::Aviation::CCallsign &senderCallsign = BlackMisc::Aviation::CCallsign()); /*! * \brief Constructor, single message - * \param message */ CTextMessageList(const CTextMessage &message); /*! * \brief Constructor, multi-frequency radio messages - * \param message - * \param frequencies - * \param sender */ CTextMessageList(const QString &message, const QList &frequencies, const BlackMisc::Aviation::CCallsign &sender = BlackMisc::Aviation::CCallsign()); /*! * \brief Construct from a base class object. - * \param other */ CTextMessageList(const CSequence &other); /*! * \brief QVariant, required for DBus QVariant lists - * \return */ virtual QVariant toQVariant() const { @@ -86,7 +72,6 @@ namespace BlackMisc /*! * \brief Private messages - * \return */ CTextMessageList getPrivateMessages() const; @@ -98,20 +83,16 @@ namespace BlackMisc /*! * \brief Public messages - * \return */ CTextMessageList getRadioMessages() const; /*! * \brief Contains radio messages? - * \return */ bool containsRadioMessages() const; /*! * \brief Find by frequency - * \param frequency - * \return */ CTextMessageList findByFrequency(const BlackMisc::PhysicalQuantities::CFrequency &frequency) const; diff --git a/src/blackmisc/nwuser.h b/src/blackmisc/nwuser.h index f28af504b..86620cc49 100644 --- a/src/blackmisc/nwuser.h +++ b/src/blackmisc/nwuser.h @@ -46,8 +46,7 @@ namespace BlackMisc {} /*! - * \brief QVariant, required for DBus QVariant lists - * \return + * \copydoc CValueObject::toQVariant() */ virtual QVariant toQVariant() const { @@ -62,73 +61,61 @@ namespace BlackMisc /*! * \brief setRealName - * \param realname */ void setRealName(const QString &realname) { m_realname = realname.trimmed(); } /*! * Get password - * \return */ QString getPassword() const { return m_password; } /*! * Set password - * \param */ void setPassword(const QString &pw) { m_password = pw.trimmed(); } /*! * \brief Valid user object? - * \return */ bool isValid() const { return !this->m_realname.isEmpty() && !this->m_id.isEmpty(); } /*! * \brief Valid credentials? - * \return */ bool hasValidCredentials() const { return this->isValid() && !this->m_password.isEmpty(); } /*! * \brief Valid real name? - * \return */ bool hasValidRealName() const { return !this->m_realname.isEmpty(); } /*! * \brief Valid id? - * \return */ bool hasValidId() const { return !this->m_id.isEmpty(); } /*! * Get email. - * \return */ QString getEmail() const { return m_email; } /*! * Set email. - * \param */ void setEmail(const QString &email) { m_email = email.trimmed(); } /*! * Get id. - * \return */ QString getId() const { return m_id; } /*! * \brief Valid email? - * \return */ bool hasValidEmail() const { return !this->m_email.isEmpty(); } /*! * \brief Set id - * \param realname */ void setId(const QString &id) { m_id = id.trimmed(); } diff --git a/src/blackmisc/vaudiodevice.h b/src/blackmisc/vaudiodevice.h index 4b1fca4e7..afb1d9e57 100644 --- a/src/blackmisc/vaudiodevice.h +++ b/src/blackmisc/vaudiodevice.h @@ -142,25 +142,33 @@ namespace BlackMisc virtual int compareImpl(const CValueObject &other) const; /*! - * \brief Stream to DBus << - * \param argument + * \copydoc CValueObject::marshallToDbus() */ virtual void marshallToDbus(QDBusArgument &argument) const; /*! - * \brief Stream from DBus >> - * \param argument + * \copydoc CValueObject::unmarshallFromDbus() */ virtual void unmarshallFromDbus(const QDBusArgument &argument); protected: + /*! + * \brief Device type, @see CAudioDevice::DeviceType + */ + DeviceType m_type; /*! * deviceIndex is the number is the reference for the VVL. The device is selected by this index. * The managing class needs to take care, that indexes are valid. */ - DeviceType m_type; qint16 m_deviceIndex; + /*! + * \brief Device name + */ QString m_deviceName; + /*! + * We use a DBus based system. Hence an audio device can reside on a different + * computer, this here is its name + */ QString m_hostName; private: