From 7b5e768513383ee7ec22a1d44db444a50ee1c2cc Mon Sep 17 00:00:00 2001 From: Klaus Basan Date: Wed, 30 Apr 2014 01:14:17 +0200 Subject: [PATCH] Formatting, comments / doxygen --- src/blackmisc/pqacceleration.h | 34 +++++++--------------------------- src/blackmisc/pqangle.h | 14 +++----------- src/blackmisc/pqfrequency.h | 15 ++++----------- src/blackmisc/pqlength.h | 22 +++++----------------- src/blackmisc/pqmass.h | 18 ++++-------------- src/blackmisc/pqpressure.h | 18 +++--------------- src/blackmisc/pqspeed.h | 19 +++++-------------- src/blackmisc/pqstring.h | 2 -- src/blackmisc/pqtemperature.h | 27 +++++++-------------------- src/blackmisc/pqtime.h | 10 +++++----- 10 files changed, 43 insertions(+), 136 deletions(-) diff --git a/src/blackmisc/pqacceleration.h b/src/blackmisc/pqacceleration.h index c6ab984af..6c1d7ebe0 100644 --- a/src/blackmisc/pqacceleration.h +++ b/src/blackmisc/pqacceleration.h @@ -12,41 +12,21 @@ namespace BlackMisc namespace PhysicalQuantities { - /*! - * \brief Acceleration - */ + //! Acceleration class CAcceleration : public CPhysicalQuantity { public: - /*! - * \brief Default constructor - */ + //! Default constructor CAcceleration() : CPhysicalQuantity(0, CAccelerationUnit::defaultUnit()) {} - /*! - * \brief Init by double value - * \param value - * \param unit - */ + //! Init by double value CAcceleration(double value, const CAccelerationUnit &unit) : CPhysicalQuantity(value, unit) {} - /*! - * \brief Copy constructor by base type - * \param base - */ - CAcceleration(const CPhysicalQuantity &base) : CPhysicalQuantity(base) {} + //! \copydoc CPhysicalQuantity(const QString &unitString) + //! copydoc CValueObject::toQVariant + virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); } - /*! - * \copydoc CValueObject::toQVariant - */ - virtual QVariant toQVariant() const override - { - return QVariant::fromValue(*this); - } - - /*! - * \brief Virtual destructor - */ + //! Virtual destructor virtual ~CAcceleration() {} }; diff --git a/src/blackmisc/pqangle.h b/src/blackmisc/pqangle.h index cad3acc9f..bc73e9b5c 100644 --- a/src/blackmisc/pqangle.h +++ b/src/blackmisc/pqangle.h @@ -19,16 +19,10 @@ namespace BlackMisc class CAngle : public CPhysicalQuantity { public: - /*! - * \brief Default constructor - */ + //! Default constructor CAngle() : CPhysicalQuantity(0, CAngleUnit::defaultUnit()) {} - /*! - * \brief Init by double value - * \param value - * \param unit - */ + //! Init by double value CAngle(double value, const CAngleUnit &unit): CPhysicalQuantity(value, unit) {} /*! @@ -54,9 +48,7 @@ namespace BlackMisc degrees + minutes / 100.0, CAngleUnit::sexagesimalDegMin()) {} - /*! - * \copydoc CValueObject::toQVariant - */ + //! \copydoc CValueObject::toQVariant virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); diff --git a/src/blackmisc/pqfrequency.h b/src/blackmisc/pqfrequency.h index 8c0d81b0a..44865ed88 100644 --- a/src/blackmisc/pqfrequency.h +++ b/src/blackmisc/pqfrequency.h @@ -17,21 +17,14 @@ namespace BlackMisc class CFrequency : public CPhysicalQuantity { public: - /*! - * \brief Default constructor - */ + //! Default constructor CFrequency() : CPhysicalQuantity(0, CFrequencyUnit::defaultUnit()) {} - /*! - * \brief Init by double value - * \param value - * \param unit - */ + //! Init by double value CFrequency(double value, const CFrequencyUnit &unit) : CPhysicalQuantity(value, unit) {} - /*! - * \copydoc CValueObject::toQVariant - */ + + //! \copydoc CValueObject::toQVariant virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); diff --git a/src/blackmisc/pqlength.h b/src/blackmisc/pqlength.h index 2f2cfccff..a0632402b 100644 --- a/src/blackmisc/pqlength.h +++ b/src/blackmisc/pqlength.h @@ -12,35 +12,23 @@ namespace BlackMisc namespace PhysicalQuantities { - /*! - * \brief Physical unit length (length) - */ + //! Physical unit length (length) class CLength : public CPhysicalQuantity { public: - /*! - * \brief Default constructor - */ + //! Default constructor CLength() : CPhysicalQuantity(0, CLengthUnit::defaultUnit()) {} - /*! - * \brief Init by double value - * \param value - * \param unit - */ + //! Init by double value CLength(double value, const CLengthUnit &unit) : CPhysicalQuantity(value, unit) {} - /*! - * \copydoc CValueObject::toQVariant - */ + //! \copydoc CValueObject::toQVariant virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); } - /*! - * \brief Virtual destructor - */ + //! Virtual destructor virtual ~CLength() {} }; diff --git a/src/blackmisc/pqmass.h b/src/blackmisc/pqmass.h index c997a7fbc..d997d0d18 100644 --- a/src/blackmisc/pqmass.h +++ b/src/blackmisc/pqmass.h @@ -18,29 +18,19 @@ namespace BlackMisc class CMass : public CPhysicalQuantity { public: - /*! - * \brief Default constructor - */ + //! Default constructor CMass() : CPhysicalQuantity(0, CMassUnit::defaultUnit()) {} - /*! - * \brief Init by double value - * \param value - * \param unit - */ + //! Init by double value CMass(double value, const CMassUnit &unit) : CPhysicalQuantity(value, unit) {} - /*! - * \copydoc CValueObject::toQVariant - */ + //! \copydoc CValueObject::toQVariant virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); } - /*! - * \brief Virtual destructor - */ + //! Virtual destructor virtual ~CMass() {} }; diff --git a/src/blackmisc/pqpressure.h b/src/blackmisc/pqpressure.h index 757b49069..f97a7d069 100644 --- a/src/blackmisc/pqpressure.h +++ b/src/blackmisc/pqpressure.h @@ -15,34 +15,22 @@ namespace BlackMisc /*! * \brief Physical unit distance - * \author KWB */ class CPressure : public CPhysicalQuantity { public: - /*! - * \brief Default constructor - */ + //! Default constructor CPressure() : CPhysicalQuantity(0, CPressureUnit::defaultUnit()) {} - /*! - *\brief Init by double value - * \param value - * \param unit - */ + //! Init by double value CPressure(double value, const CPressureUnit &unit) : CPhysicalQuantity(value, unit) {} - /*! - * \copydoc CValueObject::toQVariant - */ virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); } - /*! - * \brief Virtual destructor - */ + //! Virtual destructor virtual ~CPressure() {} }; diff --git a/src/blackmisc/pqspeed.h b/src/blackmisc/pqspeed.h index b163b8771..aec4af4c8 100644 --- a/src/blackmisc/pqspeed.h +++ b/src/blackmisc/pqspeed.h @@ -19,29 +19,20 @@ namespace BlackMisc { public: - /*! - * \brief Default constructor - */ + //! Default constructor CSpeed() : CPhysicalQuantity(0, CSpeedUnit::defaultUnit()) {} - /*! - *\brief Init by double value - * \param value - * \param unit - */ + //! Init by double value CSpeed(double value, const CSpeedUnit &unit) : CPhysicalQuantity(value, unit) {} - /*! - * \copydoc CValueObject::toQVariant - */ + + //! \copydoc CValueObject::toQVariant virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); } - /*! - * \brief Destructor - */ + //! Destructor virtual ~CSpeed() {} }; diff --git a/src/blackmisc/pqstring.h b/src/blackmisc/pqstring.h index 6b719f77a..0dfbe27f3 100644 --- a/src/blackmisc/pqstring.h +++ b/src/blackmisc/pqstring.h @@ -21,8 +21,6 @@ namespace BlackMisc */ class CPqString : public BlackMisc::CValueObject { - public: - private: BLACK_ENABLE_TUPLE_CONVERSION(CPqString) QString m_string; diff --git a/src/blackmisc/pqtemperature.h b/src/blackmisc/pqtemperature.h index 1f2563c83..616790355 100644 --- a/src/blackmisc/pqtemperature.h +++ b/src/blackmisc/pqtemperature.h @@ -14,34 +14,21 @@ namespace BlackMisc /*! * \brief Physical unit temperature - * \author KWB */ class CTemperature : public CPhysicalQuantity { public: - /*! - * \brief Default constructor - */ + //! Default constructor CTemperature() : CPhysicalQuantity(0, CTemperatureUnit::defaultUnit()) {} - /*! - * \brief Init by double value - * \param value - * \param unit - */ + //! Init by double value CTemperature(double value, const CTemperatureUnit &unit): CPhysicalQuantity(value, unit) {} - /*! - * \copydoc CValueObject::toQVariant - */ - virtual QVariant toQVariant() const override - { - return QVariant::fromValue(*this); - } - /*! - * \brief Destructor - */ + //! \copydoc CValueObject::toQVariant + virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); } + + //! Destructor virtual ~CTemperature() {} }; @@ -50,4 +37,4 @@ namespace BlackMisc Q_DECLARE_METATYPE(BlackMisc::PhysicalQuantities::CTemperature) -#endif // BLACKMISC_CTEMPERATURE_H +#endif // guard diff --git a/src/blackmisc/pqtime.h b/src/blackmisc/pqtime.h index 09d38750d..bf9d07d64 100644 --- a/src/blackmisc/pqtime.h +++ b/src/blackmisc/pqtime.h @@ -28,8 +28,8 @@ namespace BlackMisc //! By Qt time CTime(const QTime &time); - //! By string hh:mm or hh:mm:ss - CTime(const QString &time); + //! \copydoc CPhysicalQuantity(const QString &unitString) + CTime(const QString &unitString) : CPhysicalQuantity(unitString) {} //! \copydoc CValueObject::toQVariant virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); } @@ -37,8 +37,8 @@ namespace BlackMisc //! Destructor virtual ~CTime() {} - //! From string hh:mm, or hh:mm:ss - void parseFromString(const QString &time); + //! From string hh:mm, or hh:mm:ss, or time units such as s, min + virtual void parseFromString(const QString &time) override; //! To Qt time QTime toQTime() const; @@ -50,4 +50,4 @@ namespace BlackMisc Q_DECLARE_METATYPE(BlackMisc::PhysicalQuantities::CTime) -#endif // BLACKMISC_PQTIME_H +#endif // guard