summaryrefslogtreecommitdiff
path: root/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2019-11-08 23:57:52 +0100
committerTopi Reinio <topi.reinio@qt.io>2019-11-14 12:14:14 +0100
commita467eadd46bec7a66e2e97bc4fd3a5271430bc93 (patch)
treeda0f988be1b020ea64c9cb66c09e80552e1afc90 /src/location/declarativemaps/qdeclarativegeoroutemodel.cpp
parent664a83674b2bf8313763870c9eca7c4c558a14bc (diff)
downloadqtlocation-a467eadd46bec7a66e2e97bc4fd3a5271430bc93.tar.gz
Doc: Fix documentation warnings
Fix missing/incorrect parameter documentation, linking warnings, and \instantiates references to undocumented/internal classes. Remove mention of Navigator::currentRoute, as such a property no longer exists. Fixes: QTBUG-79811 Change-Id: I048a13109aa19f3db75e76611473d60a2396f028 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/location/declarativemaps/qdeclarativegeoroutemodel.cpp')
-rw-r--r--src/location/declarativemaps/qdeclarativegeoroutemodel.cpp22
1 files changed, 13 insertions, 9 deletions
diff --git a/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp b/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp
index bbfa9b57..910e7026 100644
--- a/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp
+++ b/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp
@@ -244,7 +244,7 @@ void QDeclarativeGeoRouteModel::cancel()
/*!
\qmlmethod Route QtLocation::RouteModel::get(int index)
- Returns the Route at the specified index \a int. Use the \l count
+ Returns the Route at the specified \a index. 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).
@@ -995,7 +995,7 @@ void QDeclarativeGeoRouteQuery::setExcludedAreas(const QJSValue &value)
/*!
\qmlmethod void QtLocation::RouteQuery::addExcludedArea(georectangle area)
- Adds the specified \a georectangle from the excluded areas
+ Adds the specified georectangle \a area to the excluded areas
(areas that the route must not cross).
The same area can only be added once.
@@ -1200,25 +1200,29 @@ void QDeclarativeGeoRouteQuery::flushWaypoints(QList<QDeclarativeGeoWaypoint *>
/*!
\qmlmethod void QtLocation::RouteQuery::setFeatureWeight(FeatureType feature, FeatureWeight weight)
- Defines the weight (\a FeatureWeight) to associate with a feature
- (\a FeatureType) during the planning of a route.
+ Defines the \a weight to associate with a \a feature during the planning
+ of a route.
Following lists the possible feature weights:
\value RouteQuery.NeutralFeatureWeight
- The presence or absence of the feature will not affect the planning of the route
+ The presence or absence of the feature does not affect the planning of the
+ route
\value RouteQuery.PreferFeatureWeight
- Routes which contain the feature will be preferred over those that do not
+ Routes which contain the feature are preferred over those that do not
\value RouteQuery.RequireFeatureWeight
- Only routes which contain the feature will be considered, otherwise no route will be returned
+ Only routes which contain the feature are considered, otherwise no
+ route will be returned
\value RouteQuery.AvoidFeatureWeight
- Routes which do not contain the feature will be preferred over those that do
+ Routes which do not contain the feature are preferred over those that
+ do
\value RouteQuery.DisallowFeatureWeight
- Only routes which do not contain the feature will be considered, otherwise no route will be returned
+ Only routes which do not contain the feature are considered, otherwise
+ no route will be returned
\sa featureTypes, resetFeatureWeights, featureWeight