diff options
author | Paolo Angelelli <paolo.angelelli@qt.io> | 2018-03-21 16:44:53 +0100 |
---|---|---|
committer | Paolo Angelelli <paolo.angelelli@qt.io> | 2018-04-17 09:37:39 +0000 |
commit | cf75dcb405b0c467cbaf1749bb0f92ff57de3444 (patch) | |
tree | 55d9bdcb9ddb0bc7e931716dca05957b7666566c | |
parent | 58754abec49bcc5aa1b7663921d575deecda419b (diff) | |
download | qtlocation-cf75dcb405b0c467cbaf1749bb0f92ff57de3444.tar.gz |
Add documentation for QMapRouteObject
Change-Id: I0b78ec63e3474db9343094661932cb6a1f31728e
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
-rw-r--r-- | src/location/labs/qmaprouteobject.cpp | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/src/location/labs/qmaprouteobject.cpp b/src/location/labs/qmaprouteobject.cpp index 724bdb73..7e36322c 100644 --- a/src/location/labs/qmaprouteobject.cpp +++ b/src/location/labs/qmaprouteobject.cpp @@ -40,6 +40,19 @@ QT_BEGIN_NAMESPACE +/*! + \qmltype MapRouteObject + \instantiates QMapRouteObject + \inqmlmodule Qt.labs.location + \ingroup qml-QtLocation5-maps + \inherits QGeoMapObject + + \brief The MapRouteObject displays a geographical route on a Map. + + The MapRouteObject type displays a Route obtained through a RouteModel or + other means, on the Map as a Polyline following the path of the Route. +*/ + /* QGeoMapRoutePrivate @@ -72,6 +85,11 @@ QDeclarativeGeoRoute *QMapRouteObjectPrivate::declarativeGeoRoute() const return r->m_route; } +/*! + \qmlproperty Route Qt.labs.location::MapRouteObject::route + + This property holds the route to be drawn. +*/ QGeoRoute QMapRouteObjectPrivate::route() const { const QDeclarativeGeoRoute *r = declarativeGeoRoute(); |