diff options
author | Karsten Heimrich <karsten.heimrich@qt.io> | 2018-05-28 15:55:03 +0200 |
---|---|---|
committer | Karsten Heimrich <karsten.heimrich@qt.io> | 2018-05-28 14:02:32 +0000 |
commit | d77741b190037029ae2cba5ec529afb259cbf91e (patch) | |
tree | dc9d83dbf3cb41702fec8a95fb1c9acf478f9405 | |
parent | 7afe7690a82de1317942bbfc523a14add4d1068a (diff) |
Doc: Clarify statement on when to use the class
Change-Id: I15ac940edf761a7e44b12da42ec9c22e2da095fc
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
-rw-r--r-- | src/knx/netip/qknxnetipdescriptionrequest.cpp | 10 | ||||
-rw-r--r-- | src/knx/netip/qknxnetipdescriptionresponse.cpp | 8 | ||||
-rw-r--r-- | src/knx/netip/qknxnetipsearchrequest.cpp | 8 | ||||
-rw-r--r-- | src/knx/netip/qknxnetipsearchresponse.cpp | 8 |
4 files changed, 15 insertions, 19 deletions
diff --git a/src/knx/netip/qknxnetipdescriptionrequest.cpp b/src/knx/netip/qknxnetipdescriptionrequest.cpp index 41cea42..0a479a3 100644 --- a/src/knx/netip/qknxnetipdescriptionrequest.cpp +++ b/src/knx/netip/qknxnetipdescriptionrequest.cpp @@ -46,11 +46,7 @@ QT_BEGIN_NAMESPACE control endpoints of the server. In most programs, this class will not be used directly. Instead, the - \l QKnxNetIpTunnel or \l QKnxNetIpDeviceManagement - class is used to establish a functional connection to a KNXnet/IP server. - - Before communicating with the server, the client should use the - \l QKnxNetIpServerDescriptionAgent and \l QKnxNetIpServerInfo classes to + \l QKnxNetIpDescriptionAgent and \l QKnxNetIpServerInfo are provided to check that the server supports the requested connection type and options. The following code sample illustrates how to read the description request @@ -138,8 +134,8 @@ QKnxNetIpDescriptionRequestProxy::Builder QKnxNetIpDescriptionRequestProxy::buil control endpoints of the server. In most programs, this class will not be used directly. Instead, the - \l QKnxNetIpTunnel or \l QKnxNetIpDeviceManagement - class is used to establish a functional connection to a KNXnet/IP server. + \l QKnxNetIpDescriptionAgent and \l QKnxNetIpServerInfo are provided to + check that the server supports the requested connection type and options. The common way to create a a search response is: diff --git a/src/knx/netip/qknxnetipdescriptionresponse.cpp b/src/knx/netip/qknxnetipdescriptionresponse.cpp index 81e2f11..b32a816 100644 --- a/src/knx/netip/qknxnetipdescriptionresponse.cpp +++ b/src/knx/netip/qknxnetipdescriptionresponse.cpp @@ -50,8 +50,8 @@ QT_BEGIN_NAMESPACE server's KNX connection. In most programs, this class will not be used directly. Instead, the - \l QKnxNetIpTunnel or \l QKnxNetIpDeviceManagement class is used to - establish a functional connection to a KNXnet/IP server. + \l QKnxNetIpDescriptionAgent and \l QKnxNetIpServerInfo are provided to + check that the server supports the requested connection type and options. The following code sample illustrates how to read the description response information sent by a KNXnet/IP server: @@ -173,8 +173,8 @@ QKnxNetIpDescriptionResponseProxy::Builder QKnxNetIpDescriptionResponseProxy::bu connection. In most programs, this class will not be used directly. Instead, the - \l QKnxNetIpTunnel or \l QKnxNetIpDeviceManagement class is used to - establish a functional connection to a KNXnet/IP server. + \l QKnxNetIpDescriptionAgent and \l QKnxNetIpServerInfo are provided to + check that the server supports the requested connection type and options. The common way to create a a description response is: diff --git a/src/knx/netip/qknxnetipsearchrequest.cpp b/src/knx/netip/qknxnetipsearchrequest.cpp index c120e99..2c6e4dc 100644 --- a/src/knx/netip/qknxnetipsearchrequest.cpp +++ b/src/knx/netip/qknxnetipsearchrequest.cpp @@ -55,8 +55,8 @@ QT_BEGIN_NAMESPACE KNXnet/IP servers that are on a different subnetwork. In most programs, this class will not be used directly. Instead, the - \l QKnxNetIpTunnel or \l QKnxNetIpDeviceManagement - class is used to establish a functional connection to a KNXnet/IP server. + \l QKnxNetIpDiscoveryAgent and \l QKnxNetIpServerInfo are provided to + discover KNXnet/IP servers on the network. The following code sample illustrates how to read the search request information sent by a KNXnet/IP client: @@ -148,8 +148,8 @@ QKnxNetIpSearchRequestProxy::Builder QKnxNetIpSearchRequestProxy::builder() subnetwork. In most programs, this class will not be used directly. Instead, the - \l QKnxNetIpTunnel or \l QKnxNetIpDeviceManagement - class is used to establish a functional connection to a KNXnet/IP server. + \l QKnxNetIpDiscoveryAgent and \l QKnxNetIpServerInfo are provided to + discover KNXnet/IP servers on the network. The common way to create a search request is: diff --git a/src/knx/netip/qknxnetipsearchresponse.cpp b/src/knx/netip/qknxnetipsearchresponse.cpp index b699e79..01116b0 100644 --- a/src/knx/netip/qknxnetipsearchresponse.cpp +++ b/src/knx/netip/qknxnetipsearchresponse.cpp @@ -56,8 +56,8 @@ QT_BEGIN_NAMESPACE hardware and the supported service families. In most programs, this class will not be used directly. Instead, the - \l QKnxNetIpTunnel or \l QKnxNetIpDeviceManagement - class is used to establish a functional connection to a KNXnet/IP server. + \l QKnxNetIpDiscoveryAgent and \l QKnxNetIpServerInfo are provided to + discover KNXnet/IP servers on the network. The following code sample illustrates how to read the search response information sent by a KNXnet/IP server: @@ -166,8 +166,8 @@ QKnxNetIpSearchResponseProxy::Builder QKnxNetIpSearchResponseProxy::builder() hardware and the supported service families. In most programs, this class will not be used directly. Instead, the - \l QKnxNetIpTunnel or \l QKnxNetIpDeviceManagement - class is used to establish a functional connection to a KNXnet/IP server. + \l QKnxNetIpDiscoveryAgent and \l QKnxNetIpServerInfo are provided to + discover KNXnet/IP servers on the network. The common way to create a a search response is: |