summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2018-05-18 13:56:37 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2018-05-24 11:27:18 +0000
commit6fb1bc4153da572387c375a6ead7b8c6eb5b0523 (patch)
treeb68e36d34c0eb52431685169a378a661f9627472
parentc53a723dbccb09896f714c3f246510a611c6cd77 (diff)
Doc: List general classes
Change-Id: I8d1a17547943fb12d200700e1fd07aa68e0f8269 Reviewed-by: Andrew O'Doherty <andrew.odoherty@qt.io> Reviewed-by: Karsten Heimrich <karsten.heimrich@qt.io>
-rw-r--r--src/knx/core/qknxbytearray.cpp2
-rw-r--r--src/knx/doc/src/index.qdoc1
-rw-r--r--src/knx/knxproj/qknxgroupaddressinfo.cpp2
-rw-r--r--src/knx/knxproj/qknxgroupaddressinfos.cpp2
-rw-r--r--src/knx/qknxadditionalinfo.cpp2
-rw-r--r--src/knx/qknxaddress.cpp2
-rw-r--r--src/knx/qknxcontrolfield.cpp2
-rw-r--r--src/knx/qknxextendedcontrolfield.cpp2
8 files changed, 15 insertions, 0 deletions
diff --git a/src/knx/core/qknxbytearray.cpp b/src/knx/core/qknxbytearray.cpp
index a8cfee1..6a573d6 100644
--- a/src/knx/core/qknxbytearray.cpp
+++ b/src/knx/core/qknxbytearray.cpp
@@ -47,6 +47,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QKnxByteArray
\inmodule QtKnx
+ \ingroup qtknx-general-classes
+
\brief The QKnxByteArray class provides an array of unsigned bytes.
A KNX byte array can be used to store both raw bytes (including the string
diff --git a/src/knx/doc/src/index.qdoc b/src/knx/doc/src/index.qdoc
index 35d7632..496d471 100644
--- a/src/knx/doc/src/index.qdoc
+++ b/src/knx/doc/src/index.qdoc
@@ -72,6 +72,7 @@
\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 General Classes}{General Classes}
\li \l{Qt KNX C++ Classes}{All C++ Classes}
\endlist
diff --git a/src/knx/knxproj/qknxgroupaddressinfo.cpp b/src/knx/knxproj/qknxgroupaddressinfo.cpp
index 3e2b5c7..d2b382c 100644
--- a/src/knx/knxproj/qknxgroupaddressinfo.cpp
+++ b/src/knx/knxproj/qknxgroupaddressinfo.cpp
@@ -50,6 +50,8 @@ public:
\class QKnxGroupAddressInfo
\inmodule QtKnx
+ \ingroup qtknx-general-classes
+
\brief The QKnxGroupAddressInfo class contains information about a single
KNX group address object used inside a KNX installation.
diff --git a/src/knx/knxproj/qknxgroupaddressinfos.cpp b/src/knx/knxproj/qknxgroupaddressinfos.cpp
index 092991e..e9aa764 100644
--- a/src/knx/knxproj/qknxgroupaddressinfos.cpp
+++ b/src/knx/knxproj/qknxgroupaddressinfos.cpp
@@ -170,6 +170,8 @@ QVector<QKnxGroupAddressInfo>
\class QKnxGroupAddressInfos
\inmodule QtKnx
+ \ingroup qtknx-general-classes
+
\brief The QKnxGroupAddressInfos class provides access to information about
group addresses used inside a KNX project.
diff --git a/src/knx/qknxadditionalinfo.cpp b/src/knx/qknxadditionalinfo.cpp
index 9494f29..6226313 100644
--- a/src/knx/qknxadditionalinfo.cpp
+++ b/src/knx/qknxadditionalinfo.cpp
@@ -38,6 +38,8 @@ QT_BEGIN_NAMESPACE
\class QKnxAdditionalInfo
\inmodule QtKnx
+ \ingroup qtknx-general-classes
+
\brief The QKnxAdditionalInfo class represents the additional information
that can be placed inside a KNX cEMI frame.
diff --git a/src/knx/qknxaddress.cpp b/src/knx/qknxaddress.cpp
index 9f57a1c..a2509ac 100644
--- a/src/knx/qknxaddress.cpp
+++ b/src/knx/qknxaddress.cpp
@@ -35,6 +35,8 @@ QT_BEGIN_NAMESPACE
\class QKnxAddress
\inmodule QtKnx
+ \ingroup qtknx-general-classes
+
\brief The QKnxAddress class represents a 16-bit KNX address value.
KNX is a fully distributed network, which accommodates up to 65,536 devices
diff --git a/src/knx/qknxcontrolfield.cpp b/src/knx/qknxcontrolfield.cpp
index 1f0f47c..6a10ad3 100644
--- a/src/knx/qknxcontrolfield.cpp
+++ b/src/knx/qknxcontrolfield.cpp
@@ -37,6 +37,8 @@ const std::bitset<8> gPriorityMask = 0x0c;
\class QKnxControlField
\inmodule QtKnx
+ \ingroup qtknx-general-classes
+
\brief The QKnxControlField class represents an 8-bit KNX control field.
A KNX frame contains several fields, one of which might be the control
diff --git a/src/knx/qknxextendedcontrolfield.cpp b/src/knx/qknxextendedcontrolfield.cpp
index f3bb004..95b9afe 100644
--- a/src/knx/qknxextendedcontrolfield.cpp
+++ b/src/knx/qknxextendedcontrolfield.cpp
@@ -37,6 +37,8 @@ const std::bitset<8> gHopCountMask = 0x70;
\class QKnxExtendedControlField
\inmodule QtKnx
+ \ingroup qtknx-general-classes
+
\brief The QKnxExtendedControlField class represents an 8-bit extended KNX
control field.