Fixed Doxygen

This commit is contained in:
Klaus Basan
2014-01-26 02:54:24 +01:00
parent 1199f05fe2
commit 14e90a6bc6
2 changed files with 18 additions and 56 deletions

View File

@@ -285,20 +285,17 @@ namespace BlackMisc
/*! /*!
* Set booked from * Set booked from
* \param until
*/ */
void setBookedFromUtc(const QDateTime &from) { this->m_bookedFromUtc = from; } void setBookedFromUtc(const QDateTime &from) { this->m_bookedFromUtc = from; }
/*! /*!
* Booked date/time if any. * Booked date/time if any.
* This represents the closest booking within a time frame as there can be multiple bookings. * This represents the closest booking within a time frame as there can be multiple bookings.
* \return
*/ */
const QDateTime &getBookedUntilUtc() const { return m_bookedUntilUtc; } const QDateTime &getBookedUntilUtc() const { return m_bookedUntilUtc; }
/*! /*!
* \brief Has valid booking times? * \brief Has valid booking times?
* \return
*/ */
bool hasValidBookingTimes() const bool hasValidBookingTimes() const
{ {
@@ -354,19 +351,16 @@ namespace BlackMisc
/*! /*!
* \brief Set METAR * \brief Set METAR
* \param msg
*/ */
void setMetar(const CInformationMessage &metar) { this->m_metar = metar;} void setMetar(const CInformationMessage &metar) { this->m_metar = metar;}
/*! /*!
* \brief Set METAR Message * \brief Set METAR Message
* \param msg
*/ */
void setMetarMessage(const QString &metar) { this->m_metar.setMessage(metar); } void setMetarMessage(const QString &metar) { this->m_metar.setMessage(metar); }
/*! /*!
* Set booked until * Set booked until
* \param until
*/ */
void setBookedUntilUtc(const QDateTime &until) { this->m_bookedUntilUtc = until; } void setBookedUntilUtc(const QDateTime &until) { this->m_bookedUntilUtc = until; }
@@ -389,30 +383,22 @@ namespace BlackMisc
} }
/*! /*!
* \brief Hash value * \copydoc CValueObject::getValueHash()
* \return
*/ */
virtual uint getValueHash() const; virtual uint getValueHash() const;
/*! /*!
* \brief Property by index * \coypdoc CValueObject::propertyByIndex()
* \param index
* \return
*/ */
virtual QVariant propertyByIndex(int index) const; virtual QVariant propertyByIndex(int index) const;
/*! /*!
* \brief Property by index (setting) * \copydoc CValueObject::setPropertyByIndex(const QVariant &, int)
* \param variant
* \return
*/ */
virtual void setPropertyByIndex(const QVariant &variant, int index); virtual void setPropertyByIndex(const QVariant &variant, int index);
/*! /*!
* \brief Property by index as String * \copydoc CValueObject::propertyByIndexAsString()
* \param index
* \param i18n
* \return
*/ */
virtual QString propertyByIndexAsString(int index, bool i18n = false) const; virtual QString propertyByIndexAsString(int index, bool i18n = false) const;
@@ -445,14 +431,12 @@ namespace BlackMisc
virtual int compareImpl(const CValueObject &other) const; virtual int compareImpl(const CValueObject &other) const;
/*! /*!
* \brief Stream to DBus << * \copydoc CValueObject::marshallToDbus()
* \param argument
*/ */
virtual void marshallToDbus(QDBusArgument &argument) const; virtual void marshallToDbus(QDBusArgument &argument) const;
/*! /*!
* \brief Stream from DBus >> * \copydoc CValueObject::unmarshallFromDbus()
* \param argument
*/ */
virtual void unmarshallFromDbus(const QDBusArgument &argument); virtual void unmarshallFromDbus(const QDBusArgument &argument);

View File

@@ -54,26 +54,22 @@ namespace BlackMisc
const QString &getAddress() const { return m_address; } const QString &getAddress() const { return m_address; }
/*! /*!
* \brief Set address * \brief Set address (e.g. myserver.foo.com)
* \param realname
*/ */
void setAddress(const QString &address) { m_address = address; } void setAddress(const QString &address) { m_address = address; }
/*! /*!
* Get user * Get user
* \return
*/ */
const CUser &getUser() const { return m_user; } const CUser &getUser() const { return m_user; }
/*! /*!
* \brief Set user * \brief Set user
* \param password
*/ */
void setUser(const CUser &user) { m_user = user; } void setUser(const CUser &user) { m_user = user; }
/*! /*!
* Get name * Get name
* \return
*/ */
const QString &getName() const { return m_name; } const QString &getName() const { return m_name; }
@@ -85,50 +81,41 @@ namespace BlackMisc
/*! /*!
* Get description * Get description
* \return
*/ */
const QString &getDescription() const { return m_description; } const QString &getDescription() const { return m_description; }
/*! /*!
* \brief Set description * \brief Set description
* \param description
*/ */
void setDescription(const QString &description) { m_description = description; } void setDescription(const QString &description) { m_description = description; }
/*! /*!
* Get port * Get port
* \return
*/ */
qint32 getPort() const { return m_port; } qint32 getPort() const { return m_port; }
/*! /*!
* \brief Set port * \brief Set port
* \param port
*/ */
void setPort(qint32 port) { m_port = port; } void setPort(qint32 port) { m_port = port; }
/*! /*!
* \brief Is valid for login * \brief Is valid for login?
* \return
*/ */
bool isValidForLogin() const; bool isValidForLogin() const;
/*! /*!
* \brief Equal operator == * \brief Equal operator ==
* \param other
* \return
*/ */
bool operator ==(const CServer &other) const; bool operator ==(const CServer &other) const;
/*! /*!
* \brief Unequal operator == * \brief Unequal operator !=
* \param other
* \return
*/ */
bool operator !=(const CServer &other) const; bool operator !=(const CServer &other) const;
/*! /*!
* \brief Value hash * \copydoc CValueObject::getValueHash()
*/ */
virtual uint getValueHash() const; virtual uint getValueHash() const;
@@ -152,32 +139,23 @@ namespace BlackMisc
}; };
/*! /*!
* \brief Property by index * \copydoc CValueObject::propertyByIndex(int)
* \param index
* \return
*/ */
QVariant propertyByIndex(int index) const; QVariant propertyByIndex(int index) const;
/*! /*!
* \brief Property by index as string * \copydoc CValueObject::propertyByIndex(const QVariant &, int index)
* \param index
* \param i18n
* \return
*/
QString propertyByIndexAsString(int index, bool i18n) const;
/*!
* \brief Property by index (setter)
* \param variant
* \param index
*/ */
void propertyByIndex(const QVariant &variant, int index); void propertyByIndex(const QVariant &variant, int index);
/*!
* \copydoc CValueObject::propertyByIndexAsString()
*/
QString propertyByIndexAsString(int index, bool i18n) const;
protected: protected:
/*! /*!
* \brief Rounded value as string * \copydoc CValueObject::convertToQString()
* \param i18n
* \return
*/ */
virtual QString convertToQString(bool i18n = false) const; virtual QString convertToQString(bool i18n = false) const;