summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKarsten Heimrich <karsten.heimrich@qt.io>2018-05-03 10:51:27 +0200
committerKarsten Heimrich <karsten.heimrich@qt.io>2018-05-03 09:57:21 +0000
commit603b1815b4a0d2a8aede7f49287015b0be20aa24 (patch)
tree833ed0e50a45b80d4661873d036bd5584f244666
parent1faec219bcf119801e7f149fa95b58a5ee44d6d1 (diff)
Doc: Add docs for QKnxServiceInfo, edit QKnxNetIpServiceFamiliesDibProxyv5.11.0-rc1
Change-Id: Ie930bdb7b2fdf310b2d9a1df22015c2d311f3da5 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
-rw-r--r--src/knx/netip/qknxnetipservicefamiliesdib.cpp39
1 files changed, 35 insertions, 4 deletions
diff --git a/src/knx/netip/qknxnetipservicefamiliesdib.cpp b/src/knx/netip/qknxnetipservicefamiliesdib.cpp
index 2a7b7c1..ea67af3 100644
--- a/src/knx/netip/qknxnetipservicefamiliesdib.cpp
+++ b/src/knx/netip/qknxnetipservicefamiliesdib.cpp
@@ -34,6 +34,37 @@
QT_BEGIN_NAMESPACE
/*!
+ \inmodule QtKnx
+ \class QKnxServiceInfo
+
+ \brief The QKnxServiceInfo class contains the supported service and the
+ corresponding service family version.
+
+ The service family is the high octet of the service type ID and the service
+ family version is an integer representing the service family version. It
+ refers to the version of the corresponding KNXnet/IP document, not to the
+ manufacturer's implemented version.
+
+ \sa QKnxNetIpServiceFamiliesDibProxy
+*/
+
+/*!
+ \variable QKnxServiceInfo::ServiceFamily
+
+ The service family is the high octet of the service type ID.
+
+ \sa QKnx::NetIp::ServiceType, QKnx::NetIp::ServiceFamily
+*/
+
+/*!
+ \variable QKnxServiceInfo::ServiceFamilyVersion
+
+ The service family version is an integer representing the service family
+ version. It refers to the version of the corresponding KNXnet/IP document,
+ not to the manufacturer's implemented version.
+*/
+
+/*!
\class QKnxNetIpServiceFamiliesDibProxy
\inmodule QtKnx
@@ -44,10 +75,10 @@ QT_BEGIN_NAMESPACE
A KNXnet/IP supported service families DIB structure contains a set of
supported services and their corresponding versions. The service family is
- the high octet of the service type ID and the version of a service family
- refers to the version of the corresponding KNXnet/IP document. The service
- family version is an integer and it does not represent the manufacturer's
- implementation version.
+ the high octet of the service type ID and the service family version is an
+ integer representing the service family version. It refers to the version
+ of the corresponding KNXnet/IP document, not to the manufacturer's
+ implemented version.
\note When using QKnxNetIpServiceFamiliesDibProxy, care must be taken to
ensure that the referenced KNXnet/IP DIB structure outlives the view on all