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
* \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);

View File

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