summaryrefslogtreecommitdiff
path: root/src/location/doc/src/plugins/osm.qdoc
diff options
context:
space:
mode:
authorPaolo Angelelli <paolo.angelelli@theqtcompany.com>2016-09-27 18:45:49 +0200
committerPaolo Angelelli <paolo.angelelli@qt.io>2016-10-06 08:33:06 +0000
commita7c7a9bfc1f1d75f23f1e67ba3859e698e2e8965 (patch)
treebc7855bd5807a69a443f113038b74a19c5696108 /src/location/doc/src/plugins/osm.qdoc
parent26b2f917861e63091cf97a5acba04d7b813c2fed (diff)
downloadqtlocation-a7c7a9bfc1f1d75f23f1e67ba3859e698e2e8965.tar.gz
Add OSRMv5 support in osm plugin
This patch adds support for the OSRMv5 protocol (the only one currently available on the OSRM demo server router.project.osrm.org). Support for the old v4 protocol is retained, in case of users who supply their own osm.routing.host parameter pointing at a self hosted OSRMv4 server. The support for OSRMv4 and v5 has been moved away from the osm plugin and into the location module because this should be used in the mapbox plugin in a subsequent patch (the routing support in the mapbox plugin currently uses the text direction coming from the server, which does not support i18n) Task-number: QTBUG-56119 Change-Id: Id30fd536c7fd434011795f643221f55becfc9e18 Reviewed-by: Paolo Angelelli <paolo.angelelli@qt.io>
Diffstat (limited to 'src/location/doc/src/plugins/osm.qdoc')
-rw-r--r--src/location/doc/src/plugins/osm.qdoc8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/location/doc/src/plugins/osm.qdoc b/src/location/doc/src/plugins/osm.qdoc
index 1960fae9..a0f2bc2b 100644
--- a/src/location/doc/src/plugins/osm.qdoc
+++ b/src/location/doc/src/plugins/osm.qdoc
@@ -94,8 +94,14 @@ a prefix.
\row
\li osm.routing.host
\li Url string set when making network requests to the routing server. This parameter should be set to a
- valid server url with the correct osrm API. If not specified the default \l {http://router.project-osrm.org/viaroute}{url} will be used.
+ valid server url with the correct osrm API. If not specified the default \l {http://router.project-osrm.org/route/v1/driving/}{url} will be used.
\note The API documentation and sources are available at \l {http://project-osrm.org/}{Project OSRM}.
+
+\row
+ \li osm.routing.apiversion
+ \li String defining the api version of the (custom) OSRM server. Valid values are \b{v4} and \b{v5}. The default is \b{v5}.
+ This parameter should be set only if \tt{osm.routing.host} is set, and is an OSRM v4 server.
+
\row
\li osm.geocoding.host
\li Url string set when making network requests to the geocoding server. This parameter should be set to a