diff options
author | Paolo Angelelli <paolo.angelelli@qt.io> | 2017-02-27 18:07:10 +0100 |
---|---|---|
committer | Paolo Angelelli <paolo.angelelli@qt.io> | 2017-02-28 10:11:23 +0000 |
commit | 39997e31218e9c233f52668cbd730f8d871e0ab9 (patch) | |
tree | dd2daa148694bc6f5f2f01ea5401ff9bb2019c35 | |
parent | 930f897e13c422add83722c6cd790f30f3ee1eac (diff) | |
download | qtlocation-39997e31218e9c233f52668cbd730f8d871e0ab9.tar.gz |
Clarify osm plugin documentation
Task-number: QTBUG-55176
Change-Id: Id70a5e501425c7581acc18f7d1aae1c33b42d7ba
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
-rw-r--r-- | src/location/doc/src/plugins/osm.qdoc | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/location/doc/src/plugins/osm.qdoc b/src/location/doc/src/plugins/osm.qdoc index bb520601..2d1b4168 100644 --- a/src/location/doc/src/plugins/osm.qdoc +++ b/src/location/doc/src/plugins/osm.qdoc @@ -68,9 +68,11 @@ a prefix. for geocoding) \row \li osm.mapping.custom.host - \li Url string set when making network requests to the tile server. This parameter should be set to a - valid server url with the correct osm api and the \l{Map::activeMapType} to the corresponding \l{MapType}.CustomMap. - The CustomMap will only be available if this parameter is set. + \li Url string of a custom tile server. This parameter should be set to a valid server url offering the correct osm API. + To use this server, the \l{Map::activeMapType} parameter of the \l Map should be set to the supported map type + whose type is \l{MapType}.CustomMap. + This map type is only be available if this plugin parameter is set, in which case it is + always \l{Map::supportedMapTypes}[supportedMapTypes.length - 1]. \note Setting the mapping.custom.host parameter to a new server renders the map tile cache useless for the old custommap style. \row \li osm.mapping.custom.mapcopyright |