summaryrefslogtreecommitdiff
path: root/src/imports/positioning
diff options
context:
space:
mode:
authorPaolo Angelelli <paolo.angelelli@qt.io>2017-04-07 12:43:47 +0200
committerPaolo Angelelli <paolo.angelelli@qt.io>2017-04-10 13:05:16 +0000
commit8e61494da8ff9c36d09faf3ced09bbe79a719f2d (patch)
tree37d96d157d1c298494d9dd79270245b1307acc12 /src/imports/positioning
parent4a4e4ace4582b4e769f9ffdcf1527976e7c76273 (diff)
downloadqtlocation-8e61494da8ff9c36d09faf3ced09bbe79a719f2d.tar.gz
Add geopath qml basic type documentation
Change-Id: I4f0b09cb8aac0b4d4f2d27cf350a30b7ed800f11 Reviewed-by: Nico Vertriest <nico.vertriest@qt.io> Reviewed-by: Alex Blasche <alexander.blasche@qt.io> Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/imports/positioning')
-rw-r--r--src/imports/positioning/positioning.cpp32
1 files changed, 32 insertions, 0 deletions
diff --git a/src/imports/positioning/positioning.cpp b/src/imports/positioning/positioning.cpp
index f00a4ae6..41242850 100644
--- a/src/imports/positioning/positioning.cpp
+++ b/src/imports/positioning/positioning.cpp
@@ -495,6 +495,38 @@ QT_BEGIN_NAMESPACE
The default value for the radius is -1 indicating an invalid geocircle area.
*/
+/*!
+ \qmlbasictype geopath
+ \inqmlmodule QtPositioning
+ \ingroup qml-QtPositioning5-basictypes
+ \since 5.9
+
+ \brief The geopath type represents a geographic path.
+
+ The \c geopath type is a \l {geoshape} that represents a geographic
+ path. It is a direct representation of a \l QGeoPath and is defined
+ in terms of a \l {path} which holds the list of geo coordinates in the
+ path.
+
+ The path is considered invalid if it is empty.
+
+ When integrating with C++, note that any QGeoPath value passed into QML from C++ is
+ automatically converted into a \c geopath value, and vice versa.
+
+ \section1 Properties
+
+ \section2 path
+
+ This property holds the list of coordinates defining the path.
+
+ \section2 width
+
+ This property holds the width of the path in meters. This is currently only used
+ when calling the \l {geoshape.contains} method.
+
+ The default value for the width is 0.
+*/
+
static QObject *singleton_type_factory(QQmlEngine *engine, QJSEngine *jsEngine)
{
Q_UNUSED(engine)