summaryrefslogtreecommitdiff
path: root/src/location/doc
diff options
context:
space:
mode:
authorPaolo Angelelli <paolo.angelelli@qt.io>2017-11-28 16:53:54 +0100
committerPaolo Angelelli <paolo.angelelli@qt.io>2017-11-29 23:02:27 +0000
commitfe821df2179d496a3ffc853076e9c62f96abde2a (patch)
tree649ce88bd270af2a74b47ae6e529fc0ecd6122e0 /src/location/doc
parent057fe199941b8783312abeedde315118b59ccb8e (diff)
downloadqtlocation-fe821df2179d496a3ffc853076e9c62f96abde2a.tar.gz
Unify OSRM backends for OSM and Mapbox plugins
This patch unifies the OSRM backend in both the OSM and Mapbox plugins, adding some extra functionalities to QGeoRouteParserOsrmV5 to handle the extra osrm-text-instructions information coming from the Mapbox servers. It also adds a plugin parameter to let the user choose whether to use the server's text instructions or the plugin-generated ones. Change-Id: Id7ce73f4285e2e7db6872f40d72c0610847fce91 Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
Diffstat (limited to 'src/location/doc')
-rw-r--r--src/location/doc/src/plugins/mapbox.qdoc8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/location/doc/src/plugins/mapbox.qdoc b/src/location/doc/src/plugins/mapbox.qdoc
index aef0a981..14fe5f80 100644
--- a/src/location/doc/src/plugins/mapbox.qdoc
+++ b/src/location/doc/src/plugins/mapbox.qdoc
@@ -153,5 +153,13 @@ The following table lists optional parameters that can be passed to the Mapbox p
\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 mapbox.routing.use_mapbox_text_instructions
+ \li Whether to use the instruction text that came with the response from the server (true) or the
+ text generated by the plugin. The default value is true.
+ Note that if instructions in a language that is not directly supported by Mapbox are needed (see
+ \l{https://www.mapbox.com/api-documentation/#instructions-languages}{here} for the supported languages),
+ it is possible to use the \l{Qt Linguist} to translate QtLocation to the desired language, and set this parameter to
+ false in order to use the translated built-in instructions.
\endtable
*/