summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2019-05-15 11:25:30 +0200
committerTopi Reiniƶ <topi.reinio@qt.io>2019-05-16 08:07:18 +0000
commit90defc33dceb341aa8dac03c0511b1ef2a20c6c2 (patch)
treed33bc5a8991bfd68df70e9a350aa78f70cc13d3d
parent190909eb1e537f9840b38eff47713281edc8a204 (diff)
downloadqtlocation-90defc33dceb341aa8dac03c0511b1ef2a20c6c2.tar.gz
Doc: Fix documentation issues
Fix various documentation-related issues, including missing parameter documentation, broken links, and typos. Do some minor language editing. Change-Id: I0a8f8457e0d1ab56b4fc4670376509adf1fd26a3 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
-rw-r--r--examples/location/itemview_transitions/doc/images/itemview_transitions.jpg (renamed from examples/location/itemview_transitions/doc/images/itemview_trasitions.jpg)bin87618 -> 87618 bytes
-rw-r--r--examples/location/itemview_transitions/doc/src/itemview_transitions.qdoc2
-rw-r--r--src/location/declarativemaps/qdeclarativegeocodemodel.cpp4
-rw-r--r--src/location/declarativemaps/qdeclarativegeomap.cpp12
-rw-r--r--src/location/declarativemaps/qdeclarativegeoroute.cpp4
-rw-r--r--src/location/declarativemaps/qdeclarativegeoroutemodel.cpp22
-rw-r--r--src/location/declarativemaps/qdeclarativepolygonmapitem.cpp2
-rw-r--r--src/location/declarativemaps/qdeclarativepolylinemapitem.cpp4
-rw-r--r--src/location/declarativemaps/qquickgeomapgesturearea.cpp67
-rw-r--r--src/location/declarativeplaces/qdeclarativeplace.cpp4
-rw-r--r--src/location/labs/qdeclarativenavigator.cpp110
-rw-r--r--src/location/maps/qgeoroute.cpp4
-rw-r--r--src/location/maps/qgeorouterequest.cpp8
-rw-r--r--src/location/maps/qgeoserviceprovider.cpp2
14 files changed, 154 insertions, 91 deletions
diff --git a/examples/location/itemview_transitions/doc/images/itemview_trasitions.jpg b/examples/location/itemview_transitions/doc/images/itemview_transitions.jpg
index f177e142..f177e142 100644
--- a/examples/location/itemview_transitions/doc/images/itemview_trasitions.jpg
+++ b/examples/location/itemview_transitions/doc/images/itemview_transitions.jpg
Binary files differ
diff --git a/examples/location/itemview_transitions/doc/src/itemview_transitions.qdoc b/examples/location/itemview_transitions/doc/src/itemview_transitions.qdoc
index 735deb85..bbac69a3 100644
--- a/examples/location/itemview_transitions/doc/src/itemview_transitions.qdoc
+++ b/examples/location/itemview_transitions/doc/src/itemview_transitions.qdoc
@@ -29,7 +29,7 @@
\example itemview_transitions
\title MapItemView Transitions (QML)
\ingroup qtlocation-examples
-\brief How to use transitions together with MapItemView
+\brief How to use transitions together with MapItemView.
\image itemview_transitions.jpg
\e {MapItemView Transitions} demonstrates how to use the \l{Map} item to render a map.
diff --git a/src/location/declarativemaps/qdeclarativegeocodemodel.cpp b/src/location/declarativemaps/qdeclarativegeocodemodel.cpp
index 3e1cca30..b9eaaa08 100644
--- a/src/location/declarativemaps/qdeclarativegeocodemodel.cpp
+++ b/src/location/declarativemaps/qdeclarativegeocodemodel.cpp
@@ -526,9 +526,9 @@ int QDeclarativeGeocodeModel::count() const
}
/*!
- \qmlmethod Location QtLocation::GeocodeModel::get(int)
+ \qmlmethod Location QtLocation::GeocodeModel::get(int index)
- Returns the \l [QML] {Location} at given index. Use \l count property to check the
+ Returns the \l [QML] {Location} at given \a index. Use \l count property to check the
amount of locations available. The locations are indexed from zero, so the accessible range
is 0...(count - 1).
diff --git a/src/location/declarativemaps/qdeclarativegeomap.cpp b/src/location/declarativemaps/qdeclarativegeomap.cpp
index 1b5ea11c..5997bd3e 100644
--- a/src/location/declarativemaps/qdeclarativegeomap.cpp
+++ b/src/location/declarativemaps/qdeclarativegeomap.cpp
@@ -1505,7 +1505,7 @@ void QDeclarativeGeoMap::alignCoordinateToPoint(const QGeoCoordinate &coordinate
Returns the coordinate which corresponds to the \a position relative to the map item.
- If \a cliptoViewPort is \c true, or not supplied then returns an invalid coordinate if
+ If \a clipToViewPort is \c true, or not supplied then returns an invalid coordinate if
\a position is not within the current viewport.
*/
QGeoCoordinate QDeclarativeGeoMap::toCoordinate(const QPointF &position, bool clipToViewPort) const
@@ -1521,7 +1521,7 @@ QGeoCoordinate QDeclarativeGeoMap::toCoordinate(const QPointF &position, bool cl
Returns the position relative to the map item which corresponds to the \a coordinate.
- If \a cliptoViewPort is \c true, or not supplied then returns an invalid QPointF if
+ If \a clipToViewPort is \c true, or not supplied then returns an invalid QPointF if
\a coordinate is not within the current viewport.
*/
QPointF QDeclarativeGeoMap::fromCoordinate(const QGeoCoordinate &coordinate, bool clipToViewPort) const
@@ -1585,8 +1585,8 @@ void QDeclarativeGeoMap::clearData()
/*!
\qmlmethod void QtLocation::Map::fitViewportToGeoShape(geoShape, margins)
- Fits the viewport to a specific geo shape.
- The margins are in screen pixels.
+ Fits the viewport to a specific geo shape \a geoShape.
+ The \a margins are in screen pixels.
\note If the projection used by the plugin is not WebMercator, and the plugin does not have fitting to
shape capability, this method will do nothing.
@@ -1760,7 +1760,7 @@ void QDeclarativeGeoMap::onCameraDataChanged(const QGeoCameraData &cameraData)
/*!
\qmlmethod void QtLocation::Map::addMapParameter(MapParameter parameter)
- Adds a MapParameter object to the map. The effect of this call is dependent
+ Adds the \a parameter object to the map. The effect of this call is dependent
on the combination of the content of the MapParameter and the type of
underlying QGeoMap. If a MapParameter that is not supported by the underlying
QGeoMap gets added, the call has no effect.
@@ -1790,7 +1790,7 @@ void QDeclarativeGeoMap::addMapParameter(QDeclarativeGeoMapParameter *parameter)
/*!
\qmlmethod void QtLocation::Map::removeMapParameter(MapParameter parameter)
- Removes the given MapParameter object from the map.
+ Removes the given \a parameter object from the map.
The release of this API with Qt 5.9 is a Technology Preview.
diff --git a/src/location/declarativemaps/qdeclarativegeoroute.cpp b/src/location/declarativemaps/qdeclarativegeoroute.cpp
index 64aeb656..8f5ec5fe 100644
--- a/src/location/declarativemaps/qdeclarativegeoroute.cpp
+++ b/src/location/declarativemaps/qdeclarativegeoroute.cpp
@@ -383,7 +383,9 @@ QQmlPropertyMap *QDeclarativeGeoRoute::extendedAttributes() const
/*!
\qmlmethod bool QtLocation::Route::equals(Route other)
- This method performs deep comparison.
+ This method performs a deep comparison between this route and \a other.
+
+ Returns \c true if the routes are considered equal, \c false otherwise.
\since 5.12
*/
diff --git a/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp b/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp
index 4be64642..695f6972 100644
--- a/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp
+++ b/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp
@@ -239,9 +239,9 @@ void QDeclarativeGeoRouteModel::cancel()
}
/*!
- \qmlmethod Route QtLocation::RouteModel::get(int)
+ \qmlmethod Route QtLocation::RouteModel::get(int index)
- Returns the Route at given index. Use \l count property to check the
+ Returns the Route at given \a index. Use \l count property to check the
amount of routes available. The routes are indexed from zero, so the accessible range
is 0...(count - 1).
@@ -989,9 +989,9 @@ void QDeclarativeGeoRouteQuery::setExcludedAreas(const QJSValue &value)
}
/*!
- \qmlmethod void QtLocation::RouteQuery::addExcludedArea(georectangle)
+ \qmlmethod void QtLocation::RouteQuery::addExcludedArea(georectangle area)
- Adds the given area to excluded areas (areas that the route must not cross).
+ Adds the given \a area to excluded areas (areas that the route must not cross).
Same area can only be added once.
\sa removeExcludedArea, clearExcludedAreas
@@ -1019,9 +1019,9 @@ void QDeclarativeGeoRouteQuery::addExcludedArea(const QGeoRectangle &area)
}
/*!
- \qmlmethod void QtLocation::RouteQuery::removeExcludedArea(georectangle)
+ \qmlmethod void QtLocation::RouteQuery::removeExcludedArea(georectangle area)
- Removes the given area to excluded areas (areas that the route must not cross).
+ Removes the given \a area from excluded areas (areas that the route must not cross).
\sa addExcludedArea, clearExcludedAreas
*/
@@ -1115,9 +1115,9 @@ void QDeclarativeGeoRouteQuery::addWaypoint(const QVariant &waypoint)
/*!
\qmlmethod void QtLocation::RouteQuery::removeWaypoint(coordinate)
- Removes the given from the list of waypoints. In case same coordinate
- appears multiple times, the most recently added coordinate instance is
- removed.
+ Removes the given \a coordinate from the list of waypoints. If the same
+ coordinate appears multiple times, the most recently added coordinate
+ instance is removed.
\sa addWaypoint, clearWaypoints
*/
@@ -1193,9 +1193,9 @@ void QDeclarativeGeoRouteQuery::flushWaypoints(QList<QDeclarativeGeoWaypoint *>
}
/*!
- \qmlmethod void QtLocation::RouteQuery::setFeatureWeight(FeatureType, FeatureWeight)
+ \qmlmethod void QtLocation::RouteQuery::setFeatureWeight(FeatureType feature, FeatureWeight weight)
- Defines the weight to associate with a feature during the planning of a
+ Defines the \a weight to associate with a \a feature during the planning of a
route.
Following lists the possible feature weights:
diff --git a/src/location/declarativemaps/qdeclarativepolygonmapitem.cpp b/src/location/declarativemaps/qdeclarativepolygonmapitem.cpp
index 6da4d96f..fcfa14a5 100644
--- a/src/location/declarativemaps/qdeclarativepolygonmapitem.cpp
+++ b/src/location/declarativemaps/qdeclarativepolygonmapitem.cpp
@@ -402,7 +402,7 @@ void QDeclarativePolygonMapItem::setPath(const QJSValue &value)
/*!
\qmlmethod void MapPolygon::addCoordinate(coordinate)
- Adds a coordinate to the path.
+ Adds a \a coordinate to the path.
\sa removeCoordinate, path
*/
diff --git a/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp b/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp
index 1751dedd..63146fbc 100644
--- a/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp
+++ b/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp
@@ -798,7 +798,7 @@ void QDeclarativePolylineMapItem::setPath(const QJSValue &value)
/*!
\qmlmethod int MapPolyline::setPath(geopath path)
- Sets the \l path using a \l QGeoPath type.
+ Sets the \a path using a geopath type.
\since 5.10
@@ -849,7 +849,7 @@ int QDeclarativePolylineMapItem::pathLength() const
/*!
\qmlmethod void MapPolyline::addCoordinate(coordinate)
- Adds a coordinate to the end of the path.
+ Adds a \a coordinate to the end of the path.
\sa insertCoordinate, removeCoordinate, path
*/
diff --git a/src/location/declarativemaps/qquickgeomapgesturearea.cpp b/src/location/declarativemaps/qquickgeomapgesturearea.cpp
index 88a766f5..13315917 100644
--- a/src/location/declarativemaps/qquickgeomapgesturearea.cpp
+++ b/src/location/declarativemaps/qquickgeomapgesturearea.cpp
@@ -339,6 +339,8 @@ QT_BEGIN_NAMESPACE
This signal is emitted when a pinch gesture is started.
+ Information about the pinch event is provided in \a event.
+
The corresponding handler is \c onPinchStarted.
\sa pinchUpdated, pinchFinished
@@ -350,6 +352,8 @@ QT_BEGIN_NAMESPACE
This signal is emitted as the user's fingers move across the map,
after the \l pinchStarted signal is emitted.
+ Information about the pinch event is provided in \a event.
+
The corresponding handler is \c onPinchUpdated.
\sa pinchStarted, pinchFinished
@@ -360,6 +364,8 @@ QT_BEGIN_NAMESPACE
This signal is emitted at the end of a pinch gesture.
+ Information about the pinch event is provided in \a event.
+
The corresponding handler is \c onPinchFinished.
\sa pinchStarted, pinchUpdated
@@ -411,9 +417,11 @@ QT_BEGIN_NAMESPACE
This signal is emitted when a two-finger rotation gesture is started.
+ Information about the pinch event is provided in \a event.
+
The corresponding handler is \c onRotationStarted.
- \sa rotationUpdated, rotationFinished
+ \sa rotationUpdated(), rotationFinished()
\since QtLocation 5.9
*/
@@ -422,11 +430,13 @@ QT_BEGIN_NAMESPACE
\qmlsignal QtLocation::MapGestureArea::rotationUpdated(PinchEvent event)
This signal is emitted as the user's fingers move across the map,
- after the \l rotationStarted signal is emitted.
+ after the \l rotationStarted() signal is emitted.
+
+ Information about the pinch event is provided in \a event.
The corresponding handler is \c onRotationUpdated.
- \sa rotationStarted, rotationFinished
+ \sa rotationStarted(), rotationFinished()
\since QtLocation 5.9
*/
@@ -436,9 +446,11 @@ QT_BEGIN_NAMESPACE
This signal is emitted at the end of a two-finger rotation gesture.
+ Information about the pinch event is provided in \a event.
+
The corresponding handler is \c onRotationFinished.
- \sa rotationStarted, rotationUpdated
+ \sa rotationStarted(), rotationUpdated()
\since QtLocation 5.9
*/
@@ -448,9 +460,11 @@ QT_BEGIN_NAMESPACE
This signal is emitted when a two-finger tilt gesture is started.
+ Information about the pinch event is provided in \a event.
+
The corresponding handler is \c onTiltStarted.
- \sa tiltUpdated, tiltFinished
+ \sa tiltUpdated(), tiltFinished()
\since QtLocation 5.9
*/
@@ -461,9 +475,11 @@ QT_BEGIN_NAMESPACE
This signal is emitted as the user's fingers move across the map,
after the \l tiltStarted signal is emitted.
+ Information about the pinch event is provided in \a event.
+
The corresponding handler is \c onTiltUpdated.
- \sa tiltStarted, tiltFinished
+ \sa tiltStarted(), tiltFinished()
\since QtLocation 5.9
*/
@@ -473,9 +489,11 @@ QT_BEGIN_NAMESPACE
This signal is emitted at the end of a two-finger tilt gesture.
+ Information about the pinch event is provided in \a event.
+
The corresponding handler is \c onTiltFinished.
- \sa tiltStarted, tiltUpdated
+ \sa tiltStarted(), tiltUpdated()
\since QtLocation 5.9
*/
@@ -521,12 +539,12 @@ void QQuickGeoMapGestureArea::setMap(QGeoMap *map)
and touch events, such as Flickable, the mouse and touch events
may be stolen from the MapGestureArea if a gesture is recognized
by the parent item, e.g. a flick gesture. If preventStealing is
- set to true, no item will steal the mouse and touch events.
+ set to \c true, no item will steal the mouse and touch events.
- Note that setting preventStealing to true once an item has started
- stealing events will have no effect until the next press event.
+ Note that setting preventStealing to \c true once an item has started
+ stealing events has no effect until the next press event.
- By default this property is false.
+ By default this property is set to \c false.
*/
bool QQuickGeoMapGestureArea::preventStealing() const
@@ -551,17 +569,26 @@ QQuickGeoMapGestureArea::~QQuickGeoMapGestureArea()
/*!
\qmlproperty enumeration QtLocation::MapGestureArea::acceptedGestures
- This property holds the gestures that will be active. By default
+ This property holds a bit field of gestures that are accepted. By default,
all gestures are enabled.
- \list
- \li MapGestureArea.NoGesture - Don't support any additional gestures (value: 0x0000).
- \li MapGestureArea.PinchGesture - Support the map pinch gesture (value: 0x0001).
- \li MapGestureArea.PanGesture - Support the map pan gesture (value: 0x0002).
- \li MapGestureArea.FlickGesture - Support the map flick gesture (value: 0x0004).
- \li MapGestureArea.RotationGesture - Support the map rotation gesture (value: 0x0008).
- \li MapGestureArea.TiltGesture - Support the map tilt gesture (value: 0x0010).
- \endlist
+ \value MapGestureArea.NoGesture
+ Don't support any additional gestures (value: 0x0000).
+
+ \value MapGestureArea.PinchGesture
+ Support the map pinch gesture (value: 0x0001).
+
+ \value MapGestureArea.PanGesture
+ Support the map pan gesture (value: 0x0002).
+
+ \value MapGestureArea.FlickGesture
+ Support the map flick gesture (value: 0x0004).
+
+ \value MapGestureArea.RotationGesture
+ Support the map rotation gesture (value: 0x0008).
+
+ \value MapGestureArea.TiltGesture
+ Support the map tilt gesture (value: 0x0010).
*/
QQuickGeoMapGestureArea::AcceptedGestures QQuickGeoMapGestureArea::acceptedGestures() const
diff --git a/src/location/declarativeplaces/qdeclarativeplace.cpp b/src/location/declarativeplaces/qdeclarativeplace.cpp
index 7ab40fea..89027d0e 100644
--- a/src/location/declarativeplaces/qdeclarativeplace.cpp
+++ b/src/location/declarativeplaces/qdeclarativeplace.cpp
@@ -1060,8 +1060,8 @@ void QDeclarativePlace::copyFrom(QDeclarativePlace *original)
\qmlmethod void Place::initializeFavorite(Plugin destinationPlugin)
Creates a favorite instance for the place which is to be saved into the
- \a destination plugin. This method does nothing if the favorite property is
- not null.
+ destination plugin \a destinationPlugin. This method does nothing if the
+ favorite property is not \c null.
*/
void QDeclarativePlace::initializeFavorite(QDeclarativeGeoServiceProvider *plugin)
{
diff --git a/src/location/labs/qdeclarativenavigator.cpp b/src/location/labs/qdeclarativenavigator.cpp
index eccfd082..3fc9fb88 100644
--- a/src/location/labs/qdeclarativenavigator.cpp
+++ b/src/location/labs/qdeclarativenavigator.cpp
@@ -159,19 +159,26 @@ QT_BEGIN_NAMESPACE
/*!
\qmlproperty enumeration Qt.labs.location::Navigator::error
+ \readonly
This read-only property holds the latest error value of the geocoding request.
- \list
- \li Navigator.NoError - No error has occurred.
- \li GeocodeModel.NotSupportedError - Navigation is not supported by the service provider.
- \li GeocodeModel.ConnectionError - An error occurred while communicating with the service provider.
- \li GeocodeModel.LoaderError - The geoservice provider library could not be loaded. Setting QT_DEBUG_PLUGINS environment variable may help diagnosing the reason.
- \li GeocodeModel.UnknownParameterError - An unknown parameter was specified
- \li GeocodeModel.MissingRequiredParameterError - required parameter was not specified.
- \li GeocodeModel.UnknownError - An error occurred which does not fit into any of the other categories.
-
- \endlist
+ \value Navigator.NoError
+ No error has occurred.
+ \value Navigator.NotSupportedError
+ Navigation is not supported by the service provider.
+ \value Navigator.ConnectionError
+ An error occurred while communicating with the service provider.
+ \value Navigator.LoaderError
+ The geoservice provider library could not be loaded. Setting
+ QT_DEBUG_PLUGINS environment variable may help diagnosing the
+ problem.
+ \value Navigator.UnknownParameterError
+ An unknown parameter was specified.
+ \value Navigator.MissingRequiredParameterError
+ Required parameter was not specified.
+ \value Navigator.UnknownError
+ Unknown error occurred.
*/
QDeclarativeNavigatorPrivate::QDeclarativeNavigatorPrivate(QParameterizableObject *q_)
@@ -322,7 +329,8 @@ QString QDeclarativeNavigator::errorString() const
This object can carry engine-specific properties, signals and methods, to expose
engine-specific features and data.
- \note Using this property leads to writing code that won't work with different plugins.
+ \warning Using this property leads to writing code that's likely to work
+ with only a single plugin.
*/
QAbstractNavigator *QDeclarativeNavigator::abstractNavigator() const
{
@@ -502,6 +510,7 @@ QDeclarativeNavigationBasicDirections::QDeclarativeNavigationBasicDirections(QDe
/*!
\qmlpropertygroup Qt.labs.location::Navigator::directions
+ \readonly
\qmlproperty Variant Qt.labs.location::Navigator::directions.nextManeuverIcon
\qmlproperty real Qt.labs.location::Navigator::directions.distanceToNextManeuver
\qmlproperty real Qt.labs.location::Navigator::directions.remainingTravelDistance
@@ -515,41 +524,64 @@ QDeclarativeNavigationBasicDirections::QDeclarativeNavigationBasicDirections(QDe
\qmlproperty RouteLeg Qt.labs.location::Navigator::directions.currentRouteLeg
\qmlproperty int Qt.labs.location::Navigator::directions.currentSegment
- \qmlsignal Qt.labs.location::Navigator::directions.waypointReached(Waypoint waypoint)
- \qmlsignal Qt.labs.location::Navigator::directions.destinationReached()
+ These read-only properties are part of the \e directions property group.
+ This property group holds the navigation progress information that can be
+ used to access the route data and to extract directions.
- These read-only properties are part of the directions property group.
- The directions property group holds the navigation progress information
- that can be used to access the route data and to extract directions.
-
- \note specific backends might not provide (some of) these information.
+ \note Some backends might not provide a full set of navigation progress
+ information.
\list
- \li The \l nextManeuverIcon property holds the next turn icon.
- \li The \l distanceToNextManeuver property holds the distance to the next maneuver, in meters.
- \li The \l remainingTravelDistance property holds the remaining travel distance, in meters.
- \li The \l remainingTravelDistanceToNextWaypoint property holds the remaining travel distance to the next waypoint, in meters.
- \li The \l traveledDistance property holds the traveled distance, in meters.
- \li The \l timeToNextManeuver property holds the time to the next maneuver, in milliseconds.
- \li The \l remainingTravelTime property holds the remaining travel time, in milliseconds.
- \li The \l remainingTravelTimeToNextWaypoint property holds the remaining travel time to the next waypoint, in milliseconds.
- \li The \l traveledTime property holds the traveled time, in milliseconds.
- \li The \l currentRoute property olds the current route the navigator is following. This can be the same as \l route, or can be different, if the navigator
- cannot follow the user-specified route. For example if the position coming from \l positionSource is considerably
- off route, the navigation engine might recalculate and start following a
- new route.
- \li The \l currentRouteSegment property holds the current route leg the navigator is following.
- This is always a part of \l currentRoute, and so the property \l RouteLeg::overallRoute
- of currentRouteLeg will hold the same route as \l currentRoute.
- \li The \l currentSegment property holds the index of the current RouteSegment in the \l currentRoute.
- \li The \l waypointReached signal is emitted when the waypoint \e waypoint has been reached.
- \li The \l destinationReached signal is emitted when the last waypoint of the route, the destination,
- has been reached.
+ \li The \c nextManeuverIcon property holds the next turn icon.
+ \li The \c distanceToNextManeuver property holds the distance to the
+ next maneuver, in meters.
+ \li The \c remainingTravelDistance property holds the remaining travel
+ distance, in meters.
+ \li The \c remainingTravelDistanceToNextWaypoint property holds the
+ remaining travel distance to the next waypoint, in meters.
+ \li The \c traveledDistance property holds the traveled distance, in
+ meters.
+ \li The \c timeToNextManeuver property holds the time to the next
+ maneuver, in milliseconds.
+ \li The \c remainingTravelTime property holds the remaining travel
+ time, in milliseconds.
+ \li The \c remainingTravelTimeToNextWaypoint property holds the
+ remaining travel time to the next waypoint, in milliseconds.
+ \li The \c traveledTime property holds the traveled time, in
+ milliseconds.
+ \li The \c currentRoute property holds the current route the navigator
+ is following. This can be the same as \l route, or can be
+ different, if the navigator cannot follow the user-specified route.
+ For example, if the position coming from \l positionSource is
+ considerably off route, the navigation engine may recalculate and
+ start to follow a new route.
+ \li The \c currentRouteLeg property holds the current route leg the
+ navigator is following. This is always a part of \c currentRoute,
+ so the \l {RouteLeg::}{overallRoute} property of \c currentRouteLeg
+ holds the same route as \c currentRoute.
+ \li The \c currentSegment property holds the index of the current
+ RouteSegment in the \c currentRoute.
\endlist
- \sa Route, RouteLeg, RouteSegment, Waypoint
+ \sa directions.waypointReached(), directions.destinationReached(), Route, RouteLeg, RouteSegment, Waypoint
*/
+/*!
+ \qmlsignal Qt.labs.location::Navigator::directions.waypointReached(Waypoint waypoint)
+
+ This signal is emitted when a \a waypoint has been reached.
+
+ \sa directions, directions.destinationReached()
+*/
+
+/*!
+ \qmlsignal Qt.labs.location::Navigator::directions.destinationReached()
+
+ This signal is emitted when the last waypoint of the route, the
+ destination, has been reached.
+
+ \sa directions, directions.waypointReached()
+*/
QVariant QDeclarativeNavigationBasicDirections::nextManeuverIcon() const
{
if (m_navigatorPrivate->m_navigator)
diff --git a/src/location/maps/qgeoroute.cpp b/src/location/maps/qgeoroute.cpp
index ffa9a496..5a9b2e4b 100644
--- a/src/location/maps/qgeoroute.cpp
+++ b/src/location/maps/qgeoroute.cpp
@@ -300,7 +300,7 @@ QList<QGeoCoordinate> QGeoRoute::path() const
}
/*!
- Sets the route legs for a multi-waypoint route.
+ Sets the route \a legs for a multi-waypoint route.
\sa QGeoRouteLeg
\since 5.12
@@ -768,7 +768,7 @@ void QGeoRouteLeg::setOverallRoute(const QGeoRoute &route)
}
/*!
- Returns the \a route that contains this route leg.
+ Returns the route that contains this route leg.
*/
QGeoRoute QGeoRouteLeg::overallRoute() const
{
diff --git a/src/location/maps/qgeorouterequest.cpp b/src/location/maps/qgeorouterequest.cpp
index 412dc598..df0abd76 100644
--- a/src/location/maps/qgeorouterequest.cpp
+++ b/src/location/maps/qgeorouterequest.cpp
@@ -469,11 +469,11 @@ QGeoRouteRequest::ManeuverDetail QGeoRouteRequest::maneuverDetail() const
}
/*!
- Sets the departure time for the route calculation. This information can be used by
- the backend to calculate a faster route, for example by avoiding blockages present at
- given points in time.
+ Sets the departure time \a departureTime for the route calculation. This
+ information can be used by the backend to calculate a faster route, for
+ example, by avoiding traffic congestion during rush hour.
- The default value is an invalid \l QDateTime
+ The default value is an invalid QDateTime.
\since 5.13
*/
diff --git a/src/location/maps/qgeoserviceprovider.cpp b/src/location/maps/qgeoserviceprovider.cpp
index 1792b7c5..ec341c44 100644
--- a/src/location/maps/qgeoserviceprovider.cpp
+++ b/src/location/maps/qgeoserviceprovider.cpp
@@ -131,6 +131,8 @@ Q_GLOBAL_STATIC_WITH_ARGS(QFactoryLoader, loader,
The plugin did not find one of the parameters it was expecting.
\value ConnectionError
The plugin could not connect to its backend service or database.
+ \value LoaderError
+ The plugin failed to load.
*/
/*!