From 14e90a6bc6e71740327f71a2e8fef0d839b8379c Mon Sep 17 00:00:00 2001 From: Klaus Basan Date: Sun, 26 Jan 2014 02:54:24 +0100 Subject: [PATCH] Fixed Doxygen --- src/blackmisc/avatcstation.h | 28 +++++----------------- src/blackmisc/nwserver.h | 46 ++++++++++-------------------------- 2 files changed, 18 insertions(+), 56 deletions(-) diff --git a/src/blackmisc/avatcstation.h b/src/blackmisc/avatcstation.h index dda2fa73b..45a525f66 100644 --- a/src/blackmisc/avatcstation.h +++ b/src/blackmisc/avatcstation.h @@ -285,20 +285,17 @@ namespace BlackMisc /*! * Set booked from - * \param until */ void setBookedFromUtc(const QDateTime &from) { this->m_bookedFromUtc = from; } /*! * Booked date/time if any. * This represents the closest booking within a time frame as there can be multiple bookings. - * \return */ const QDateTime &getBookedUntilUtc() const { return m_bookedUntilUtc; } /*! * \brief Has valid booking times? - * \return */ bool hasValidBookingTimes() const { @@ -354,19 +351,16 @@ namespace BlackMisc /*! * \brief Set METAR - * \param msg */ void setMetar(const CInformationMessage &metar) { this->m_metar = metar;} /*! * \brief Set METAR Message - * \param msg */ void setMetarMessage(const QString &metar) { this->m_metar.setMessage(metar); } /*! * Set booked until - * \param until */ void setBookedUntilUtc(const QDateTime &until) { this->m_bookedUntilUtc = until; } @@ -389,30 +383,22 @@ namespace BlackMisc } /*! - * \brief Hash value - * \return + * \copydoc CValueObject::getValueHash() */ virtual uint getValueHash() const; /*! - * \brief Property by index - * \param index - * \return + * \coypdoc CValueObject::propertyByIndex() */ virtual QVariant propertyByIndex(int index) const; /*! - * \brief Property by index (setting) - * \param variant - * \return + * \copydoc CValueObject::setPropertyByIndex(const QVariant &, int) */ virtual void setPropertyByIndex(const QVariant &variant, int index); /*! - * \brief Property by index as String - * \param index - * \param i18n - * \return + * \copydoc CValueObject::propertyByIndexAsString() */ virtual QString propertyByIndexAsString(int index, bool i18n = false) const; @@ -445,14 +431,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::unmarshallFromDbus() */ virtual void unmarshallFromDbus(const QDBusArgument &argument); diff --git a/src/blackmisc/nwserver.h b/src/blackmisc/nwserver.h index 9e47ec84c..2c86c0517 100644 --- a/src/blackmisc/nwserver.h +++ b/src/blackmisc/nwserver.h @@ -54,26 +54,22 @@ namespace BlackMisc const QString &getAddress() const { return m_address; } /*! - * \brief Set address - * \param realname + * \brief Set address (e.g. myserver.foo.com) */ void setAddress(const QString &address) { m_address = address; } /*! * Get user - * \return */ const CUser &getUser() const { return m_user; } /*! * \brief Set user - * \param password */ void setUser(const CUser &user) { m_user = user; } /*! * Get name - * \return */ const QString &getName() const { return m_name; } @@ -85,50 +81,41 @@ namespace BlackMisc /*! * Get description - * \return */ const QString &getDescription() const { return m_description; } /*! * \brief Set description - * \param description */ void setDescription(const QString &description) { m_description = description; } /*! * Get port - * \return */ qint32 getPort() const { return m_port; } /*! * \brief Set port - * \param port */ void setPort(qint32 port) { m_port = port; } /*! - * \brief Is valid for login - * \return + * \brief Is valid for login? */ bool isValidForLogin() const; /*! * \brief Equal operator == - * \param other - * \return */ bool operator ==(const CServer &other) const; /*! - * \brief Unequal operator == - * \param other - * \return + * \brief Unequal operator != */ bool operator !=(const CServer &other) const; /*! - * \brief Value hash + * \copydoc CValueObject::getValueHash() */ virtual uint getValueHash() const; @@ -152,32 +139,23 @@ namespace BlackMisc }; /*! - * \brief Property by index - * \param index - * \return + * \copydoc CValueObject::propertyByIndex(int) */ QVariant propertyByIndex(int index) const; /*! - * \brief Property by index as string - * \param index - * \param i18n - * \return - */ - QString propertyByIndexAsString(int index, bool i18n) const; - - /*! - * \brief Property by index (setter) - * \param variant - * \param index + * \copydoc CValueObject::propertyByIndex(const QVariant &, int index) */ void propertyByIndex(const QVariant &variant, int index); + /*! + * \copydoc CValueObject::propertyByIndexAsString() + */ + QString propertyByIndexAsString(int index, bool i18n) const; + protected: /*! - * \brief Rounded value as string - * \param i18n - * \return + * \copydoc CValueObject::convertToQString() */ virtual QString convertToQString(bool i18n = false) const;