From 453fab84c606328811bafd4de9cde5564620fdc6 Mon Sep 17 00:00:00 2001
From: Paolo Angelelli <paolo.angelelli@qt.io>
Date: Wed, 12 Apr 2017 16:00:48 +0200
Subject: [PATCH] Clarify overzoomEnabled property of QGeoCameraCapabilities

Change-Id: If6f8fd446c562d6ccaf368e1d5afb5eee113fece
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
---
 src/location/declarativemaps/qdeclarativegeomap.cpp | 4 +++-
 src/location/maps/qgeocameracapabilities.cpp        | 8 ++++++++
 2 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/src/location/declarativemaps/qdeclarativegeomap.cpp b/src/location/declarativemaps/qdeclarativegeomap.cpp
index e4bf10a69..1638d1c8e 100644
--- a/src/location/declarativemaps/qdeclarativegeomap.cpp
+++ b/src/location/declarativemaps/qdeclarativegeomap.cpp
@@ -936,7 +936,9 @@ qreal QDeclarativeGeoMap::maximumZoomLevel() const
     This property holds the zoom level for the map.
 
     Larger values for the zoom level provide more detail. Zoom levels
-    are always non-negative. The default value is 8.0.
+    are always non-negative. The default value is 8.0. Depending on the plugin in use,
+    values outside the [minimumZoomLevel, maximumZoomLevel] range, which represent the range for which
+    tiles are available, may be accepted, or clamped.
 */
 void QDeclarativeGeoMap::setZoomLevel(qreal zoomLevel)
 {
diff --git a/src/location/maps/qgeocameracapabilities.cpp b/src/location/maps/qgeocameracapabilities.cpp
index d5a2f11eb..bb6ec4d39 100644
--- a/src/location/maps/qgeocameracapabilities.cpp
+++ b/src/location/maps/qgeocameracapabilities.cpp
@@ -438,6 +438,14 @@ double QGeoCameraCapabilities::maximumFieldOfView() const
 /*!
     Sets whether overzooming is supported by the associated plugin.
 
+    Overzooming means that zoom levels outside the [minimumZL, maximumZL] range can be set,
+    and if tiles aren't available for those zoom levels, either tiles from other zoom levels
+    will be used, or nothing will be shown.
+
+    Set this value to false if the plugin is not capable of that. For example if using
+    a mapping engine that always clamp the zoomLevel value, which may cause misalignment in case
+    of stacked map elements.
+
     \since 5.9
 */
 void QGeoCameraCapabilities::setOverzoomEnabled(bool overzoomEnabled)
-- 
GitLab