summaryrefslogtreecommitdiffstats
path: root/src/network
diff options
context:
space:
mode:
authorMårten Nordheim <marten.nordheim@qt.io>2021-11-03 12:19:14 +0100
committerMårten Nordheim <marten.nordheim@qt.io>2021-11-03 20:07:32 +0100
commit2d39509d4a47e4f39180147ba5018923000f654e (patch)
tree2d481a012a663111aedc9c2ee86de1abf5e07084 /src/network
parent762a3d73f569b92d4ea8951d99e1c6a253e91131 (diff)
QNI: Clarify Feature enum entries' documentation
Saying properties are not available depending on feature support is misleading. It is available even if not supported, it's just not useful. Pick-to: 6.2 Change-Id: I6325c50867bb873258c70280adb8d75125db2096 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Marc Mutz <marc.mutz@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/network')
-rw-r--r--src/network/kernel/qnetworkinformation.cpp14
1 files changed, 9 insertions, 5 deletions
diff --git a/src/network/kernel/qnetworkinformation.cpp b/src/network/kernel/qnetworkinformation.cpp
index 3bfe623885..5d889ac574 100644
--- a/src/network/kernel/qnetworkinformation.cpp
+++ b/src/network/kernel/qnetworkinformation.cpp
@@ -442,17 +442,21 @@ QNetworkInformationBackendFactory::~QNetworkInformationBackendFactory()
This can be used in QNetworkInformation::load().
\value Reachability
- If the plugin supports this feature then
- the \c reachability property will be available.
+ If the plugin supports this feature then the \c reachability property
+ will provide useful results. Otherwise it will always return
+ \c{Reachability::Unknown}.
See also QNetworkInformation::Reachability.
\value CaptivePortal
- If the plugin supports this feature then
- the \c isBehindCaptivePortal property will be available.
+ If the plugin supports this feature then the \c isBehindCaptivePortal
+ property will provide useful results. Otherwise it will always return
+ \c{false}.
\value TransportMedium
If the plugin supports this feature then the \c transportMedium
- property will be available.
+ property will provide useful results. Otherwise it will always return
+ \c{TransportMedium::Unknown}.
+ See also QNetworkInformation::TransportMedium.
*/
/*!