summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichal Klocek <michal.klocek@theqtcompany.com>2016-02-24 15:09:58 +0100
committerMichal Klocek <michal.klocek@theqtcompany.com>2016-02-26 12:08:23 +0000
commit2faf0e84444af9a46076cc2d3845b9267f3a9404 (patch)
tree5b35a844d7d4d06b06dda1349f42e9863e902ba6
parent3a9590241cf54eccb9d28957c3d58268e0d23b60 (diff)
downloadqtlocation-2faf0e84444af9a46076cc2d3845b9267f3a9404.tar.gz
Doc: Add plugin parameter info to qtlocation-examples.
Change-Id: Iebbcbf2bae7545bceab69d30d9edebb1640486cb Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
-rw-r--r--src/location/doc/src/qtlocation-examples.qdoc9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/location/doc/src/qtlocation-examples.qdoc b/src/location/doc/src/qtlocation-examples.qdoc
index ce4047cb..6155a6fd 100644
--- a/src/location/doc/src/qtlocation-examples.qdoc
+++ b/src/location/doc/src/qtlocation-examples.qdoc
@@ -32,7 +32,14 @@
\ingroup all-examples
\ingroup qtlocation
- These are the Qt Location examples.
+ These examples show a range of different uses for \l{Qt Location},
+ such as displaying a map within a QML user interface, implementing basic routing and
+ place search, as well as integrating positioning data types.
+
+ These examples can work with any of the available geo services plugins. However, some plugins may
+ require additional \l {QtLocation::PluginParameter}{plugin parameters} in order to function correctly.
+ The default plugin used by these examples is \l {Qt Location Open Street Map Plugin}, which does not
+ require any parameters.
*/