diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2018-05-11 17:22:11 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2018-05-16 12:45:29 +0000 |
commit | c53a723dbccb09896f714c3f246510a611c6cd77 (patch) | |
tree | 0316aa3d4aea2af1fb1031707900fc24cae90d5a | |
parent | 84558d51c9fe23a0e088960687265c62a6e1d676 (diff) |
Doc: Add an overview of Qt KNX datapoint type classes
Change-Id: If1be0c89fe85c2b39446ac81185a8d0655eb4726
Reviewed-by: Karsten Heimrich <karsten.heimrich@qt.io>
30 files changed, 249 insertions, 71 deletions
diff --git a/src/knx/doc/images/qtknx-datapoint-type-classes.png b/src/knx/doc/images/qtknx-datapoint-type-classes.png Binary files differnew file mode 100644 index 0000000..fd9538b --- /dev/null +++ b/src/knx/doc/images/qtknx-datapoint-type-classes.png diff --git a/src/knx/doc/src/datapoint_types.qdoc b/src/knx/doc/src/datapoint_types.qdoc new file mode 100644 index 0000000..c97ba11 --- /dev/null +++ b/src/knx/doc/src/datapoint_types.qdoc @@ -0,0 +1,78 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qtknx-datapoint-types.html + \title Qt KNX Datapoint Type Classes + \brief C++ classes for datapoint types. + + A datapoint type represents the data corresponding to a KNX device + functionality. It describes the data, setting the rules about the format + and values to be allowed, and it holds the bytes containing the data. + + A datapoint type is identified by its main number and a sub number. Each + main number corresponds to a datapoint type with a particular structure. + The sub numbers correspond to different interpretations or naming of this + structure. + + The Qt KNX module provides a class for each datapoint type with the main + number less than 30 and sub number less than 100. All datapoint types with + the same main number inherit from a datapoint type class representing the + main number datapoint type characteristics. + + Datapoint types are used in the \e data part of the \l QKnxTpdu class, which + is a part of a link layer frame (\l QKnxLinkLayerFrame) that is transmitted + over a tunneling connection (\l QKnxNetIpTunnel). + + \section1 Creating Datapoint Types + + \l QKnxDatapointType is the base class for all datapoint types. It is + inherited by two main datapoint type classes: \l QKnxFixedSizeDatapointType + for fixed length datapoint types and \l QKnxVariableSizeDatapointType for + variable length datapoint types. + + \l QKnxDatapointType::Type lists the datapoint types that have been + implemented in the Qt KNX module with short descriptions and their main and + sub numbers. Datapoint types described in the KNX documentation can be added + by creating a class that inherits from \l QKnxFixedSizeDatapointType or + \l QKnxVariableSizeDatapointType and registering this new class using an + instance of \l QKnxDatapointTypeFactory. + + The \l QKnxDatapointTypeFactory class is used to create datapoint types + based on their main number and sub number. One or more datapoints can be + registered with the factory and then queried based on the main number and + sub number. + + The following diagram shows the base Qt KNX module datapoint type classes + and the classes derived from them for the main datapoint types: + + \image qtknx-datapoint-type-classes.png + + \section1 List of Datapoint Type Classes + + \annotatedlist qtknx-datapoint-types +*/ diff --git a/src/knx/doc/src/index.qdoc b/src/knx/doc/src/index.qdoc index b567d8f..35d7632 100644 --- a/src/knx/doc/src/index.qdoc +++ b/src/knx/doc/src/index.qdoc @@ -71,6 +71,7 @@ \list \li \l{Qt KNX Device Management Classes}{Device Management Classes} \li \l{Qt KNX Tunneling Classes}{Tunneling Classes} + \li \l{Qt KNX Datapoint Type Classes}{Datapoint Type Classes} \li \l{Qt KNX C++ Classes}{All C++ Classes} \endlist diff --git a/src/knx/dpt/qknx1bit.cpp b/src/knx/dpt/qknx1bit.cpp index c2428fc..7e0f64c 100644 --- a/src/knx/dpt/qknx1bit.cpp +++ b/src/knx/dpt/qknx1bit.cpp @@ -36,6 +36,7 @@ QT_BEGIN_NAMESPACE \class QKnx1Bit \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnx1Bit class is a boolean datapoint type, such as switch on or off. @@ -83,7 +84,7 @@ QT_BEGIN_NAMESPACE The possible values for this datapoint type are \c true and \c false. - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ // -- QKnx1Bit diff --git a/src/knx/dpt/qknx1bitcontrolled.cpp b/src/knx/dpt/qknx1bitcontrolled.cpp index 0d4e192..b900ff1 100644 --- a/src/knx/dpt/qknx1bitcontrolled.cpp +++ b/src/knx/dpt/qknx1bitcontrolled.cpp @@ -37,6 +37,7 @@ QT_BEGIN_NAMESPACE \class QKnx1BitControlled \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnx1BitControlled class is a boolean datapoint type with a control part. @@ -65,7 +66,7 @@ QT_BEGIN_NAMESPACE \li \c QKnxSwitchControl \endlist - \sa QKnxDatapointType, QKnx1Bit + \sa QKnxDatapointType, QKnx1Bit, {Qt KNX Datapoint Type Classes} */ // -- QKnx1BitControlled diff --git a/src/knx/dpt/qknx1byte.cpp b/src/knx/dpt/qknx1byte.cpp index 8607a60..19e438d 100644 --- a/src/knx/dpt/qknx1byte.cpp +++ b/src/knx/dpt/qknx1byte.cpp @@ -36,13 +36,14 @@ QT_BEGIN_NAMESPACE \class QKnx1Byte \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnx1Byte class is a fixed size datapoint type with the length of 1 byte. This datapoint type encodes an absolute value between \c 0 and \c 255. - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ // -- QKnx1Byte @@ -107,6 +108,7 @@ bool QKnx1Byte::isValid() const \class QKnxScloMode \inherits QKnx1Byte \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxScloMode class is a datapoint type for storing the system clock (SCLO) mode. @@ -142,7 +144,7 @@ bool QKnx1Byte::isValid() const This is a fixed size datapoint type with the length of 1 byte. - \sa QKnxDatapointType, QKnx1Byte + \sa QKnxDatapointType, QKnx1Byte, {Qt KNX Datapoint Type Classes} */ /*! @@ -208,6 +210,7 @@ QKnxScloMode::Mode QKnxScloMode::mode() const \class QKnxBuildingMode \inherits QKnx1Byte \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxBuildingMode class is a datapoint type for storing the building mode. @@ -220,7 +223,7 @@ QKnxScloMode::Mode QKnxScloMode::mode() const This is a fixed size datapoint type with the length of 1 byte. - \sa QKnxDatapointType, QKnx1Byte + \sa QKnxDatapointType, QKnx1Byte, {Qt KNX Datapoint Type Classes} */ /*! @@ -287,6 +290,7 @@ QKnxBuildingMode::Mode QKnxBuildingMode::mode() const \class QKnxOccupyMode \inherits QKnx1Byte \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxOccupyMode class is a datapoint type for storing the occupy mode. @@ -297,7 +301,7 @@ QKnxBuildingMode::Mode QKnxBuildingMode::mode() const This is a fixed size datapoint type with the length of 1 byte. - \sa QKnxDatapointType, QKnx1Byte + \sa QKnxDatapointType, QKnx1Byte, {Qt KNX Datapoint Type Classes} */ /*! @@ -362,6 +366,7 @@ QKnxOccupyMode::Mode QKnxOccupyMode::mode() const \class QKnxPriority \inherits QKnx1Byte \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxPriority class is a datapoint type for storing priority. @@ -373,7 +378,7 @@ QKnxOccupyMode::Mode QKnxOccupyMode::mode() const This is a fixed size datapoint type with the length of 1 byte. - \sa QKnxDatapointType, QKnx1Byte + \sa QKnxDatapointType, QKnx1Byte, {Qt KNX Datapoint Type Classes} */ /*! @@ -440,6 +445,7 @@ QKnxPriority::Priority QKnxPriority::priority() const \class QKnxLightApplicationMode \inherits QKnx1Byte \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxLightApplicationMode class is a datapoint type for storing the light application mode. @@ -449,7 +455,7 @@ QKnxPriority::Priority QKnxPriority::priority() const This is a fixed size datapoint type with the length of 1 byte. - \sa QKnxDatapointType, QKnx1Byte + \sa QKnxDatapointType, QKnx1Byte, {Qt KNX Datapoint Type Classes} */ /*! @@ -514,6 +520,7 @@ QKnxLightApplicationMode::Mode QKnxLightApplicationMode::mode() const \class QKnxApplicationArea \inherits QKnx1Byte \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxApplicationArea class is a datapoint type for storing the application area. @@ -533,7 +540,7 @@ QKnxLightApplicationMode::Mode QKnxLightApplicationMode::mode() const This is a fixed size datapoint type with the length of 1 byte. \sa QKnxDatapointType, QKnx1Byte, QKnxErrorClassSystem::Error, - QKnxErrorClassHvac, QKnxScloMode::Mode + QKnxErrorClassHvac, QKnxScloMode::Mode, {Qt KNX Datapoint Type Classes} */ /*! @@ -657,6 +664,7 @@ bool QKnxApplicationArea::isValid() const \class QKnxAlarmClassType \inherits QKnx1Byte \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxAlarmClassType class is a datapoint type for storing the alarm class type. @@ -665,7 +673,7 @@ bool QKnxApplicationArea::isValid() const This is a fixed size datapoint type with the length of 1 byte. - \sa QKnxDatapointType, QKnx1Byte + \sa QKnxDatapointType, QKnx1Byte, {Qt KNX Datapoint Type Classes} */ /*! @@ -734,6 +742,7 @@ QKnxAlarmClassType::Type QKnxAlarmClassType::type() const \class QKnxPsuMode \inherits QKnx1Byte \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxPsuMode class is a datapoint type for storing the bus power supply unit mode. @@ -751,7 +760,7 @@ QKnxAlarmClassType::Type QKnxAlarmClassType::type() const This is a fixed size datapoint type with the length of 1 byte. - \sa QKnxDatapointType, QKnx1Byte + \sa QKnxDatapointType, QKnx1Byte, {Qt KNX Datapoint Type Classes} */ /*! @@ -818,6 +827,7 @@ QKnxPsuMode::Mode QKnxPsuMode::mode() const \class QKnxErrorClassSystem \inherits QKnx1Byte \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxErrorClassSystem class is a datapoint type for storing system errors. @@ -830,7 +840,8 @@ QKnxPsuMode::Mode QKnxPsuMode::mode() const This is a fixed size datapoint type with the length of 1 byte. - \sa QKnxDatapointType, QKnx1Byte, QKnxApplicationArea + \sa QKnxDatapointType, QKnx1Byte, QKnxApplicationArea, + {Qt KNX Datapoint Type Classes} */ /*! @@ -931,6 +942,7 @@ QKnxErrorClassSystem::Error QKnxErrorClassSystem::error() const \class QKnxErrorClassHvac \inherits QKnx1Byte \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxErrorClassHvac class is a datapoint type for storing errors in heating, ventilation, and air conditioning (HVAC). @@ -940,7 +952,8 @@ QKnxErrorClassSystem::Error QKnxErrorClassSystem::error() const This is a fixed size datapoint type with the length of 1 byte. - \sa QKnxDatapointType, QKnx1Byte, QKnxApplicationArea + \sa QKnxDatapointType, QKnx1Byte, QKnxApplicationArea, + {Qt KNX Datapoint Type Classes} */ /*! @@ -1010,6 +1023,7 @@ QKnxErrorClassHvac::Error QKnxErrorClassHvac::error() const \class QKnxTimeDelay \inherits QKnx1Byte \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxTimeDelay class is a datapoint type for storing a time delay. @@ -1018,7 +1032,7 @@ QKnxErrorClassHvac::Error QKnxErrorClassHvac::error() const This is a fixed size datapoint type with the length of 1 byte. - \sa QKnxDatapointType, QKnx1Byte + \sa QKnxDatapointType, QKnx1Byte, {Qt KNX Datapoint Type Classes} */ /*! @@ -1104,6 +1118,7 @@ QKnxTimeDelay::Delay QKnxTimeDelay::delay() const \class QKnxBeaufortWindForceScale \inherits QKnx1Byte \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxBeaufortWindForceScale class is a datapoint type for storing the Beaufort wind force scale. @@ -1113,7 +1128,7 @@ QKnxTimeDelay::Delay QKnxTimeDelay::delay() const This is a fixed size datapoint type with the length of 1 byte. - \sa QKnxDatapointType, QKnx1Byte + \sa QKnxDatapointType, QKnx1Byte, {Qt KNX Datapoint Type Classes} */ /*! @@ -1187,6 +1202,7 @@ QKnxBeaufortWindForceScale::Force QKnxBeaufortWindForceScale::force() const \class QKnxSensorSelect \inherits QKnx1Byte \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxSensorSelect class is a datapoint type for storing the sensor mode. @@ -1196,7 +1212,7 @@ QKnxBeaufortWindForceScale::Force QKnxBeaufortWindForceScale::force() const This is a fixed size datapoint type with the length of 1 byte. - \sa QKnxDatapointType, QKnx1Byte + \sa QKnxDatapointType, QKnx1Byte, {Qt KNX Datapoint Type Classes} */ /*! @@ -1265,6 +1281,7 @@ QKnxSensorSelect::Mode QKnxSensorSelect::mode() const \class QKnxActuatorConnectType \inherits QKnx1Byte \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxActuatorConnectType class is a datapoint type for storing the actuator connection type. @@ -1273,7 +1290,7 @@ QKnxSensorSelect::Mode QKnxSensorSelect::mode() const This is a fixed size datapoint type with the length of 1 byte. - \sa QKnxDatapointType, QKnx1Byte + \sa QKnxDatapointType, QKnx1Byte, {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknx2bitset.cpp b/src/knx/dpt/qknx2bitset.cpp index 859dc0b..0bd61ba 100644 --- a/src/knx/dpt/qknx2bitset.cpp +++ b/src/knx/dpt/qknx2bitset.cpp @@ -1,6 +1,6 @@ /****************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2018 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtKnx module. @@ -37,12 +37,15 @@ QT_BEGIN_NAMESPACE \class QKnx2BitSet \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnx2BitSet class is a fixed size datapoint type with the length of 2 bits. The range for the value is from \c 0x00 to \c 0x03. - \sa QKnxDatapointType, QKnxAlarmReaction, QKnxOnOffAction, QKnxUpDownAction + \sa QKnxDatapointType, QKnxAlarmReaction, QKnxOnOffAction, QKnxUpDownAction, + {Qt KNX Datapoint Type Classes} */ // -- QKnx2BitSet @@ -109,6 +112,8 @@ bool QKnx2BitSet::isValid() const \class QKnxOnOffAction \inherits QKnx2BitSet \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnxOnOffAction class is a fixed size datapoint type for storing the on/off action. @@ -117,7 +122,8 @@ bool QKnx2BitSet::isValid() const This is a fixed size datapoint type with the length of 2 bits. - \sa QKnxDatapointType, QKnxAlarmReaction, QKnxUpDownAction + \sa QKnxDatapointType, QKnxAlarmReaction, QKnxUpDownAction, + {Qt KNX Datapoint Type Classes} */ /*! @@ -173,6 +179,8 @@ QKnxOnOffAction::Action QKnxOnOffAction::action() const \class QKnxAlarmReaction \inherits QKnx2BitSet \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnxAlarmReaction class is a fixed size datapoint type for storing the alarm reaction. @@ -181,7 +189,8 @@ QKnxOnOffAction::Action QKnxOnOffAction::action() const This is a fixed size datapoint type with the length of 2 bits. - \sa QKnxDatapointType, QKnxOnOffAction, QKnxUpDownAction + \sa QKnxDatapointType, QKnxOnOffAction, QKnxUpDownAction, + {Qt KNX Datapoint Type Classes} */ /*! @@ -244,6 +253,8 @@ QKnxAlarmReaction::Alarm QKnxAlarmReaction::alarm() const \class QKnxUpDownAction \inherits QKnx2BitSet \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnxOnOffAction class is a fixed size datapoint type for storing the up/down action. @@ -252,7 +263,8 @@ QKnxAlarmReaction::Alarm QKnxAlarmReaction::alarm() const This is a fixed size datapoint type with the length of 2 bits. - \sa QKnxDatapointType, QKnxAlarmReaction, QKnxOnOffAction + \sa QKnxDatapointType, QKnxAlarmReaction, QKnxOnOffAction, + {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknx2bytefloat.cpp b/src/knx/dpt/qknx2bytefloat.cpp index 07d9a01..ed6a0ae 100644 --- a/src/knx/dpt/qknx2bytefloat.cpp +++ b/src/knx/dpt/qknx2bytefloat.cpp @@ -1,6 +1,6 @@ /****************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2018 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtKnx module. @@ -39,6 +39,7 @@ QT_BEGIN_NAMESPACE \class QKnx2ByteFloat \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnx2ByteFloat class is a datapoint type for a 2-byte float value. @@ -147,7 +148,7 @@ QT_BEGIN_NAMESPACE \li 0 - 670760.96 \endtable - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknx2bytesignedvalue.cpp b/src/knx/dpt/qknx2bytesignedvalue.cpp index 7b4e67b..b6602c6 100644 --- a/src/knx/dpt/qknx2bytesignedvalue.cpp +++ b/src/knx/dpt/qknx2bytesignedvalue.cpp @@ -1,6 +1,6 @@ /****************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2018 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtKnx module. @@ -38,6 +38,7 @@ QT_BEGIN_NAMESPACE \class QKnx2ByteSignedValue \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnx2ByteSignedValue class is a datapoint type with a 2-byte signed value. @@ -65,7 +66,7 @@ QT_BEGIN_NAMESPACE Integer values from -32 768 to 32 767 can be encoded in this datapoint type. - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknx2byteunsignedvalue.cpp b/src/knx/dpt/qknx2byteunsignedvalue.cpp index 4bc92d4..de39303 100644 --- a/src/knx/dpt/qknx2byteunsignedvalue.cpp +++ b/src/knx/dpt/qknx2byteunsignedvalue.cpp @@ -37,6 +37,7 @@ QT_BEGIN_NAMESPACE \class QKnx2ByteUnsignedValue \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnx2ByteUnsignedValue class is a datapoint type with a 2-byte unsigned value. @@ -69,7 +70,7 @@ QT_BEGIN_NAMESPACE Integer values from 0 to 65 535 can be encoded in this datapoint type. - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ diff --git a/src/knx/dpt/qknx32bitset.cpp b/src/knx/dpt/qknx32bitset.cpp index 89193f7..0681e61 100644 --- a/src/knx/dpt/qknx32bitset.cpp +++ b/src/knx/dpt/qknx32bitset.cpp @@ -1,6 +1,6 @@ /****************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2018 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtKnx module. @@ -37,6 +37,7 @@ QT_BEGIN_NAMESPACE \class QKnx32BitSet \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnx32BitSet class is a datapoint type with the 32-bit set. @@ -47,7 +48,7 @@ QT_BEGIN_NAMESPACE There is only one class inheriting QKnx32BitSet: \l QKnxCombinedInfoOnOff. - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ // -- QKnx32BitSet @@ -103,6 +104,7 @@ bool QKnx32BitSet::setValue(quint32 value) \class QKnxCombinedInfoOnOff \inherits QKnx32BitSet \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxCombinedInfoOnOff class is a datapoint type for storing combined information about the on and off states of a multiple-channel @@ -118,7 +120,7 @@ bool QKnx32BitSet::setValue(quint32 value) This is a fixed size datapoint type with the length of 4 bytes. - \sa QKnx32BitSet, QKnxDatapointType + \sa QKnx32BitSet, QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknx3bitcontrolled.cpp b/src/knx/dpt/qknx3bitcontrolled.cpp index 9a799ac..1f4d6c9 100644 --- a/src/knx/dpt/qknx3bitcontrolled.cpp +++ b/src/knx/dpt/qknx3bitcontrolled.cpp @@ -37,6 +37,7 @@ QT_BEGIN_NAMESPACE \class QKnx3BitControlled \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnx3BitControlled class is a datapoint type with a control part. @@ -50,7 +51,7 @@ QT_BEGIN_NAMESPACE To set this datapoint type, the control and the NumberOfIntervals have to be set. - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! @@ -159,6 +160,7 @@ bool QKnx3BitControlled::isValid() const \class QKnxControlDimming \inherits QKnx3BitControlled \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxControlDimming class is a datapoint type for controlling dimming. @@ -166,7 +168,7 @@ bool QKnx3BitControlled::isValid() const To set this datapoint type, \l{QKnxControlDimming::}{Control} and \l{QKnx3BitControlled::}{NumberOfIntervals} have to be set. - \sa QKnx3BitControlled + \sa QKnx3BitControlled, {Qt KNX Datapoint Type Classes} */ /*! @@ -220,6 +222,7 @@ QKnxControlDimming::Control QKnxControlDimming::control() const \class QKnxControlBlinds \inherits QKnx3BitControlled \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxControlBlinds class is a datapoint type for controlling blinds. @@ -227,7 +230,7 @@ QKnxControlDimming::Control QKnxControlDimming::control() const To set this datapoint type, \l{QKnxControlBlinds::}{Control} and \l{QKnx3BitControlled::}{NumberOfIntervals} have to be set. - \sa QKnx3BitControlled + \sa QKnx3BitControlled, {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknx4bytefloat.cpp b/src/knx/dpt/qknx4bytefloat.cpp index 1eb6956..2d239ea 100644 --- a/src/knx/dpt/qknx4bytefloat.cpp +++ b/src/knx/dpt/qknx4bytefloat.cpp @@ -38,6 +38,7 @@ QT_BEGIN_NAMESPACE \class QKnx4ByteFloat \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnx4ByteFloat class is datapoint type for a 4-byte float value. @@ -133,7 +134,7 @@ QT_BEGIN_NAMESPACE \li \c QKnxValueWork - Work in J. \endlist - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknx4bytesignedvalue.cpp b/src/knx/dpt/qknx4bytesignedvalue.cpp index e19dced..09d9d0c 100644 --- a/src/knx/dpt/qknx4bytesignedvalue.cpp +++ b/src/knx/dpt/qknx4bytesignedvalue.cpp @@ -62,7 +62,7 @@ QT_BEGIN_NAMESPACE \li \c QKnxValue4Count - Counter pulses (signed). \endlist - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknx4byteunsignedvalue.cpp b/src/knx/dpt/qknx4byteunsignedvalue.cpp index ef6a3e9..56d2e55 100644 --- a/src/knx/dpt/qknx4byteunsignedvalue.cpp +++ b/src/knx/dpt/qknx4byteunsignedvalue.cpp @@ -1,6 +1,6 @@ /****************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2018 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtKnx module. @@ -38,6 +38,7 @@ QT_BEGIN_NAMESPACE \class QKnx4ByteUnsignedValue \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnx4ByteUnsignedValue class is a datapoint type with a 4-byte unsigned value. @@ -47,7 +48,7 @@ QT_BEGIN_NAMESPACE Integer values from 0 to 4 294 967 295 can be encoded in this datapoint type. - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! @@ -81,13 +82,15 @@ QKnx4ByteUnsignedValue::QKnx4ByteUnsignedValue(int subType, quint32 value) \class QKnxValue4UCount \inherits QKnx4ByteUnsignedValue \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxValue4UCount class is a datapoint type with a 4-byte unsigned value. This is a fixed size datapoint type with the length of 4 bytes. - \sa QKnx4ByteUnsignedValue, QKnxDatapointType + \sa QKnx4ByteUnsignedValue, QKnxDatapointType, + {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknx8bitset.cpp b/src/knx/dpt/qknx8bitset.cpp index 27a88c2..e268aea 100644 --- a/src/knx/dpt/qknx8bitset.cpp +++ b/src/knx/dpt/qknx8bitset.cpp @@ -36,6 +36,8 @@ QT_BEGIN_NAMESPACE \class QKnx8BitSet \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnx8BitSet class is a datapoint type with binary-coded values in all fields. @@ -45,7 +47,7 @@ QT_BEGIN_NAMESPACE The possible values are: \c{No bits set} (\c 0x00) and \c{All bits set} (\c 0xff). - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ // -- QKnx8BitSet @@ -129,6 +131,8 @@ bool QKnx8BitSet::isValid() const \class QKnxGeneralStatus \inherits QKnx8BitSet \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnxGeneralStatus class is a datapoint type for general status. This is a fixed size datapoint type with the length of 1 byte. @@ -136,7 +140,7 @@ bool QKnx8BitSet::isValid() const The possible values are combinations of the attributes specified by QKnxGeneralStatus::Attribute. - \sa QKnx8BitSet, QKnxDatapointType + \sa QKnx8BitSet, QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! @@ -235,6 +239,8 @@ bool QKnxGeneralStatus::removeAttribute(Attribute attribute) \class QKnxDeviceControl \inherits QKnx8BitSet \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnxDeviceControl class is a datapoint type for device control. This is a fixed size datapoint type with the length of 1 byte. @@ -242,7 +248,7 @@ bool QKnxGeneralStatus::removeAttribute(Attribute attribute) The possible values are combinations of the attributes specified by QKnxGeneralStatus::Attribute. - \sa QKnx8BitSet, QKnxDatapointType + \sa QKnx8BitSet, QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknx8bitsignedvalue.cpp b/src/knx/dpt/qknx8bitsignedvalue.cpp index 6494a64..358873d 100644 --- a/src/knx/dpt/qknx8bitsignedvalue.cpp +++ b/src/knx/dpt/qknx8bitsignedvalue.cpp @@ -1,6 +1,6 @@ /****************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2018 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtKnx module. @@ -36,6 +36,8 @@ QT_BEGIN_NAMESPACE \class QKnx8BitSignedValue \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnx8BitSignedValue class is a datapoint type with an 8-bit signed value. @@ -50,7 +52,7 @@ QT_BEGIN_NAMESPACE \li \c QKnxValue1Count - Counter pulses. \endlist - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ // -- QKnx8BitSignedValue diff --git a/src/knx/dpt/qknx8bitunsignedvalue.cpp b/src/knx/dpt/qknx8bitunsignedvalue.cpp index b4742e4..0ea1b58 100644 --- a/src/knx/dpt/qknx8bitunsignedvalue.cpp +++ b/src/knx/dpt/qknx8bitunsignedvalue.cpp @@ -1,6 +1,6 @@ /****************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2018 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtKnx module. @@ -36,6 +36,8 @@ QT_BEGIN_NAMESPACE \class QKnx8BitUnsignedValue \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnx8BitUnsignedValue class is a datapoint type with an 8-bit unsigned value. @@ -54,7 +56,7 @@ QT_BEGIN_NAMESPACE \li \c QKnxTariff - Tariff from 0 to 254. \endlist - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ // -- QKnx8BitUnsignedValue diff --git a/src/knx/dpt/qknxchar.cpp b/src/knx/dpt/qknxchar.cpp index e6006e9..15ad4e9 100644 --- a/src/knx/dpt/qknxchar.cpp +++ b/src/knx/dpt/qknxchar.cpp @@ -36,6 +36,7 @@ QT_BEGIN_NAMESPACE \class QKnxChar \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxChar class is a datapoint type that encodes a character. @@ -46,7 +47,7 @@ QT_BEGIN_NAMESPACE The range for the value is from \c 0 to \c 255. - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ // -- QKnxChar @@ -114,13 +115,14 @@ bool QKnxChar::isValid() const \class QKnxCharASCII \inherits QKnxChar \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxCharASCII class is a datapoint type that encodes an ASCII character. This is a fixed size datapoint type with the length of 1 byte. - \sa QKnxChar, QKnxDatapointType + \sa QKnxChar, QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! @@ -167,13 +169,14 @@ bool QKnxCharASCII::setCharacter(char value) \class QKnxChar88591 \inherits QKnxChar \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxChar88591 class is a datapoint type that encodes an ISO 8859-1 character. This is a fixed size datapoint type with the length of 1 byte. - \sa QKnxChar, QKnxDatapointType + \sa QKnxChar, QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknxcharstring.cpp b/src/knx/dpt/qknxcharstring.cpp index 5a11945..fc3d3be 100644 --- a/src/knx/dpt/qknxcharstring.cpp +++ b/src/knx/dpt/qknxcharstring.cpp @@ -36,6 +36,7 @@ QT_BEGIN_NAMESPACE \class QKnxCharString \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxCharString class is a datapoint type that encodes a string. @@ -46,7 +47,8 @@ QT_BEGIN_NAMESPACE The range for the string size is from \c 0 to \c 14. - \sa QKnxDatapointType, QKnxVarString, QKnxVarString88591 + \sa QKnxDatapointType, QKnxVarString, QKnxVarString88591, + {Qt KNX Datapoint Type Classes} */ // -- QKnxCharString @@ -156,6 +158,7 @@ bool QKnxCharString::isValid() const \class QKnxCharStringASCII \inherits QKnxCharString \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxCharStringASCII class is a datapoint type that encodes a string of ASCII characters. @@ -164,7 +167,7 @@ bool QKnxCharString::isValid() const This is a fixed size datapoint type with the length of 14 bytes. - \sa QKnxChar, QKnxDatapointType + \sa QKnxChar, QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! @@ -201,6 +204,7 @@ QKnxCharStringASCII::QKnxCharStringASCII(const char *string, int size) \class QKnxCharString88591 \inherits QKnxChar \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxCharString88591 class is a datapoint type that encodes a string of ISO 8859-1 characters. @@ -209,7 +213,7 @@ QKnxCharStringASCII::QKnxCharStringASCII(const char *string, int size) This is a fixed size datapoint type with the length of 14 bytes. - \sa QKnxChar, QKnxDatapointType + \sa QKnxChar, QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknxdatapointtype.cpp b/src/knx/dpt/qknxdatapointtype.cpp index 8b506eb..848eb06 100644 --- a/src/knx/dpt/qknxdatapointtype.cpp +++ b/src/knx/dpt/qknxdatapointtype.cpp @@ -1,6 +1,6 @@ /****************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2018 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtKnx module. @@ -36,6 +36,8 @@ QT_BEGIN_NAMESPACE \class QKnxDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnxDatapointType class is a base class for datapoint types with specific properties. @@ -80,6 +82,8 @@ QT_BEGIN_NAMESPACE factory.registerType<MyNewDataPointType>(mainType, subType, typeSize); } \endcode + + \sa {Qt KNX Datapoint Type Classes} */ /*! @@ -638,6 +642,7 @@ QT_BEGIN_NAMESPACE \class QKnxFixedSizeDatapointType \inherits QKnxDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxFixedSizeDatapointType class is a base class for datapoint types with a fixed size. @@ -649,6 +654,7 @@ QT_BEGIN_NAMESPACE \class QKnxVariableSizeDatapointType \inherits QKnxDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxVariableSizeDatapointType is a base class for datapoint types with a variable size. diff --git a/src/knx/dpt/qknxdatapointtypefactory.cpp b/src/knx/dpt/qknxdatapointtypefactory.cpp index 7113e2d..b496bff 100644 --- a/src/knx/dpt/qknxdatapointtypefactory.cpp +++ b/src/knx/dpt/qknxdatapointtypefactory.cpp @@ -61,6 +61,8 @@ QT_BEGIN_NAMESPACE \class QKnxDatapointTypeFactory \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnxDatapointTypeFactory class is used to create \l QKnxDatapointType objects based on their main number and sub number. @@ -73,6 +75,8 @@ QT_BEGIN_NAMESPACE The KNX datapoint types are identified by a 16-bit main number and a 16-bit sub number. + + \sa {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknxdatetime.cpp b/src/knx/dpt/qknxdatetime.cpp index f9b3ed9..f12087a 100644 --- a/src/knx/dpt/qknxdatetime.cpp +++ b/src/knx/dpt/qknxdatetime.cpp @@ -1,6 +1,6 @@ /****************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2018 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtKnx module. @@ -36,6 +36,7 @@ QT_BEGIN_NAMESPACE \class QKnxTimeOfDay \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxTimeOfDay class is a datapoint type for the time of day. @@ -47,7 +48,7 @@ QT_BEGIN_NAMESPACE Valid times of day are from \c {No day, 00:00:00} to \c {Sunday, 23:59:59}. - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ // -- QKnxTimeOfDay @@ -202,6 +203,7 @@ bool QKnxTimeOfDay::isValid() const \class QKnxDate \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxDate class is a datapoint type for a date. @@ -212,7 +214,7 @@ bool QKnxTimeOfDay::isValid() const Valid dates are from \c {Monday, 1990-01-01} to \c {Saturday, 2089-12-31}. - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ // -- QKnxDate @@ -349,6 +351,7 @@ bool QKnxDate::isValid() const \class QKnxDateTime \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxDateTime class is a datapoint type for the date and time. @@ -357,7 +360,7 @@ bool QKnxDate::isValid() const Valid dates are from \c {Monday, 1900-01-01} to \c {Wednesday, 2155-12-31}, and valid times are from \c {Any day, 00:00:00} to \c {Sunday, 24:00:00}. - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknxelectricalenergy.cpp b/src/knx/dpt/qknxelectricalenergy.cpp index ddcf1d1..657da89 100644 --- a/src/knx/dpt/qknxelectricalenergy.cpp +++ b/src/knx/dpt/qknxelectricalenergy.cpp @@ -1,6 +1,6 @@ /****************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2018 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtKnx module. @@ -38,6 +38,7 @@ QT_BEGIN_NAMESPACE \class QKnxElectricalEnergy \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QKnxElectricalEnergy class is a datapoint type for electrical energy. @@ -55,7 +56,7 @@ QT_BEGIN_NAMESPACE The range for the value is from \c {-9 223 372 036 854 775 808} to \c {9 223 372 036 854 775 807}. - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknxentranceaccess.cpp b/src/knx/dpt/qknxentranceaccess.cpp index f1f58ea..9fd176e 100644 --- a/src/knx/dpt/qknxentranceaccess.cpp +++ b/src/knx/dpt/qknxentranceaccess.cpp @@ -37,6 +37,8 @@ QT_BEGIN_NAMESPACE \class QKnxEntranceAccess \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnxEntranceAccess is a datapoint type for controlling entrance access. @@ -53,7 +55,7 @@ QT_BEGIN_NAMESPACE The range of the value is from \c {Low Code, 0 0 0 0 0 0} to \c {High Code, 9 9 9 9 9 9}. - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknxscene.cpp b/src/knx/dpt/qknxscene.cpp index 961b7aa..be11030 100644 --- a/src/knx/dpt/qknxscene.cpp +++ b/src/knx/dpt/qknxscene.cpp @@ -36,19 +36,24 @@ QT_BEGIN_NAMESPACE \class QKnxSceneNumber \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnxSceneNumber class is a datapoint type for a scene number. This is a fixed size datapoint type with the length of 1 byte. The minimum scene number is \c 0 and the maximum scene number is \c 63. - \sa QKnxDatapointType, QKnxSceneControl, QKnxSceneInfo + \sa QKnxDatapointType, QKnxSceneControl, QKnxSceneInfo, + {Qt KNX Datapoint Type Classes} */ /*! \class QKnxSceneControl \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnxSceneControl class is a datapoint type for a scene control. This is a fixed size datapoint type with the length of 1 byte. @@ -56,7 +61,8 @@ QT_BEGIN_NAMESPACE A scene control can be used to activate or learn the corresponding scene number. The range for scene numbers is from \c 0 to \c 63. - \sa Control, QKnxDatapointType, QKnxSceneNumber, QKnxSceneInfo + \sa Control, QKnxDatapointType, QKnxSceneNumber, QKnxSceneInfo, + {Qt KNX Datapoint Type Classes} */ /*! @@ -74,6 +80,8 @@ QT_BEGIN_NAMESPACE \class QKnxSceneInfo \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnxSceneInfo class is a datapoint type for scene information. This is a fixed size datapoint type with the length of 1 byte. @@ -81,7 +89,8 @@ QT_BEGIN_NAMESPACE The scene information holds the activity state of the corresponding scene number. The range for scene numbers is from \c 0 to \c 63. - \sa Info, QKnxDatapointType, QKnxSceneNumber, QKnxSceneControl + \sa Info, QKnxDatapointType, QKnxSceneNumber, QKnxSceneControl, + {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknxstatusmode3.cpp b/src/knx/dpt/qknxstatusmode3.cpp index f7c30e6..15b8b6d 100644 --- a/src/knx/dpt/qknxstatusmode3.cpp +++ b/src/knx/dpt/qknxstatusmode3.cpp @@ -36,6 +36,8 @@ QT_BEGIN_NAMESPACE \class QKnxStatusMode3 \inherits QKnxFixedSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnxStatusMode3 class is a datapoint type for a status mode 3. This datapoint type holds information about which \l{Status}{status} flags @@ -45,7 +47,7 @@ QT_BEGIN_NAMESPACE This is a fixed size datapoint type with the length of 1 byte. - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknxtime.cpp b/src/knx/dpt/qknxtime.cpp index 4260c7a..1bb6e3e 100644 --- a/src/knx/dpt/qknxtime.cpp +++ b/src/knx/dpt/qknxtime.cpp @@ -35,11 +35,13 @@ QT_BEGIN_NAMESPACE \class QKnxTimeBase \inmodule QtKnx + \ingroup qtknx-datapoint-types + \inherits QAbstractKnxTime \brief The QKnxTimeBase class is a base class for datapoint types that contain time information. - \sa QKnxTime, QKnxTime24 + \sa QKnxTime, QKnxTime24, {Qt KNX Datapoint Type Classes} */ /*! @@ -59,11 +61,12 @@ QT_BEGIN_NAMESPACE \class QAbstractKnxTime \inmodule QtKnx + \ingroup qtknx-datapoint-types \brief The QAbstractKnxTime class is an abstract base class for datapoint types that contain time information. - \sa QKnxTimeBase + \sa QKnxTimeBase, {Qt KNX Datapoint Type Classes} */ /*! @@ -214,23 +217,27 @@ QT_BEGIN_NAMESPACE \class QKnxTime \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnxTime class holds time information. Hour values must be less than \c 24. Minute and second values must be less than \c 59. - \sa QKnxTimeBase, QKnxTime24 + \sa QKnxTimeBase, QKnxTime24, {Qt KNX Datapoint Type Classes} */ /*! \class QKnxTime24 \inmodule QtKnx + \ingroup qtknx-datapoint-types + \brief The QKnxTime24 class holds time information. Hour values can be up to \c 24. Minute and second values can be up to \c 59. - \sa QKnxTimeBase, QKnxTime + \sa QKnxTimeBase, QKnxTime, {Qt KNX Datapoint Type Classes} */ QAbstractKnxTime::~QAbstractKnxTime() diff --git a/src/knx/dpt/qknxutf8string.cpp b/src/knx/dpt/qknxutf8string.cpp index a5f394f..30edb73 100644 --- a/src/knx/dpt/qknxutf8string.cpp +++ b/src/knx/dpt/qknxutf8string.cpp @@ -37,6 +37,7 @@ QT_BEGIN_NAMESPACE \class QKnxUtf8String \inherits QKnxVariableSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \since 5.11 \brief The QKnxUtf8String class is a datapoint type for a UTF-8 string. @@ -47,7 +48,7 @@ QT_BEGIN_NAMESPACE This is a variable sized datapoint type. - \sa QKnxDatapointType, QKnxUtf8 + \sa QKnxDatapointType, QKnxUtf8, {Qt KNX Datapoint Type Classes} */ // -- QKnxUtf8String @@ -159,6 +160,7 @@ bool QKnxUtf8String::isValid() const \class QKnxUtf8 \inherits QKnxUtf8String \inmodule QtKnx + \ingroup qtknx-datapoint-types \since 5.11 \brief The QKnxUtf8 class is a datapoint type for a UTF-8 string. @@ -169,7 +171,7 @@ bool QKnxUtf8String::isValid() const This is a variable sized datapoint type. - \sa QKnxDatapointType, QKnxUtf8String + \sa QKnxDatapointType, QKnxUtf8String, {Qt KNX Datapoint Type Classes} */ /*! diff --git a/src/knx/dpt/qknxvarstring.cpp b/src/knx/dpt/qknxvarstring.cpp index 448e399..9c2fe7b 100644 --- a/src/knx/dpt/qknxvarstring.cpp +++ b/src/knx/dpt/qknxvarstring.cpp @@ -36,6 +36,7 @@ QT_BEGIN_NAMESPACE \class QKnxVarString \inherits QKnxVariableSizeDatapointType \inmodule QtKnx + \ingroup qtknx-datapoint-types \since 5.11 \brief The QKnxVarString class is a datapoint type that encodes a variable @@ -47,7 +48,8 @@ QT_BEGIN_NAMESPACE This is a variable sized datapoint type. \sa QKnxDatapointType, QKnxVarString88591, QKnxCharString, - QKnxCharStringASCII, QKnxCharString88591 + QKnxCharStringASCII, QKnxCharString88591, + {Qt KNX Datapoint Type Classes} */ // -- QKnxVarString @@ -142,6 +144,7 @@ bool QKnxVarString::isValid() const \class QKnxVarString88591 \inherits QKnxVarString \inmodule QtKnx + \ingroup qtknx-datapoint-types \since 5.11 \brief The QKnxVarString88591 class is a datapoint type that encodes a @@ -149,7 +152,7 @@ bool QKnxVarString::isValid() const This is a variable sized datapoint type. - \sa QKnxDatapointType + \sa QKnxDatapointType, {Qt KNX Datapoint Type Classes} */ /*! |