summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorAlex Blasche <alexander.blasche@theqtcompany.com>2015-05-18 13:25:47 +0200
committerAlex Blasche <alexander.blasche@theqtcompany.com>2015-05-20 13:34:57 +0000
commitd999901e9ecc0524dbc6355ec9e3ba04b5c6c72a (patch)
tree219e54c5532696fca316a8cf20d5d1cb8a62ed77 /src
parent58d8b5e84ac6952b411cff3bca7336073349290e (diff)
downloadqtlocation-d999901e9ecc0524dbc6355ec9e3ba04b5c6c72a.tar.gz
Ensure that docs always import QtPositioning and QtLocation module
At the same time we update the import versions and reduce the qdoc tag duplications. Change-Id: I894d163657734a4b3bbc2951462660571f340dfd Task-number: QTBUG-46147 Reviewed-by: Michal Klocek <michal.klocek@theqtcompany.com> Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
Diffstat (limited to 'src')
-rw-r--r--src/imports/location/declarativeplaces/qdeclarativecategory.cpp2
-rw-r--r--src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp4
-rw-r--r--src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp4
-rw-r--r--src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp2
-rw-r--r--src/imports/location/declarativeplaces/qdeclarativeplaceicon.cpp2
-rw-r--r--src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp2
-rw-r--r--src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp2
-rw-r--r--src/imports/location/declarativeplaces/qdeclarativeratings.cpp2
-rw-r--r--src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp2
-rw-r--r--src/imports/location/declarativeplaces/qdeclarativesupplier.cpp2
-rw-r--r--src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp2
-rw-r--r--src/imports/location/qdeclarativegeomaneuver.cpp2
-rw-r--r--src/imports/location/qdeclarativegeoroute.cpp2
-rw-r--r--src/imports/location/qdeclarativegeoroutesegment.cpp2
-rw-r--r--src/location/doc/snippets/declarative/maps.qml4
-rw-r--r--src/location/doc/snippets/declarative/places.qml6
-rw-r--r--src/location/doc/snippets/declarative/routing.qml6
-rw-r--r--src/location/doc/src/qtlocation.qdoc7
18 files changed, 28 insertions, 27 deletions
diff --git a/src/imports/location/declarativeplaces/qdeclarativecategory.cpp b/src/imports/location/declarativeplaces/qdeclarativecategory.cpp
index 1ea9932b..960f648e 100644
--- a/src/imports/location/declarativeplaces/qdeclarativecategory.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativecategory.cpp
@@ -65,7 +65,7 @@ QT_USE_NAMESPACE
If the \l Plugin supports it, categories can be created or removed. To create a new category
construct a new Category object and set its properties, then invoke the \l save() method.
- \snippet declarative/places.qml QtLocation import
+ \snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/places.qml Category
\dots 0
diff --git a/src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp b/src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp
index 15039a16..5298c3d1 100644
--- a/src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp
@@ -70,7 +70,7 @@
The following example shows how to access all \l {QtLocation::ContactDetail}{ContactDetails}
and print them to the console:
- \snippet declarative/places.qml QtLocation import
+ \snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/places.qml ContactDetails read
@@ -78,7 +78,7 @@
following demonstrates how to display a list of contact phone numbers in a list view:
\snippet declarative/places.qml QtQuick import
- \snippet declarative/places.qml QtLocation import
+ \snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/places.qml ContactDetails phoneList
diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp
index 6bd9bc1b..ad418fed 100644
--- a/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp
@@ -91,7 +91,7 @@
The following example shows how to access all \l {PlaceAttribute}{PlaceAttributes} and print
them to the console:
- \snippet declarative/places.qml QtLocation import
+ \snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/places.qml ExtendedAttributes read
@@ -135,7 +135,7 @@
The following example shows how to display all attributes in a list:
\snippet declarative/places.qml QtQuick import
- \snippet declarative/places.qml QtLocation import
+ \snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/places.qml ExtendedAttributes
diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp
index 313cf66a..8fc424da 100644
--- a/src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp
@@ -99,7 +99,7 @@ QT_BEGIN_NAMESPACE
The following example shows how to display editorials for a place:
\snippet declarative/places.qml QtQuick import
- \snippet declarative/places.qml QtLocation import
+ \snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/places.qml EditorialModel
diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceicon.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceicon.cpp
index 6a748395..044d156c 100644
--- a/src/imports/location/declarativeplaces/qdeclarativeplaceicon.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativeplaceicon.cpp
@@ -71,7 +71,7 @@ QT_USE_NAMESPACE
The following code shows how to display a 64x64 pixel icon:
\snippet declarative/places.qml QtQuick import
- \snippet declarative/places.qml QtLocation import
+ \snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/places.qml Icon
diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp
index d357262c..98ee1bfc 100644
--- a/src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp
@@ -100,7 +100,7 @@ QT_BEGIN_NAMESPACE
The following example shows how to display images for a place:
\snippet declarative/places.qml QtQuick import
- \snippet declarative/places.qml QtLocation import
+ \snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/places.qml ImageModel
*/
diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp
index bc99e982..5d799826 100644
--- a/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp
@@ -59,7 +59,7 @@ QT_USE_NAMESPACE
submitted an editorial:
\snippet declarative/places.qml QtQuick import
- \snippet declarative/places.qml QtLocation import
+ \snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/places.qml EditorialModel
*/
diff --git a/src/imports/location/declarativeplaces/qdeclarativeratings.cpp b/src/imports/location/declarativeplaces/qdeclarativeratings.cpp
index 4644bd0d..16f81837 100644
--- a/src/imports/location/declarativeplaces/qdeclarativeratings.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativeratings.cpp
@@ -53,7 +53,7 @@ QT_USE_NAMESPACE
ratings value out of a possible maximum as given by the \l maximum property.
\snippet declarative/places.qml QtQuick import
- \snippet declarative/places.qml QtLocation import
+ \snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/places.qml Ratings
*/
diff --git a/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp
index cd6c365f..dfcb8efc 100644
--- a/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp
@@ -87,7 +87,7 @@ QT_USE_NAMESPACE
actual place search with \l PlaceSearchModel.
\snippet declarative/places.qml QtQuick import
- \snippet declarative/places.qml QtLocation import
+ \snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/places.qml SearchSuggestionModel
diff --git a/src/imports/location/declarativeplaces/qdeclarativesupplier.cpp b/src/imports/location/declarativeplaces/qdeclarativesupplier.cpp
index 4687fcfe..80e246eb 100644
--- a/src/imports/location/declarativeplaces/qdeclarativesupplier.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativesupplier.cpp
@@ -63,7 +63,7 @@ QT_USE_NAMESPACE
The following example shows how to create and display a supplier in QML:
\snippet declarative/places.qml QtQuick import
- \snippet declarative/places.qml QtLocation import
+ \snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/places.qml Supplier
*/
diff --git a/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp
index ad476211..37abfb1b 100644
--- a/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp
@@ -82,7 +82,7 @@ QT_USE_NAMESPACE
The following example displays a flat list of all available categories:
\snippet declarative/places.qml QtQuick import
- \snippet declarative/places.qml QtLocation import
+ \snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/places.qml CategoryView
diff --git a/src/imports/location/qdeclarativegeomaneuver.cpp b/src/imports/location/qdeclarativegeomaneuver.cpp
index 0df98e6b..cf659891 100644
--- a/src/imports/location/qdeclarativegeomaneuver.cpp
+++ b/src/imports/location/qdeclarativegeomaneuver.cpp
@@ -62,7 +62,7 @@ QT_BEGIN_NAMESPACE
route maneuver:
\snippet declarative/routing.qml QtQuick import
- \snippet declarative/routing.qml QtLocation import
+ \snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/routing.qml RouteManeuver
*/
diff --git a/src/imports/location/qdeclarativegeoroute.cpp b/src/imports/location/qdeclarativegeoroute.cpp
index fc65afcf..c129d075 100644
--- a/src/imports/location/qdeclarativegeoroute.cpp
+++ b/src/imports/location/qdeclarativegeoroute.cpp
@@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE
This example shows how to display a route's maneuvers in a ListView:
\snippet declarative/routing.qml QtQuick import
- \snippet declarative/routing.qml QtLocation import
+ \snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/routing.qml Route Maneuver List1
\snippet declarative/routing.qml Route Maneuver List2
diff --git a/src/imports/location/qdeclarativegeoroutesegment.cpp b/src/imports/location/qdeclarativegeoroutesegment.cpp
index a1fc8507..3810cf72 100644
--- a/src/imports/location/qdeclarativegeoroutesegment.cpp
+++ b/src/imports/location/qdeclarativegeoroutesegment.cpp
@@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE
route segment:
\snippet declarative/routing.qml QtQuick import
- \snippet declarative/routing.qml QtLocation import
+ \snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/routing.qml RouteSegment
*/
diff --git a/src/location/doc/snippets/declarative/maps.qml b/src/location/doc/snippets/declarative/maps.qml
index 1854282d..59e92c45 100644
--- a/src/location/doc/snippets/declarative/maps.qml
+++ b/src/location/doc/snippets/declarative/maps.qml
@@ -41,9 +41,9 @@
//! [QtQuick import]
import QtQuick 2.0
//! [QtQuick import]
-import QtPositioning 5.2
//! [QtLocation import]
-import QtLocation 5.3
+import QtPositioning 5.5
+import QtLocation 5.5
//! [QtLocation import]
Item {
diff --git a/src/location/doc/snippets/declarative/places.qml b/src/location/doc/snippets/declarative/places.qml
index f85a3a8f..a0081bd9 100644
--- a/src/location/doc/snippets/declarative/places.qml
+++ b/src/location/doc/snippets/declarative/places.qml
@@ -41,10 +41,8 @@
//! [QtQuick import]
import QtQuick 2.0
//! [QtQuick import]
-//! [QtLocation import]
-import QtPositioning 5.2
-import QtLocation 5.3
-//! [QtLocation import]
+import QtPositioning 5.5
+import QtLocation 5.5
Item {
width: 400; height: 400;
diff --git a/src/location/doc/snippets/declarative/routing.qml b/src/location/doc/snippets/declarative/routing.qml
index cc091672..75d18c5b 100644
--- a/src/location/doc/snippets/declarative/routing.qml
+++ b/src/location/doc/snippets/declarative/routing.qml
@@ -41,10 +41,8 @@
//! [QtQuick import]
import QtQuick 2.3
//! [QtQuick import]
-import QtPositioning 5.3
-//! [QtLocation import]
-import QtLocation 5.3
-//! [QtLocation import]
+import QtPositioning 5.5
+import QtLocation 5.5
Item {
width: 1000
diff --git a/src/location/doc/src/qtlocation.qdoc b/src/location/doc/src/qtlocation.qdoc
index 48619be2..1bdb567f 100644
--- a/src/location/doc/src/qtlocation.qdoc
+++ b/src/location/doc/src/qtlocation.qdoc
@@ -84,9 +84,14 @@ The Qt Location API enables you to:
To load the Qt Location module, add the following statement to your .qml files
\code
- import QtLocation 5.3
+ import QtPositioning 5.5
+ import QtLocation 5.5
\endcode
+The QtLocation QML module depends on the QtPositioning QML module.
+Therefore every QML application that imports the QtLocation QML module must always
+import the QtPositioning module as well.
+
For C++ projects include the header appropriate for the current use case,
for example applications using routes may use