summaryrefslogtreecommitdiffstats
path: root/src/location/doc/src/example-parameters.qdocinc
diff options
context:
space:
mode:
Diffstat (limited to 'src/location/doc/src/example-parameters.qdocinc')
-rw-r--r--src/location/doc/src/example-parameters.qdocinc12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/location/doc/src/example-parameters.qdocinc b/src/location/doc/src/example-parameters.qdocinc
new file mode 100644
index 00000000..2ae351ba
--- /dev/null
+++ b/src/location/doc/src/example-parameters.qdocinc
@@ -0,0 +1,12 @@
+The example 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. \l {QtLocation::PluginParameter}{Plugin parameters} can be passed on the
+command line using the \c {--plugin} argument, which takes the form:
+
+\badcode
+ --plugin.<parameter name> <parameter value>
+\endcode
+
+Refer to the documentation for each of the geo services plugins for details on what plugin
+parameters they support. The default plugin used by this example is
+\l {Qt Location Open Street Map Plugin}, which does not require any parameters.