summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaolo Angelelli <paolo.angelelli@qt.io>2019-01-30 11:52:15 +0100
committerPaolo Angelelli <paolo.angelelli@qt.io>2019-01-30 12:42:46 +0000
commit34e7bd9bda35783d466dc4dd3cf6157a186f6295 (patch)
treefef46339dac43936fa76b30c1791b220574b9a45
parentc4aaa11d86d419d1aa216beaaf7424c713b78c8e (diff)
downloadqtlocation-34e7bd9bda35783d466dc4dd3cf6157a186f6295.tar.gz
Document Qt.labs.location qml module
Change-Id: I823bd3ebbd74096fc7319147dc7d4ca6ef10e414 Reviewed-by: BogDan Vatra <bogdan@kdab.com> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
-rw-r--r--src/location/labs/qdeclarativenavigator.cpp18
1 files changed, 18 insertions, 0 deletions
diff --git a/src/location/labs/qdeclarativenavigator.cpp b/src/location/labs/qdeclarativenavigator.cpp
index 0bf5035f..5b98f27f 100644
--- a/src/location/labs/qdeclarativenavigator.cpp
+++ b/src/location/labs/qdeclarativenavigator.cpp
@@ -43,6 +43,24 @@
QT_BEGIN_NAMESPACE
/*!
+ \qmlmodule Qt.labs.location 1.0
+ \title Qt Labs Location QML Types
+ \ingroup qmlmodules
+ \brief Provides experimental QtLocation QML types, such as \l Navigator and
+ various map objects types (not to be confused with map items).
+
+ To use this module, import the module with the following line:
+
+ \code
+ import Qt.labs.location 1.0
+ \endcode
+
+ \note These types are experimental and subject to source-incompatible changes from one
+ Qt minor release to the next, until they are ready to be moved to the stable QtLocation QML
+ module.
+*/
+
+/*!
\qmltype Navigator
\instantiates QDeclarativeNavigator
\inqmlmodule Qt.labs.location