summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaolo Angelelli <paolo.angelelli@qt.io>2017-04-15 17:27:37 +0200
committerPaolo Angelelli <paolo.angelelli@qt.io>2017-05-02 10:57:07 +0000
commit98e2c7bc2da9b701ba5097823653e34d0db63057 (patch)
tree52bb2e7175e19ad8c46ec8f3bf60fbd6564a6023
parent1aa24b25a99335e350503fb45a0bca2f25d3dd05 (diff)
downloadqtlocation-98e2c7bc2da9b701ba5097823653e34d0db63057.tar.gz
Fix prefetching documentation for plugins
Depending on the plugin, and the map type, the prefetching parameter might be overridden for specific reasons. This patch changes the description of prefetching stating that this parameter is a hint for the engine, that might get ignored. Change-Id: Iba68ed735f48ffaca19622b8f8933a44aa257c90 Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
-rw-r--r--src/location/doc/src/plugins/esri.qdoc3
-rw-r--r--src/location/doc/src/plugins/mapbox.qdoc3
-rw-r--r--src/location/doc/src/plugins/nokia.qdoc3
-rw-r--r--src/location/doc/src/plugins/osm.qdoc3
4 files changed, 8 insertions, 4 deletions
diff --git a/src/location/doc/src/plugins/esri.qdoc b/src/location/doc/src/plugins/esri.qdoc
index 9dce349c..7a80d385 100644
--- a/src/location/doc/src/plugins/esri.qdoc
+++ b/src/location/doc/src/plugins/esri.qdoc
@@ -152,11 +152,12 @@ or you can sign up for an \l {http://www.arcgis.com/features/plans/pricing.html}
This value is the amount of cache to be used in addition to the bare minimum.
\row
\li esri.mapping.prefetching_style
- \li This parameter allows to control how tile prefetching is performed by the engine. The default value,
+ \li This parameter allows to provide a hint how tile prefetching is to be performed by the engine. The default value,
\tt{TwoNeighbourLayers}, makes the engine prefetch tiles for the layer above and the one below the current tile
layer, providing ready tiles when zooming in or out from the current zoom level.
\tt{OneNeighbourLayer} only prefetches the one layer closest to the current zoom level.
Finally, \tt{NoPrefetching} allows to disable the prefetching, so only tiles that are visible will be fetched.
+ Note that, depending on the active map type, this hint might be ignored.
\endtable
\section2 Directions language
diff --git a/src/location/doc/src/plugins/mapbox.qdoc b/src/location/doc/src/plugins/mapbox.qdoc
index cf564415..e962bead 100644
--- a/src/location/doc/src/plugins/mapbox.qdoc
+++ b/src/location/doc/src/plugins/mapbox.qdoc
@@ -140,10 +140,11 @@ The following table lists optional parameters that can be passed to the Mapbox p
This value is the amount of tiles to be cached in addition to the bare minimum.
\row
\li mapbox.mapping.prefetching_style
- \li This parameter allows to control how tile prefetching is performed by the engine. The default value,
+ \li This parameter allows to provide a hint how tile prefetching is to be performed by the engine. The default value,
\tt{TwoNeighbourLayers}, makes the engine prefetch tiles for the layer above and the one below the current tile
layer, providing ready tiles when zooming in or out from the current zoom level.
\tt{OneNeighbourLayer} only prefetches the one layer closest to the current zoom level.
Finally, \tt{NoPrefetching} allows to disable the prefetching, so only tiles that are visible will be fetched.
+ Note that, depending on the active map type, this hint might be ignored.
\endtable
*/
diff --git a/src/location/doc/src/plugins/nokia.qdoc b/src/location/doc/src/plugins/nokia.qdoc
index 6e954a89..30fd43f1 100644
--- a/src/location/doc/src/plugins/nokia.qdoc
+++ b/src/location/doc/src/plugins/nokia.qdoc
@@ -137,11 +137,12 @@ a prefix.
This value is the amount of cache to be used in addition to the bare minimum.
\row
\li here.mapping.prefetching_style
- \li This parameter allows to control how tile prefetching is performed by the engine. The default value,
+ \li This parameter allows to provide a hint how tile prefetching is to be performed by the engine. The default value,
\tt{TwoNeighbourLayers}, makes the engine prefetch tiles for the layer above and the one below the current tile
layer, providing ready tiles when zooming in or out from the current zoom level.
\tt{OneNeighbourLayer} only prefetches the one layer closest to the current zoom level.
Finally, \tt{NoPrefetching} allows to disable the prefetching, so only tiles that are visible will be fetched.
+ Note that, depending on the active map type, this hint might be ignored.
\row
\li here.mapping.highdpi_tiles
\li Whether or not to request high dpi tiles. Valid values are \b true and \b false. The default value is \b false.
diff --git a/src/location/doc/src/plugins/osm.qdoc b/src/location/doc/src/plugins/osm.qdoc
index 236b0255..c65c4abb 100644
--- a/src/location/doc/src/plugins/osm.qdoc
+++ b/src/location/doc/src/plugins/osm.qdoc
@@ -102,11 +102,12 @@ a prefix.
These are fetched from the same location used for the low dpi counterparts.
\row
\li osm.mapping.prefetching_style
- \li This parameter allows to control how tile prefetching is performed by the engine. The default value,
+ \li This parameter allows to provide a hint how tile prefetching is to be performed by the engine. The default value,
\tt{TwoNeighbourLayers}, makes the engine prefetch tiles for the layer above and the one below the current tile
layer, providing ready tiles when zooming in or out from the current zoom level.
\tt{OneNeighbourLayer} only prefetches the one layer closest to the current zoom level.
Finally, \tt{NoPrefetching} allows to disable the prefetching, so only tiles that are visible will be fetched.
+ Note that, depending on the active map type, this hint might be ignored.
\row
\li osm.routing.host
\li Url string set when making network requests to the routing server. This parameter should be set to a