summaryrefslogtreecommitdiff
path: root/src/location
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@qt.io>2019-04-24 12:09:21 +0200
committerNico Vertriest <nico.vertriest@qt.io>2019-09-30 15:32:53 +0200
commit118dac89625a8f713bb12e7e9f30bc37b10754b7 (patch)
tree225cb44de661c2c2c24af1cf5675df8122257d43 /src/location
parent720beeb3f768af5e89538dfe0429e31138e84e3c (diff)
downloadqtlocation-118dac89625a8f713bb12e7e9f30bc37b10754b7.tar.gz
Doc: Fix link errors and complete parameter specs
Change-Id: I786ab35a0e9c8dfa2c8124692289d98e8eee4a8d Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/location')
-rw-r--r--src/location/declarativemaps/qdeclarativegeoroute.cpp6
-rw-r--r--src/location/declarativemaps/qdeclarativegeoroutemodel.cpp29
-rw-r--r--src/location/declarativemaps/qdeclarativepolygonmapitem.cpp2
-rw-r--r--src/location/declarativemaps/qdeclarativepolylinemapitem.cpp2
-rw-r--r--src/location/doc/qtlocation.qdocconf2
5 files changed, 22 insertions, 19 deletions
diff --git a/src/location/declarativemaps/qdeclarativegeoroute.cpp b/src/location/declarativemaps/qdeclarativegeoroute.cpp
index 8f5ec5fe..3837272e 100644
--- a/src/location/declarativemaps/qdeclarativegeoroute.cpp
+++ b/src/location/declarativemaps/qdeclarativegeoroute.cpp
@@ -383,9 +383,9 @@ QQmlPropertyMap *QDeclarativeGeoRoute::extendedAttributes() const
/*!
\qmlmethod bool QtLocation::Route::equals(Route other)
- This method performs a deep comparison between this route and \a other.
-
- Returns \c true if the routes are considered equal, \c false otherwise.
+ This method performs deep comparison if the present route
+ is identical to the \a other route.
+ Returns \c true if the routes are equal.
\since 5.12
*/
diff --git a/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp b/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp
index 695f6972..6401ba3e 100644
--- a/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp
+++ b/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp
@@ -115,8 +115,9 @@ static QList<QVariantMap> waypointMetadata(const QList<QDeclarativeGeoWaypoint *
geographic routes from a backend provider. Routes include data about driving
directions between two points, walking directions with multiple waypoints,
and various other similar concepts. It functions much like other Model
- types in QML (see for example \l {Models and Views in Qt Quick#Models}{ListModel}),
- and interacts with views such as \l MapItemView, and \l{ListView}.
+ types in QML (see for example \l {Models and Views in Qt Quick#Models}{ListModel}
+ and \l {QtQuick.XmlListModel::XmlListModel}{XmlListModel}), and interacts with
+ views such as \l MapItemView, and \l{ListView}.
Like \l Map and \l GeocodeModel, all the data for a RouteModel to work comes
from a services plugin. This is contained in the \l{plugin} property, and
@@ -241,11 +242,12 @@ void QDeclarativeGeoRouteModel::cancel()
/*!
\qmlmethod Route QtLocation::RouteModel::get(int index)
- 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).
+ Returns the Route at the specified index \a int. Use the \l count
+ property to check the amount of routes available. The routes
+ are indexed from zero, so the accessible range is 0...(count - 1).
- If you access out of bounds, a zero (null object) is returned and a warning is issued.
+ If you access out of bounds, a zero (null object) is returned and
+ a warning is issued.
*/
QDeclarativeGeoRoute *QDeclarativeGeoRouteModel::get(int index)
@@ -991,8 +993,9 @@ void QDeclarativeGeoRouteQuery::setExcludedAreas(const QJSValue &value)
/*!
\qmlmethod void QtLocation::RouteQuery::addExcludedArea(georectangle area)
- Adds the given \a area to excluded areas (areas that the route must not cross).
- Same area can only be added once.
+ Adds the specified \a georectangle from the excluded areas
+ (areas that the route must not cross).
+ The same area can only be added once.
\sa removeExcludedArea, clearExcludedAreas
*/
@@ -1115,9 +1118,9 @@ void QDeclarativeGeoRouteQuery::addWaypoint(const QVariant &waypoint)
/*!
\qmlmethod void QtLocation::RouteQuery::removeWaypoint(coordinate)
- 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.
+ 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
*/
@@ -1195,8 +1198,8 @@ void QDeclarativeGeoRouteQuery::flushWaypoints(QList<QDeclarativeGeoWaypoint *>
/*!
\qmlmethod void QtLocation::RouteQuery::setFeatureWeight(FeatureType feature, FeatureWeight weight)
- Defines the \a weight to associate with a \a feature during the planning of a
- route.
+ Defines the weight (\a FeatureWeight) to associate with a feature
+ (\a FeatureType) 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 fcfa14a5..7e988775 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 \a coordinate to the path.
+ Adds the specified \a coordinate to the path.
\sa removeCoordinate, path
*/
diff --git a/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp b/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp
index 63146fbc..4da98516 100644
--- a/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp
+++ b/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp
@@ -849,7 +849,7 @@ int QDeclarativePolylineMapItem::pathLength() const
/*!
\qmlmethod void MapPolyline::addCoordinate(coordinate)
- Adds a \a coordinate to the end of the path.
+ Adds the specified \a coordinate to the end of the path.
\sa insertCoordinate, removeCoordinate, path
*/
diff --git a/src/location/doc/qtlocation.qdocconf b/src/location/doc/qtlocation.qdocconf
index 0ffbe4d6..e5cf230b 100644
--- a/src/location/doc/qtlocation.qdocconf
+++ b/src/location/doc/qtlocation.qdocconf
@@ -33,7 +33,7 @@ qhp.QtLocation.subprojects.examples.selectors = fake:example
tagfile = ../../../doc/qtlocation/qtlocation.tags
-depends += qtcore qtdoc qtgui qtquick qtqml qtnetwork qtpositioning qtquickcontrols qtlinguist qtxmlpatterns
+depends += qtcore qtdoc qtgui qtquick qtqml qtnetwork qtpositioning qtquickcontrols qtlinguist
headerdirs += .. \
../../imports/location