Formatting, comments / doxygen

This commit is contained in:
Klaus Basan
2014-04-30 01:14:17 +02:00
parent b727ea65af
commit 7b5e768513
10 changed files with 43 additions and 136 deletions

View File

@@ -12,41 +12,21 @@ namespace BlackMisc
namespace PhysicalQuantities namespace PhysicalQuantities
{ {
/*! //! Acceleration
* \brief Acceleration
*/
class CAcceleration : public CPhysicalQuantity<CAccelerationUnit, CAcceleration> class CAcceleration : public CPhysicalQuantity<CAccelerationUnit, CAcceleration>
{ {
public: public:
/*! //! Default constructor
* \brief Default constructor
*/
CAcceleration() : CPhysicalQuantity(0, CAccelerationUnit::defaultUnit()) {} CAcceleration() : CPhysicalQuantity(0, CAccelerationUnit::defaultUnit()) {}
/*! //! Init by double value
* \brief Init by double value
* \param value
* \param unit
*/
CAcceleration(double value, const CAccelerationUnit &unit) : CPhysicalQuantity(value, unit) {} CAcceleration(double value, const CAccelerationUnit &unit) : CPhysicalQuantity(value, unit) {}
/*! //! \copydoc CPhysicalQuantity(const QString &unitString)
* \brief Copy constructor by base type //! copydoc CValueObject::toQVariant
* \param base virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); }
*/
CAcceleration(const CPhysicalQuantity &base) : CPhysicalQuantity(base) {}
/*! //! Virtual destructor
* \copydoc CValueObject::toQVariant
*/
virtual QVariant toQVariant() const override
{
return QVariant::fromValue(*this);
}
/*!
* \brief Virtual destructor
*/
virtual ~CAcceleration() {} virtual ~CAcceleration() {}
}; };

View File

@@ -19,16 +19,10 @@ namespace BlackMisc
class CAngle : public CPhysicalQuantity<CAngleUnit, CAngle> class CAngle : public CPhysicalQuantity<CAngleUnit, CAngle>
{ {
public: public:
/*! //! Default constructor
* \brief Default constructor
*/
CAngle() : CPhysicalQuantity(0, CAngleUnit::defaultUnit()) {} CAngle() : CPhysicalQuantity(0, CAngleUnit::defaultUnit()) {}
/*! //! Init by double value
* \brief Init by double value
* \param value
* \param unit
*/
CAngle(double value, const CAngleUnit &unit): CPhysicalQuantity(value, unit) {} CAngle(double value, const CAngleUnit &unit): CPhysicalQuantity(value, unit) {}
/*! /*!
@@ -54,9 +48,7 @@ namespace BlackMisc
degrees + minutes / 100.0, degrees + minutes / 100.0,
CAngleUnit::sexagesimalDegMin()) {} CAngleUnit::sexagesimalDegMin()) {}
/*! //! \copydoc CValueObject::toQVariant
* \copydoc CValueObject::toQVariant
*/
virtual QVariant toQVariant() const override virtual QVariant toQVariant() const override
{ {
return QVariant::fromValue(*this); return QVariant::fromValue(*this);

View File

@@ -17,21 +17,14 @@ namespace BlackMisc
class CFrequency : public CPhysicalQuantity<CFrequencyUnit, CFrequency> class CFrequency : public CPhysicalQuantity<CFrequencyUnit, CFrequency>
{ {
public: public:
/*! //! Default constructor
* \brief Default constructor
*/
CFrequency() : CPhysicalQuantity(0, CFrequencyUnit::defaultUnit()) {} CFrequency() : CPhysicalQuantity(0, CFrequencyUnit::defaultUnit()) {}
/*! //! Init by double value
* \brief Init by double value
* \param value
* \param unit
*/
CFrequency(double value, const CFrequencyUnit &unit) : CPhysicalQuantity(value, unit) {} CFrequency(double value, const CFrequencyUnit &unit) : CPhysicalQuantity(value, unit) {}
/*!
* \copydoc CValueObject::toQVariant //! \copydoc CValueObject::toQVariant
*/
virtual QVariant toQVariant() const override virtual QVariant toQVariant() const override
{ {
return QVariant::fromValue(*this); return QVariant::fromValue(*this);

View File

@@ -12,35 +12,23 @@ namespace BlackMisc
namespace PhysicalQuantities namespace PhysicalQuantities
{ {
/*! //! Physical unit length (length)
* \brief Physical unit length (length)
*/
class CLength : public CPhysicalQuantity<CLengthUnit, CLength> class CLength : public CPhysicalQuantity<CLengthUnit, CLength>
{ {
public: public:
/*! //! Default constructor
* \brief Default constructor
*/
CLength() : CPhysicalQuantity(0, CLengthUnit::defaultUnit()) {} CLength() : CPhysicalQuantity(0, CLengthUnit::defaultUnit()) {}
/*! //! Init by double value
* \brief Init by double value
* \param value
* \param unit
*/
CLength(double value, const CLengthUnit &unit) : CPhysicalQuantity(value, unit) {} CLength(double value, const CLengthUnit &unit) : CPhysicalQuantity(value, unit) {}
/*! //! \copydoc CValueObject::toQVariant
* \copydoc CValueObject::toQVariant
*/
virtual QVariant toQVariant() const override virtual QVariant toQVariant() const override
{ {
return QVariant::fromValue(*this); return QVariant::fromValue(*this);
} }
/*! //! Virtual destructor
* \brief Virtual destructor
*/
virtual ~CLength() {} virtual ~CLength() {}
}; };

View File

@@ -18,29 +18,19 @@ namespace BlackMisc
class CMass : public CPhysicalQuantity<CMassUnit, CMass> class CMass : public CPhysicalQuantity<CMassUnit, CMass>
{ {
public: public:
/*! //! Default constructor
* \brief Default constructor
*/
CMass() : CPhysicalQuantity(0, CMassUnit::defaultUnit()) {} CMass() : CPhysicalQuantity(0, CMassUnit::defaultUnit()) {}
/*! //! Init by double value
* \brief Init by double value
* \param value
* \param unit
*/
CMass(double value, const CMassUnit &unit) : CPhysicalQuantity(value, unit) {} CMass(double value, const CMassUnit &unit) : CPhysicalQuantity(value, unit) {}
/*! //! \copydoc CValueObject::toQVariant
* \copydoc CValueObject::toQVariant
*/
virtual QVariant toQVariant() const override virtual QVariant toQVariant() const override
{ {
return QVariant::fromValue(*this); return QVariant::fromValue(*this);
} }
/*! //! Virtual destructor
* \brief Virtual destructor
*/
virtual ~CMass() {} virtual ~CMass() {}
}; };

View File

@@ -15,34 +15,22 @@ namespace BlackMisc
/*! /*!
* \brief Physical unit distance * \brief Physical unit distance
* \author KWB
*/ */
class CPressure : public CPhysicalQuantity<CPressureUnit, CPressure> class CPressure : public CPhysicalQuantity<CPressureUnit, CPressure>
{ {
public: public:
/*! //! Default constructor
* \brief Default constructor
*/
CPressure() : CPhysicalQuantity(0, CPressureUnit::defaultUnit()) {} CPressure() : CPhysicalQuantity(0, CPressureUnit::defaultUnit()) {}
/*! //! Init by double value
*\brief Init by double value
* \param value
* \param unit
*/
CPressure(double value, const CPressureUnit &unit) : CPhysicalQuantity(value, unit) {} CPressure(double value, const CPressureUnit &unit) : CPhysicalQuantity(value, unit) {}
/*!
* \copydoc CValueObject::toQVariant
*/
virtual QVariant toQVariant() const override virtual QVariant toQVariant() const override
{ {
return QVariant::fromValue(*this); return QVariant::fromValue(*this);
} }
/*! //! Virtual destructor
* \brief Virtual destructor
*/
virtual ~CPressure() {} virtual ~CPressure() {}
}; };

View File

@@ -19,29 +19,20 @@ namespace BlackMisc
{ {
public: public:
/*! //! Default constructor
* \brief Default constructor
*/
CSpeed() : CPhysicalQuantity(0, CSpeedUnit::defaultUnit()) {} CSpeed() : CPhysicalQuantity(0, CSpeedUnit::defaultUnit()) {}
/*! //! Init by double value
*\brief Init by double value
* \param value
* \param unit
*/
CSpeed(double value, const CSpeedUnit &unit) : CPhysicalQuantity(value, unit) {} CSpeed(double value, const CSpeedUnit &unit) : CPhysicalQuantity(value, unit) {}
/*!
* \copydoc CValueObject::toQVariant //! \copydoc CValueObject::toQVariant
*/
virtual QVariant toQVariant() const override virtual QVariant toQVariant() const override
{ {
return QVariant::fromValue(*this); return QVariant::fromValue(*this);
} }
/*! //! Destructor
* \brief Destructor
*/
virtual ~CSpeed() {} virtual ~CSpeed() {}
}; };

View File

@@ -21,8 +21,6 @@ namespace BlackMisc
*/ */
class CPqString : public BlackMisc::CValueObject class CPqString : public BlackMisc::CValueObject
{ {
public:
private: private:
BLACK_ENABLE_TUPLE_CONVERSION(CPqString) BLACK_ENABLE_TUPLE_CONVERSION(CPqString)
QString m_string; QString m_string;

View File

@@ -14,34 +14,21 @@ namespace BlackMisc
/*! /*!
* \brief Physical unit temperature * \brief Physical unit temperature
* \author KWB
*/ */
class CTemperature : public CPhysicalQuantity<CTemperatureUnit, CTemperature> class CTemperature : public CPhysicalQuantity<CTemperatureUnit, CTemperature>
{ {
public: public:
/*! //! Default constructor
* \brief Default constructor
*/
CTemperature() : CPhysicalQuantity(0, CTemperatureUnit::defaultUnit()) {} CTemperature() : CPhysicalQuantity(0, CTemperatureUnit::defaultUnit()) {}
/*! //! Init by double value
* \brief Init by double value
* \param value
* \param unit
*/
CTemperature(double value, const CTemperatureUnit &unit): CPhysicalQuantity(value, unit) {} CTemperature(double value, const CTemperatureUnit &unit): CPhysicalQuantity(value, unit) {}
/*!
* \copydoc CValueObject::toQVariant
*/
virtual QVariant toQVariant() const override
{
return QVariant::fromValue(*this);
}
/*! //! \copydoc CValueObject::toQVariant
* \brief Destructor virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); }
*/
//! Destructor
virtual ~CTemperature() {} virtual ~CTemperature() {}
}; };
@@ -50,4 +37,4 @@ namespace BlackMisc
Q_DECLARE_METATYPE(BlackMisc::PhysicalQuantities::CTemperature) Q_DECLARE_METATYPE(BlackMisc::PhysicalQuantities::CTemperature)
#endif // BLACKMISC_CTEMPERATURE_H #endif // guard

View File

@@ -28,8 +28,8 @@ namespace BlackMisc
//! By Qt time //! By Qt time
CTime(const QTime &time); CTime(const QTime &time);
//! By string hh:mm or hh:mm:ss //! \copydoc CPhysicalQuantity(const QString &unitString)
CTime(const QString &time); CTime(const QString &unitString) : CPhysicalQuantity(unitString) {}
//! \copydoc CValueObject::toQVariant //! \copydoc CValueObject::toQVariant
virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); } virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); }
@@ -37,8 +37,8 @@ namespace BlackMisc
//! Destructor //! Destructor
virtual ~CTime() {} virtual ~CTime() {}
//! From string hh:mm, or hh:mm:ss //! From string hh:mm, or hh:mm:ss, or time units such as s, min
void parseFromString(const QString &time); virtual void parseFromString(const QString &time) override;
//! To Qt time //! To Qt time
QTime toQTime() const; QTime toQTime() const;
@@ -50,4 +50,4 @@ namespace BlackMisc
Q_DECLARE_METATYPE(BlackMisc::PhysicalQuantities::CTime) Q_DECLARE_METATYPE(BlackMisc::PhysicalQuantities::CTime)
#endif // BLACKMISC_PQTIME_H #endif // guard