summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Solovev <ivan.solovev@qt.io>2021-03-15 16:56:50 +0100
committerIvan Solovev <ivan.solovev@qt.io>2021-03-23 10:44:13 +0100
commita61120fcc2926f45b01e94beb454ca5d3f33affa (patch)
tree91c656d366973dd3bc5ecb4ff4530482d1abb74c
parent523a7df8658f9056b886f928ed84b050dc5fc14f (diff)
downloadqtlocation-a61120fcc2926f45b01e94beb454ca5d3f33affa.tar.gz
QtPositioning: update main docs page
Improve Positioning documentation main page to reflect different build systems. Get rid of UWP mentions, as the corresponding docs page is removed. Update documentation dependencies. Task-number: QTBUG-89856 Change-Id: I70a9aecf1b60d7cff8b504f17fd1c9ffb4ff1e90 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
-rw-r--r--src/positioning/doc/qtpositioning.qdocconf2
-rw-r--r--src/positioning/doc/snippets/doc_src_qtpositioning.qml2
-rw-r--r--src/positioning/doc/src/qtpositioning-examples.qdoc5
-rw-r--r--src/positioning/doc/src/qtpositioning.qdoc86
4 files changed, 52 insertions, 43 deletions
diff --git a/src/positioning/doc/qtpositioning.qdocconf b/src/positioning/doc/qtpositioning.qdocconf
index 968f9b31..286e0bb3 100644
--- a/src/positioning/doc/qtpositioning.qdocconf
+++ b/src/positioning/doc/qtpositioning.qdocconf
@@ -33,7 +33,7 @@ qhp.QtPositioning.subprojects.examples.selectors = fake:example
tagfile = ../../../doc/qtpositioning/qtpositioning.tags
-depends += qtcore qtdoc qtquick qtqml qtnetwork qtlocation qtxmlpatterns
+depends += qtcore qtdoc qtquick qtqml qtnetwork qtqmlxmllistmodel qmake qtcmake
headerdirs += .. \
../../imports/positioning \
diff --git a/src/positioning/doc/snippets/doc_src_qtpositioning.qml b/src/positioning/doc/snippets/doc_src_qtpositioning.qml
index ee6e8328..f6d15572 100644
--- a/src/positioning/doc/snippets/doc_src_qtpositioning.qml
+++ b/src/positioning/doc/snippets/doc_src_qtpositioning.qml
@@ -49,7 +49,7 @@
****************************************************************************/
//! [import]
-import QtPositioning 5.11
+import QtPositioning
//! [import]
Item {
diff --git a/src/positioning/doc/src/qtpositioning-examples.qdoc b/src/positioning/doc/src/qtpositioning-examples.qdoc
index 74992d93..fbcc9a40 100644
--- a/src/positioning/doc/src/qtpositioning-examples.qdoc
+++ b/src/positioning/doc/src/qtpositioning-examples.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2017 The Qt Company Ltd.
+** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
@@ -32,6 +32,7 @@
\ingroup all-examples
\ingroup qtpositioning
- These are the \l{Qt Positioning} examples.
+ The list of \l {Qt Positioning} examples demonstrating how to use
+ Positioning API from C++ and QML.
*/
diff --git a/src/positioning/doc/src/qtpositioning.qdoc b/src/positioning/doc/src/qtpositioning.qdoc
index 27569cc3..2c15b924 100644
--- a/src/positioning/doc/src/qtpositioning.qdoc
+++ b/src/positioning/doc/src/qtpositioning.qdoc
@@ -44,7 +44,14 @@
#include <QGeoCoordinate>
\endcode
- The .pro file should have the \e positioning keyword added
+ \include module-use.qdocinc using qt module
+
+ \badcode
+ find_package(Qt6 COMPONENTS Positioning REQUIRED)
+ target_link_libraries(mytarget PRIVATE Qt6::Positioning)
+ \endcode
+
+ \include module-use.qdocinc building with qmake
\badcode
QT += positioning
@@ -64,13 +71,10 @@
The Qt Positioning API provides positioning information via QML and C++ interfaces.
-Currently the API is supported on \l {Qt for Android}{Android}, \l {Qt for iOS}{iOS},
-\l {Qt for macOS}{\macos},
-\l {Qt for Linux/X11}{Linux},
-\l {Qt for Windows}{Windows} (with GPS receivers exposed as a serial port providing NMEA sentences),
-and \l {Qt for UWP}{UWP (Universal Windows Platform)} (using \c {Windows.Devices.Geolocation}).
-The Qt for UWP implementation can also be used in Win32 Desktop use cases if the underlying
-platform is Windows 10, or later.
+Currently the API is supported on \l {Qt for Android}{Android},
+\l {Qt for iOS}{iOS}, \l {Qt for macOS}{\macos}, \l {Qt for Linux/X11}{Linux},
+and \l {Qt for Windows}{Windows} (with GPS receivers exposed as a serial port
+providing NMEA sentences or using \c {Windows.Devices.Geolocation}).
\section1 Overview
@@ -80,7 +84,22 @@ and so on. That information can then be used to for example determine a position
on a map. In addition satellite information can be retrieved and area based monitoring
can be performed.
-\section1 Getting Started
+\include module-use.qdocinc using qt module
+
+\badcode
+find_package(Qt6 COMPONENTS Positioning REQUIRED)
+target_link_libraries(mytarget PRIVATE Qt6::Positioning)
+\endcode
+
+See also the \l {Build with CMake} overview.
+
+\include module-use.qdocinc building with qmake
+
+\badcode
+QT += positioning
+\endcode
+
+\section2 Getting Started
To load the Qt Positioning module, add the following statement to your .qml files
@@ -93,11 +112,10 @@ for example applications using routes may use
#include <QGeoCoordinate>
\endcode
-The .pro file should have the \e positioning keyword added
+\section1 Module Evolution
-\badcode
-QT += positioning
-\endcode
+\l {Changes to Qt Positioning} lists important changes in the module API and
+functionality that were done for the Qt 6 series of Qt.
\section1 Licenses
@@ -108,35 +126,25 @@ these free software licenses are
the \l{GNU General Public License, version 2}.
See \l{Qt Licensing} for further details.
-\section1 Related Information
-\section2 Overview
-
-Positioning includes all the functionality necessary to find and work with geographic
-coordinates. It can use a variety of external sources of information, including GPS. This
-provides us with a coordinate and altitude for the device with additional features
-such as speed and direction. This provides the fundamental location information used in the API.
-
-\section2 References
-\table
-\row
- \li Positioning introduction:
- \li \l{Positioning (QML)}{for QML}
- \li \l{Positioning (C++)}{for C++}
-\row
- \li API references:
- \li \l {Qt Positioning QML Types}{for QML}
- \li \l {Qt Positioning C++ Classes}{for C++}
-\row
- \li Position plugins:
+\section1 Articles and Guides
+
+\list
+ \li \l {Positioning (C++)} {Positioning introduction for C++}
+ \li \l {Positioning (QML)} {Positioning introduction for QML}
\li \l {Qt Positioning Plugins}
-\endtable
+\endlist
+
+\section1 Reference
+
+\list
+ \li \l {Qt Positioning C++ Classes}
+ \li \l {Qt Positioning QML Types}
+\endlist
-\section2 Examples
+\section1 Examples
\list
- \li \l {GeoFlickr (QML)}
- \li \l {Log File Position Source (C++)}
- \li \l {SatelliteInfo (C++/QML)}
- \li \l {Weather Info (C++/QML)}
+ \li \l {Qt Positioning Examples}
\endlist
+
*/