summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2018-03-26 09:40:56 +0200
committerTopi Reiniƶ <topi.reinio@qt.io>2018-03-27 10:16:26 +0000
commitacc8bc079cda6a31a9d19dca860a1a2db378addf (patch)
treeba4062a266431d7724d528c89364e9c1dc2f2be2
parent0af62cbe7ddf6a6ef858daa63b0ab02426d3aad9 (diff)
downloadqtlocation-acc8bc079cda6a31a9d19dca860a1a2db378addf.tar.gz
Doc: Fix all documentation warnings
Fix multiple warnings caused by invalid documentation configuration, missing QML module specifiers, wrong QML type names, incorrect arguments for the \fn command, and missing documentation. Remove incorrect statement from the example usage of the Waypoint QML type. Use 'QtLocation' as the name for the module throughout the docs. Clang (used as the parser for QDoc in Qt 5.11) was unable to resolve the path for qlocation.h, causing QDoc to omit the QLocation namespace documentation. Fix this by including the file explicitly from qlocationglobal.h for documentation builds. Change-Id: I2bd790db1ff5ad96f0cdb415a682b97593b3a6dc Reviewed-by: Martin Smith <martin.smith@qt.io>
-rw-r--r--src/imports/positioning/locationsingleton.cpp16
-rw-r--r--src/location/declarativemaps/qdeclarativecirclemapitem.cpp2
-rw-r--r--src/location/declarativemaps/qdeclarativegeocodemodel.cpp2
-rw-r--r--src/location/declarativemaps/qdeclarativegeomaneuver.cpp2
-rw-r--r--src/location/declarativemaps/qdeclarativegeomap.cpp18
-rw-r--r--src/location/declarativemaps/qdeclarativegeomapcopyrightsnotice.cpp2
-rw-r--r--src/location/declarativemaps/qdeclarativegeomapitemgroup.cpp2
-rw-r--r--src/location/declarativemaps/qdeclarativegeomapitemview.cpp2
-rw-r--r--src/location/declarativemaps/qdeclarativegeomapparameter.cpp2
-rw-r--r--src/location/declarativemaps/qdeclarativegeomapquickitem.cpp2
-rw-r--r--src/location/declarativemaps/qdeclarativegeomaptype.cpp10
-rw-r--r--src/location/declarativemaps/qdeclarativegeoroute.cpp4
-rw-r--r--src/location/declarativemaps/qdeclarativegeoroutemodel.cpp104
-rw-r--r--src/location/declarativemaps/qdeclarativegeoroutesegment.cpp2
-rw-r--r--src/location/declarativemaps/qdeclarativegeoserviceprovider.cpp4
-rw-r--r--src/location/declarativemaps/qdeclarativepolygonmapitem.cpp2
-rw-r--r--src/location/declarativemaps/qdeclarativepolylinemapitem.cpp14
-rw-r--r--src/location/declarativemaps/qdeclarativerectanglemapitem.cpp2
-rw-r--r--src/location/declarativemaps/qdeclarativeroutemapitem.cpp2
-rw-r--r--src/location/declarativemaps/qquickgeomapgesturearea.cpp20
-rw-r--r--src/location/declarativeplaces/qdeclarativecategory.cpp2
-rw-r--r--src/location/declarativeplaces/qdeclarativecontactdetail.cpp4
-rw-r--r--src/location/declarativeplaces/qdeclarativeplace.cpp2
-rw-r--r--src/location/declarativeplaces/qdeclarativeplaceattribute.cpp4
-rw-r--r--src/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp2
-rw-r--r--src/location/declarativeplaces/qdeclarativeplaceicon.cpp2
-rw-r--r--src/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp2
-rw-r--r--src/location/declarativeplaces/qdeclarativeplaceuser.cpp2
-rw-r--r--src/location/declarativeplaces/qdeclarativeratings.cpp2
-rw-r--r--src/location/declarativeplaces/qdeclarativereviewmodel.cpp2
-rw-r--r--src/location/declarativeplaces/qdeclarativesearchresultmodel.cpp2
-rw-r--r--src/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp2
-rw-r--r--src/location/declarativeplaces/qdeclarativesupplier.cpp2
-rw-r--r--src/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp2
-rw-r--r--src/location/doc/qtlocation.qdocconf6
-rw-r--r--src/location/maps/qgeomaneuver.cpp2
-rw-r--r--src/location/maps/qgeoroute.cpp2
-rw-r--r--src/location/maps/qgeorouterequest.cpp4
-rw-r--r--src/location/places/qplace.cpp2
-rw-r--r--src/location/places/qplacecontent.cpp8
-rw-r--r--src/location/places/qplaceproposedsearchresult.cpp2
-rw-r--r--src/location/qlocationglobal.h4
-rw-r--r--src/plugins/geoservices/nokia/qgeotiledmap_nokia.cpp2
-rw-r--r--src/positioning/doc/qtpositioning.qdocconf6
-rw-r--r--src/positioning/doc/src/qml-position.qdoc10
-rw-r--r--src/positioning/qgeocircle.cpp4
-rw-r--r--src/positioning/qgeocoordinate.cpp20
-rw-r--r--src/positioning/qgeopath.cpp10
-rw-r--r--src/positioning/qgeopolygon.cpp8
-rw-r--r--src/positioning/qgeosatelliteinfo.cpp4
-rw-r--r--src/positioning/qgeoshape.cpp9
-rw-r--r--src/positioningquick/qdeclarativeposition.cpp2
-rw-r--r--src/positioningquick/qdeclarativepositionsource.cpp2
53 files changed, 200 insertions, 153 deletions
diff --git a/src/imports/positioning/locationsingleton.cpp b/src/imports/positioning/locationsingleton.cpp
index e9b58834..c4822bff 100644
--- a/src/imports/positioning/locationsingleton.cpp
+++ b/src/imports/positioning/locationsingleton.cpp
@@ -234,11 +234,11 @@ QGeoPath LocationSingleton::path(const QJSValue &value, qreal width) const
}
/*!
- \qmlmethod geopolygon QtPositioning::polygon() const
+ \qmlmethod geopath QtPositioning::polygon() const
- Constructs an empty geopolygon.
+ Constructs an empty polygon.
- \sa {geopolygon}
+ \sa {geopath}
\since 5.10
*/
QGeoPath LocationSingleton::polygon() const
@@ -247,11 +247,11 @@ QGeoPath LocationSingleton::polygon() const
}
/*!
- \qmlmethod geopolygon QtPositioning::polygon(list<coordinate> coordinates) const
+ \qmlmethod geopath QtPositioning::polygon(list<coordinate> coordinates) const
- Constructs a geopolygon from coordinates.
+ Constructs a polygon from coordinates.
- \sa {geopolygon}
+ \sa {geopath}
\since 5.10
*/
QGeoPath LocationSingleton::polygon(const QVariantList &coordinates) const
@@ -306,9 +306,9 @@ QGeoPath LocationSingleton::shapeToPath(const QGeoShape &shape) const
/*!
\qmlmethod geopath QtPositioning::shapeToPolygon(geoshape shape) const
- Converts \a shape to a geopolygon.
+ Converts \a shape to a polygon.
- \sa {geopolygon}
+ \sa {geopath}
\since 5.10
*/
QGeoPolygon LocationSingleton::shapeToPolygon(const QGeoShape &shape) const
diff --git a/src/location/declarativemaps/qdeclarativecirclemapitem.cpp b/src/location/declarativemaps/qdeclarativecirclemapitem.cpp
index 68e61ee5..03a6b9e6 100644
--- a/src/location/declarativemaps/qdeclarativecirclemapitem.cpp
+++ b/src/location/declarativemaps/qdeclarativecirclemapitem.cpp
@@ -65,7 +65,7 @@ QT_BEGIN_NAMESPACE
\instantiates QDeclarativeCircleMapItem
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-maps
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The MapCircle type displays a geographic circle on a Map.
diff --git a/src/location/declarativemaps/qdeclarativegeocodemodel.cpp b/src/location/declarativemaps/qdeclarativegeocodemodel.cpp
index 9a9a2555..43ce95a9 100644
--- a/src/location/declarativemaps/qdeclarativegeocodemodel.cpp
+++ b/src/location/declarativemaps/qdeclarativegeocodemodel.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
\instantiates QDeclarativeGeocodeModel
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-geocoding
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The GeocodeModel type provides support for searching operations
related to geographic information.
diff --git a/src/location/declarativemaps/qdeclarativegeomaneuver.cpp b/src/location/declarativemaps/qdeclarativegeomaneuver.cpp
index ef3639af..2c5a0f93 100644
--- a/src/location/declarativemaps/qdeclarativegeomaneuver.cpp
+++ b/src/location/declarativemaps/qdeclarativegeomaneuver.cpp
@@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE
\instantiates QDeclarativeGeoManeuver
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-routing
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The RouteManeuver type represents the information relevant to the
point at which two RouteSegments meet.
diff --git a/src/location/declarativemaps/qdeclarativegeomap.cpp b/src/location/declarativemaps/qdeclarativegeomap.cpp
index 5d0acede..17131c3d 100644
--- a/src/location/declarativemaps/qdeclarativegeomap.cpp
+++ b/src/location/declarativemaps/qdeclarativegeomap.cpp
@@ -76,7 +76,7 @@ static qreal sanitizeBearing(qreal bearing)
\instantiates QDeclarativeGeoMap
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-maps
- \since Qt Location 5.0
+ \since QtLocation 5.0
\brief The Map type displays a map.
@@ -947,7 +947,7 @@ qreal QDeclarativeGeoMap::zoomLevel() const
If the Plugin used for the Map supports bearing, the valid range for this value is between 0 and 360.
If the Plugin used for the Map does not support bearing, changing this property will have no effect.
- \since Qt Location 5.9
+ \since QtLocation 5.9
*/
void QDeclarativeGeoMap::setBearing(qreal bearing)
{
@@ -1015,7 +1015,7 @@ qreal QDeclarativeGeoMap::bearing() const
\sa minimumTilt, maximumTilt
- \since Qt Location 5.9
+ \since QtLocation 5.9
*/
void QDeclarativeGeoMap::setTilt(qreal tilt)
{
@@ -1067,7 +1067,7 @@ void QDeclarativeGeoMap::setMinimumTilt(qreal minimumTilt, bool userSet)
\sa minimumFieldOfView, maximumFieldOfView
- \since Qt Location 5.9
+ \since QtLocation 5.9
*/
void QDeclarativeGeoMap::setFieldOfView(qreal fieldOfView)
{
@@ -1116,7 +1116,7 @@ void QDeclarativeGeoMap::setMinimumFieldOfView(qreal minimumFieldOfView, bool us
\sa fieldOfView, maximumFieldOfView
- \since Qt Location 5.9
+ \since QtLocation 5.9
*/
qreal QDeclarativeGeoMap::minimumFieldOfView() const
{
@@ -1153,7 +1153,7 @@ void QDeclarativeGeoMap::setMaximumFieldOfView(qreal maximumFieldOfView, bool us
\sa fieldOfView, minimumFieldOfView
- \since Qt Location 5.9
+ \since QtLocation 5.9
*/
qreal QDeclarativeGeoMap::maximumFieldOfView() const
{
@@ -1171,7 +1171,7 @@ qreal QDeclarativeGeoMap::maximumFieldOfView() const
\sa tilt, maximumTilt
- \since Qt Location 5.9
+ \since QtLocation 5.9
*/
qreal QDeclarativeGeoMap::minimumTilt() const
{
@@ -1208,7 +1208,7 @@ void QDeclarativeGeoMap::setMaximumTilt(qreal maximumTilt, bool userSet)
\sa tilt, minimumTilt
- \since Qt Location 5.9
+ \since QtLocation 5.9
*/
qreal QDeclarativeGeoMap::maximumTilt() const
{
@@ -2082,7 +2082,7 @@ void QDeclarativeGeoMap::geometryChanged(const QRectF &newGeometry, const QRectF
}
}
- /*!
+ /*
The fitViewportTo*() functions depend on a valid map geometry.
If they were called prior to the first resize they cause
the zoomlevel to jump to 0 (showing the world). Therefore the
diff --git a/src/location/declarativemaps/qdeclarativegeomapcopyrightsnotice.cpp b/src/location/declarativemaps/qdeclarativegeomapcopyrightsnotice.cpp
index 7edfc9ff..721d941b 100644
--- a/src/location/declarativemaps/qdeclarativegeomapcopyrightsnotice.cpp
+++ b/src/location/declarativemaps/qdeclarativegeomapcopyrightsnotice.cpp
@@ -59,7 +59,7 @@ public:
\instantiates QDeclarativeGeoMapCopyrightNotice
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-maps
- \since Qt Location 5.9
+ \since QtLocation 5.9
\brief The MapCopyrightNotice item displays the current valid
copyright notice for a Map element.
diff --git a/src/location/declarativemaps/qdeclarativegeomapitemgroup.cpp b/src/location/declarativemaps/qdeclarativegeomapitemgroup.cpp
index 59aaaa26..b4d214ad 100644
--- a/src/location/declarativemaps/qdeclarativegeomapitemgroup.cpp
+++ b/src/location/declarativemaps/qdeclarativegeomapitemgroup.cpp
@@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE
\instantiates QDeclarativeGeoMapItemGroup
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-maps
- \since Qt Location 5.9
+ \since QtLocation 5.9
\brief The MapItemGroup type is a container for map items.
diff --git a/src/location/declarativemaps/qdeclarativegeomapitemview.cpp b/src/location/declarativemaps/qdeclarativegeomapitemview.cpp
index 24ed6700..b5e30bef 100644
--- a/src/location/declarativemaps/qdeclarativegeomapitemview.cpp
+++ b/src/location/declarativemaps/qdeclarativegeomapitemview.cpp
@@ -54,7 +54,7 @@ QT_BEGIN_NAMESPACE
\instantiates QDeclarativeGeoMapItemView
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-maps
- \since Qt Location 5.5
+ \since QtLocation 5.5
\inherits QObject
\brief The MapItemView is used to populate Map from a model.
diff --git a/src/location/declarativemaps/qdeclarativegeomapparameter.cpp b/src/location/declarativemaps/qdeclarativegeomapparameter.cpp
index 0ee29f4e..c1361d5d 100644
--- a/src/location/declarativemaps/qdeclarativegeomapparameter.cpp
+++ b/src/location/declarativemaps/qdeclarativegeomapparameter.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
\qmltype MapParameter
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-maps
- \since Qt Location 5.9
+ \since QtLocation 5.9
\deprecated
Use \l DynamicParameter instead.
diff --git a/src/location/declarativemaps/qdeclarativegeomapquickitem.cpp b/src/location/declarativemaps/qdeclarativegeomapquickitem.cpp
index 43efc940..62613126 100644
--- a/src/location/declarativemaps/qdeclarativegeomapquickitem.cpp
+++ b/src/location/declarativemaps/qdeclarativegeomapquickitem.cpp
@@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE
\instantiates QDeclarativeGeoMapQuickItem
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-maps
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The MapQuickItem type displays an arbitrary Qt Quick object
on a Map.
diff --git a/src/location/declarativemaps/qdeclarativegeomaptype.cpp b/src/location/declarativemaps/qdeclarativegeomaptype.cpp
index 7e40d414..66ceaac0 100644
--- a/src/location/declarativemaps/qdeclarativegeomaptype.cpp
+++ b/src/location/declarativemaps/qdeclarativegeomaptype.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
\inherits QObject
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-maps
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The MapType type holds information about a map type.
@@ -121,7 +121,7 @@ bool QDeclarativeGeoMapType::mobile() const
/*!
\qmlproperty bool MapType::night
- \since Qt Location 5.4
+ \since QtLocation 5.4
\brief Whether the map type is optimized for use at night.
@@ -134,7 +134,7 @@ bool QDeclarativeGeoMapType::night() const
/*!
\qmlproperty CameraCapabilities MapType::cameraCapabilities
- \since Qt Location 5.10
+ \since QtLocation 5.10
This property holds the camera capabilities for this map type.
*/
@@ -145,7 +145,7 @@ QDeclarativeGeoCameraCapabilities *QDeclarativeGeoMapType::cameraCapabilities()
/*!
\qmlproperty VariantMap MapType::metadata
- \since Qt Location 5.10
+ \since QtLocation 5.10
This property holds optional, extra metadata related to a specific map type.
The content of this property is entirely plugin-specific.
@@ -165,7 +165,7 @@ QVariantMap QDeclarativeGeoMapType::metadata() const
\inherits QObject
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-maps
- \since Qt Location 5.10
+ \since QtLocation 5.10
\brief The CameraCapabilities type holds information about the camera capabilities for a specific map type.
diff --git a/src/location/declarativemaps/qdeclarativegeoroute.cpp b/src/location/declarativemaps/qdeclarativegeoroute.cpp
index 816d0f39..95a26a32 100644
--- a/src/location/declarativemaps/qdeclarativegeoroute.cpp
+++ b/src/location/declarativemaps/qdeclarativegeoroute.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
\instantiates QDeclarativeGeoRoute
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-routing
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The Route type represents one geographical route.
@@ -308,7 +308,7 @@ const QGeoRoute &QDeclarativeGeoRoute::route() const
}
/*!
- \qmlproperty RouteQuery routeQuery
+ \qmlproperty RouteQuery QtLocation::Route::routeQuery
Returns the route query associated with this route.
diff --git a/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp b/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp
index add53854..10d8eb7f 100644
--- a/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp
+++ b/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp
@@ -107,7 +107,7 @@ static QList<QVariantMap> waypointMetadata(const QList<QDeclarativeGeoWaypoint *
\instantiates QDeclarativeGeoRouteModel
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-routing
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The RouteModel type provides access to routes.
@@ -702,7 +702,7 @@ void QDeclarativeGeoRouteModel::routingError(QGeoRouteReply *reply,
\instantiates QDeclarativeGeoRouteQuery
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-routing
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The RouteQuery type is used to provide query parameters to a
RouteModel.
@@ -1200,13 +1200,20 @@ void QDeclarativeGeoRouteQuery::flushWaypoints(QList<QDeclarativeGeoWaypoint *>
Following lists the possible feature weights:
- \list
- \li RouteQuery.NeutralFeatureWeight - The presence or absence of the feature will not affect the planning of the route
- \li RouteQuery.PreferFeatureWeight - Routes which contain the feature will be preferred over those that do not
- \li RouteQuery.RequireFeatureWeight - Only routes which contain the feature will be considered, otherwise no route will be returned
- \li RouteQuery.AvoidFeatureWeight - Routes which do not contain the feature will be preferred over those that do
- \li RouteQuery.DisallowFeatureWeight - Only routes which do not contain the feature will be considered, otherwise no route will be returned
- \endlist
+ \value RouteQuery.NeutralFeatureWeight
+ The presence or absence of the feature will not affect the planning of the route
+
+ \value RouteQuery.PreferFeatureWeight
+ Routes which contain the feature will be preferred over those that do not
+
+ \value RouteQuery.RequireFeatureWeight
+ Only routes which contain the feature will be considered, otherwise no route will be returned
+
+ \value RouteQuery.AvoidFeatureWeight
+ Routes which do not contain the feature will be 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
\sa featureTypes, resetFeatureWeights, featureWeight
@@ -1302,12 +1309,13 @@ void QDeclarativeGeoRouteQuery::setTravelModes(QDeclarativeGeoRouteQuery::Travel
The level of detail which will be used in the representation of routing segments.
- \list
- \li RouteQuery.NoSegmentData - No segment data should be included with the route
- \li RouteQuery.BasicSegmentData - Basic segment data will be included with the route
- \endlist
+ \value RouteQuery.NoSegmentData
+ No segment data should be included with the route
- The default value is RouteQuery.BasicSegmentData
+ \value RouteQuery.BasicSegmentData
+ Basic segment data will be included with the route
+
+ The default value is \c {RouteQuery.BasicSegmentData}.
*/
void QDeclarativeGeoRouteQuery::setSegmentDetail(SegmentDetail segmentDetail)
@@ -1331,12 +1339,13 @@ QDeclarativeGeoRouteQuery::SegmentDetail QDeclarativeGeoRouteQuery::segmentDetai
The level of detail which will be used in the representation of routing maneuvers.
- \list
- \li RouteQuery.NoManeuvers - No maneuvers should be included with the route
- \li RouteQuery.BasicManeuvers - Basic maneuvers will be included with the route
- \endlist
+ \value RouteQuery.NoManeuvers
+ No maneuvers should be included with the route
+
+ \value RouteQuery.BasicManeuvers
+ Basic maneuvers will be included with the route
- The default value is RouteQuery.BasicManeuvers
+ The default value is \c {RouteQuery.BasicManeuvers}.
*/
void QDeclarativeGeoRouteQuery::setManeuverDetail(ManeuverDetail maneuverDetail)
@@ -1361,15 +1370,22 @@ QDeclarativeGeoRouteQuery::ManeuverDetail QDeclarativeGeoRouteQuery::maneuverDet
The travel modes which should be considered during the planning of the route.
Values can be combined with OR ('|') -operator.
- \list
- \li RouteQuery.CarTravel - The route will be optimized for someone who is driving a car
- \li RouteQuery.PedestrianTravel - The route will be optimized for someone who is walking
- \li RouteQuery.BicycleTravel - The route will be optimized for someone who is riding a bicycle
- \li RouteQuery.PublicTransitTravel - The route will be optimized for someone who is making use of public transit
- \li RouteQuery.TruckTravel - The route will be optimized for someone who is driving a truck
- \endlist
+ \value RouteQuery.CarTravel
+ The route will be optimized for someone who is driving a car
+
+ \value RouteQuery.PedestrianTravel
+ The route will be optimized for someone who is walking
- The default value is RouteQuery.CarTravel
+ \value RouteQuery.BicycleTravel
+ The route will be optimized for someone who is riding a bicycle
+
+ \value RouteQuery.PublicTransit
+ Travel The route will be optimized for someone who is making use of public transit
+
+ \value RouteQuery.TruckTravel
+ The route will be optimized for someone who is driving a truck
+
+ The default value is \c {RouteQuery.CarTravel}.
*/
QDeclarativeGeoRouteQuery::TravelModes QDeclarativeGeoRouteQuery::travelModes() const
@@ -1397,14 +1413,20 @@ QDeclarativeGeoRouteQuery::TravelModes QDeclarativeGeoRouteQuery::travelModes()
The route optimizations which should be considered during the planning of the route.
Values can be combined with OR ('|') -operator.
- \list
- \li RouteQuery.ShortestRoute - Minimize the length of the journey
- \li RouteQuery.FastestRoute - Minimize the traveling time for the journey
- \li RouteQuery.MostEconomicRoute - Minimize the cost of the journey
- \li RouteQuery.MostScenicRoute - Maximize the scenic potential of the journey
- \endlist
- The default value is RouteQuery.FastestRoute
+ \value RouteQuery.ShortestRoute
+ Minimize the length of the journey
+
+ \value RouteQuery.FastestRoute
+ Minimize the traveling time for the journey
+
+ \value RouteQuery.MostEconomicRoute
+ Minimize the cost of the journey
+
+ \value RouteQuery.MostScenicRoute
+ Maximize the scenic potential of the journey
+
+ The default value is \c {RouteQuery.FastestRoute}.
*/
QDeclarativeGeoRouteQuery::RouteOptimizations QDeclarativeGeoRouteQuery::routeOptimizations() const
@@ -1473,7 +1495,8 @@ QGeoRouteRequest QDeclarativeGeoRouteQuery::routeRequest()
/*!
- \qmlproperty VariantMap extraParameters
+ \qmlproperty VariantMap RouteQuery::extraParameters
+ \readonly
The route query extra parameters. This property is read only. If the query is
defined by the user, these can be set by using MapParameters.
@@ -1577,7 +1600,7 @@ void QDeclarativeGeoRouteQuery::doCoordinateChanged()
\instantiates QDeclarativeGeoWaypoint
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-routing
- \since Qt Location 5.11
+ \since QtLocation 5.11
\brief The Waypoint type provides a mean to specify a waypoint in a \l RouteQuery
in a more detailed way than by using a simple \l coordinate.
@@ -1593,12 +1616,6 @@ void QDeclarativeGeoRouteQuery::doCoordinateChanged()
\section2 Example Usage
- The following snippet is two-part, showing firstly the declaration of
- objects, and secondly a short piece of procedural code using it. We set
- the routeModel's \l{autoUpdate} property to false, and call \l{update} once
- the query is set up, to avoid useless extra requests halfway through the
- set up of the query.
-
\code
Plugin {
id: aPlugin
@@ -1802,7 +1819,8 @@ void QDeclarativeGeoWaypoint::setBearing(qreal bearing)
}
/*!
- \qmlproperty VariantMap metadata
+ \qmlproperty VariantMap Waypoint::metadata
+ \readonly
The waypoint metadata. This property is read only. If the waypoint is
defined by the user, these can be set by using MapParameters.
diff --git a/src/location/declarativemaps/qdeclarativegeoroutesegment.cpp b/src/location/declarativemaps/qdeclarativegeoroutesegment.cpp
index dbeaa62c..5f6fda53 100644
--- a/src/location/declarativemaps/qdeclarativegeoroutesegment.cpp
+++ b/src/location/declarativemaps/qdeclarativegeoroutesegment.cpp
@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
\instantiates QDeclarativeGeoRouteSegment
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-routing
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The RouteSegment type represents a segment of a Route.
diff --git a/src/location/declarativemaps/qdeclarativegeoserviceprovider.cpp b/src/location/declarativemaps/qdeclarativegeoserviceprovider.cpp
index 39d0394b..09309bcd 100644
--- a/src/location/declarativemaps/qdeclarativegeoserviceprovider.cpp
+++ b/src/location/declarativemaps/qdeclarativegeoserviceprovider.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
\instantiates QDeclarativeGeoServiceProvider
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-common
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The Plugin type describes a Location based services plugin.
@@ -833,7 +833,7 @@ bool QDeclarativeGeoServiceProviderRequirements::operator == (const QDeclarative
\instantiates QDeclarativeGeoServiceProviderParameter
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-common
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The PluginParameter type describes a parameter to a \l Plugin.
diff --git a/src/location/declarativemaps/qdeclarativepolygonmapitem.cpp b/src/location/declarativemaps/qdeclarativepolygonmapitem.cpp
index 7493c962..b019a073 100644
--- a/src/location/declarativemaps/qdeclarativepolygonmapitem.cpp
+++ b/src/location/declarativemaps/qdeclarativepolygonmapitem.cpp
@@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE
\instantiates QDeclarativePolygonMapItem
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-maps
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The MapPolygon type displays a polygon on a Map
diff --git a/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp b/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp
index 9ef65188..473c92ff 100644
--- a/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp
+++ b/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp
@@ -62,7 +62,7 @@ QT_BEGIN_NAMESPACE
\instantiates QDeclarativePolylineMapItem
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-maps
- \since Qt Location 5.0
+ \since QtLocation 5.0
\brief The MapPolyline type displays a polyline on a map.
@@ -509,7 +509,7 @@ void QDeclarativePolylineMapItem::setPathFromGeoList(const QList<QGeoCoordinate>
Returns the number of coordinates of the polyline.
- \since Qt Location 5.6
+ \since QtLocation 5.6
\sa path
*/
@@ -543,7 +543,7 @@ void QDeclarativePolylineMapItem::addCoordinate(const QGeoCoordinate &coordinate
Inserts a \a coordinate to the path at the given \a index.
- \since Qt Location 5.6
+ \since QtLocation 5.6
\sa addCoordinate, removeCoordinate, path
*/
@@ -566,7 +566,7 @@ void QDeclarativePolylineMapItem::insertCoordinate(int index, const QGeoCoordina
Replaces the coordinate in the current path at the given \a index
with the new \a coordinate.
- \since Qt Location 5.6
+ \since QtLocation 5.6
\sa addCoordinate, insertCoordinate, removeCoordinate, path
*/
@@ -590,7 +590,7 @@ void QDeclarativePolylineMapItem::replaceCoordinate(int index, const QGeoCoordin
If the index is outside the path's bounds then an invalid
coordinate is returned.
- \since Qt Location 5.6
+ \since QtLocation 5.6
*/
QGeoCoordinate QDeclarativePolylineMapItem::coordinateAt(int index) const
{
@@ -605,7 +605,7 @@ QGeoCoordinate QDeclarativePolylineMapItem::coordinateAt(int index) const
Returns true if the given \a coordinate is part of the path.
- \since Qt Location 5.6
+ \since QtLocation 5.6
*/
bool QDeclarativePolylineMapItem::containsCoordinate(const QGeoCoordinate &coordinate)
{
@@ -641,7 +641,7 @@ void QDeclarativePolylineMapItem::removeCoordinate(const QGeoCoordinate &coordin
If \a index is invalid then this method does nothing.
- \since Qt Location 5.6
+ \since QtLocation 5.6
\sa addCoordinate, insertCoordinate, path
*/
diff --git a/src/location/declarativemaps/qdeclarativerectanglemapitem.cpp b/src/location/declarativemaps/qdeclarativerectanglemapitem.cpp
index 54706ad7..9e32c427 100644
--- a/src/location/declarativemaps/qdeclarativerectanglemapitem.cpp
+++ b/src/location/declarativemaps/qdeclarativerectanglemapitem.cpp
@@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE
\instantiates QDeclarativeRectangleMapItem
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-maps
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The MapRectangle type displays a rectangle on a Map.
diff --git a/src/location/declarativemaps/qdeclarativeroutemapitem.cpp b/src/location/declarativemaps/qdeclarativeroutemapitem.cpp
index 7e88b9cf..fd939d62 100644
--- a/src/location/declarativemaps/qdeclarativeroutemapitem.cpp
+++ b/src/location/declarativemaps/qdeclarativeroutemapitem.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
\instantiates QDeclarativeRouteMapItem
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-maps
- \since Qt Location 5.0
+ \since QtLocation 5.0
\brief The MapRoute type displays a Route on a Map.
diff --git a/src/location/declarativemaps/qquickgeomapgesturearea.cpp b/src/location/declarativemaps/qquickgeomapgesturearea.cpp
index 56ccc6b1..ccbd39a1 100644
--- a/src/location/declarativemaps/qquickgeomapgesturearea.cpp
+++ b/src/location/declarativemaps/qquickgeomapgesturearea.cpp
@@ -190,7 +190,7 @@ QT_BEGIN_NAMESPACE
\endcode
\ingroup qml-QtLocation5-maps
- \since Qt Location 5.0
+ \since QtLocation 5.0
*/
/*!
@@ -276,7 +276,7 @@ QT_BEGIN_NAMESPACE
\endcode
\ingroup qml-QtLocation5-maps
- \since Qt Location 5.0
+ \since QtLocation 5.0
*/
/*!
@@ -304,7 +304,7 @@ QT_BEGIN_NAMESPACE
This read-only property holds whether the two-finger rotation gesture is active.
- \since Qt Location 5.9
+ \since QtLocation 5.9
*/
/*!
@@ -312,7 +312,7 @@ QT_BEGIN_NAMESPACE
This read-only property holds whether the two-finger tilt gesture is active.
- \since Qt Location 5.9
+ \since QtLocation 5.9
*/
/*!
@@ -415,7 +415,7 @@ QT_BEGIN_NAMESPACE
\sa rotationUpdated, rotationFinished
- \since Qt Location 5.9
+ \since QtLocation 5.9
*/
/*!
@@ -428,7 +428,7 @@ QT_BEGIN_NAMESPACE
\sa rotationStarted, rotationFinished
- \since Qt Location 5.9
+ \since QtLocation 5.9
*/
/*!
@@ -440,7 +440,7 @@ QT_BEGIN_NAMESPACE
\sa rotationStarted, rotationUpdated
- \since Qt Location 5.9
+ \since QtLocation 5.9
*/
/*!
@@ -452,7 +452,7 @@ QT_BEGIN_NAMESPACE
\sa tiltUpdated, tiltFinished
- \since Qt Location 5.9
+ \since QtLocation 5.9
*/
/*!
@@ -465,7 +465,7 @@ QT_BEGIN_NAMESPACE
\sa tiltStarted, tiltFinished
- \since Qt Location 5.9
+ \since QtLocation 5.9
*/
/*!
@@ -477,7 +477,7 @@ QT_BEGIN_NAMESPACE
\sa tiltStarted, tiltUpdated
- \since Qt Location 5.9
+ \since QtLocation 5.9
*/
QQuickGeoMapGestureArea::QQuickGeoMapGestureArea(QDeclarativeGeoMap *map)
diff --git a/src/location/declarativeplaces/qdeclarativecategory.cpp b/src/location/declarativeplaces/qdeclarativecategory.cpp
index 4161c1a1..1f87123a 100644
--- a/src/location/declarativeplaces/qdeclarativecategory.cpp
+++ b/src/location/declarativeplaces/qdeclarativecategory.cpp
@@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-data
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The Category type represents a category that a \l Place can be associated with.
diff --git a/src/location/declarativeplaces/qdeclarativecontactdetail.cpp b/src/location/declarativeplaces/qdeclarativecontactdetail.cpp
index 7a7a4c33..8ce328b1 100644
--- a/src/location/declarativeplaces/qdeclarativecontactdetail.cpp
+++ b/src/location/declarativeplaces/qdeclarativecontactdetail.cpp
@@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-data
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The ContactDetails type holds contact details for a \l Place.
@@ -122,7 +122,7 @@ QVariant QDeclarativeContactDetails::updateValue(const QString &, const QVariant
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-data
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The ContactDetail type holds a contact detail such as a phone number or a website
address.
diff --git a/src/location/declarativeplaces/qdeclarativeplace.cpp b/src/location/declarativeplaces/qdeclarativeplace.cpp
index 5c09f71b..7ab40fea 100644
--- a/src/location/declarativeplaces/qdeclarativeplace.cpp
+++ b/src/location/declarativeplaces/qdeclarativeplace.cpp
@@ -60,7 +60,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-data
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The Place type represents a location that is a position of interest.
diff --git a/src/location/declarativeplaces/qdeclarativeplaceattribute.cpp b/src/location/declarativeplaces/qdeclarativeplaceattribute.cpp
index 20adbafb..14667035 100644
--- a/src/location/declarativeplaces/qdeclarativeplaceattribute.cpp
+++ b/src/location/declarativeplaces/qdeclarativeplaceattribute.cpp
@@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-data
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The ExtendedAttributes type holds additional data about a \l Place.
@@ -124,7 +124,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-data
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The PlaceAttribute type holds generic place attribute information.
diff --git a/src/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp b/src/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp
index dbc23737..489cdf5c 100644
--- a/src/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp
+++ b/src/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-models
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The EditorialModel type provides a model of place editorials.
diff --git a/src/location/declarativeplaces/qdeclarativeplaceicon.cpp b/src/location/declarativeplaces/qdeclarativeplaceicon.cpp
index ba542792..1c8ae969 100644
--- a/src/location/declarativeplaces/qdeclarativeplaceicon.cpp
+++ b/src/location/declarativeplaces/qdeclarativeplaceicon.cpp
@@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-data
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The Icon type represents an icon image source which can have multiple sizes.
diff --git a/src/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp b/src/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp
index 4da37081..e7bdf3cf 100644
--- a/src/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp
+++ b/src/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-models
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The ImageModel type provides a model of place images.
diff --git a/src/location/declarativeplaces/qdeclarativeplaceuser.cpp b/src/location/declarativeplaces/qdeclarativeplaceuser.cpp
index 86901a98..8f9f00c4 100644
--- a/src/location/declarativeplaces/qdeclarativeplaceuser.cpp
+++ b/src/location/declarativeplaces/qdeclarativeplaceuser.cpp
@@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-data
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The User type identifies a user who contributed a particular \l Place content item.
diff --git a/src/location/declarativeplaces/qdeclarativeratings.cpp b/src/location/declarativeplaces/qdeclarativeratings.cpp
index 150e5966..ae6876bd 100644
--- a/src/location/declarativeplaces/qdeclarativeratings.cpp
+++ b/src/location/declarativeplaces/qdeclarativeratings.cpp
@@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-data
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The Ratings type holds place rating information.
diff --git a/src/location/declarativeplaces/qdeclarativereviewmodel.cpp b/src/location/declarativeplaces/qdeclarativereviewmodel.cpp
index b7237bc9..81890844 100644
--- a/src/location/declarativeplaces/qdeclarativereviewmodel.cpp
+++ b/src/location/declarativeplaces/qdeclarativereviewmodel.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-models
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief Provides access to reviews of a \l Place.
diff --git a/src/location/declarativeplaces/qdeclarativesearchresultmodel.cpp b/src/location/declarativeplaces/qdeclarativesearchresultmodel.cpp
index 3450e3ea..e8476c7d 100644
--- a/src/location/declarativeplaces/qdeclarativesearchresultmodel.cpp
+++ b/src/location/declarativeplaces/qdeclarativesearchresultmodel.cpp
@@ -56,7 +56,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-models
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief Provides access to place search results.
diff --git a/src/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp b/src/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp
index 95cd3277..c416858f 100644
--- a/src/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp
+++ b/src/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-models
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief Provides access to search term suggestions.
diff --git a/src/location/declarativeplaces/qdeclarativesupplier.cpp b/src/location/declarativeplaces/qdeclarativesupplier.cpp
index 92e9a8fd..b296dc69 100644
--- a/src/location/declarativeplaces/qdeclarativesupplier.cpp
+++ b/src/location/declarativeplaces/qdeclarativesupplier.cpp
@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-data
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief Holds data regarding the supplier of a place, a place's image, review, or editorial.
diff --git a/src/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp b/src/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp
index 780eb98a..b7c6e319 100644
--- a/src/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp
+++ b/src/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp
@@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-models
- \since Qt Location 5.5
+ \since QtLocation 5.5
\brief The CategoryModel type provides a model of the categories supported by a \l Plugin.
diff --git a/src/location/doc/qtlocation.qdocconf b/src/location/doc/qtlocation.qdocconf
index 464e8e76..0e735391 100644
--- a/src/location/doc/qtlocation.qdocconf
+++ b/src/location/doc/qtlocation.qdocconf
@@ -32,12 +32,12 @@ qhp.QtLocation.subprojects.examples.selectors = fake:example
tagfile = ../../../doc/qtlocation/qtlocation.tags
-depends += qtcore qtdoc qtquick qtqml qtnetwork qtpositioning qtquickcontrols
+depends += qtcore qtdoc qtgui qtquick qtqml qtnetwork qtpositioning qtquickcontrols qtlinguist
-headerdirs += .. \
+headerdirs += .. \
../../imports/location
-sourcedirs += .. \
+sourcedirs += .. \
../../imports/location \
../../plugins/geoservices/nokia
diff --git a/src/location/maps/qgeomaneuver.cpp b/src/location/maps/qgeomaneuver.cpp
index fb019130..22f6f587 100644
--- a/src/location/maps/qgeomaneuver.cpp
+++ b/src/location/maps/qgeomaneuver.cpp
@@ -294,7 +294,7 @@ QGeoManeuver::QGeoManeuver(const QSharedDataPointer<QGeoManeuverPrivate> &dd)
: d_ptr(dd) {}
/*!
- Sets the extended attributes associated with this maneuver.
+ Sets the extended attributes \a extendedAttributes associated with this maneuver.
\since QtLocation 5.11
*/
diff --git a/src/location/maps/qgeoroute.cpp b/src/location/maps/qgeoroute.cpp
index 237d9b68..12ac16bd 100644
--- a/src/location/maps/qgeoroute.cpp
+++ b/src/location/maps/qgeoroute.cpp
@@ -80,7 +80,7 @@ QGeoRoute::QGeoRoute()
: d_ptr(new QGeoRoutePrivateDefault()) {}
/*!
- Constructs a route object using dd as private implementation.
+ Constructs a route object using \a dd as private implementation.
*/
QGeoRoute::QGeoRoute(const QExplicitlySharedDataPointer<QGeoRoutePrivate> &dd): d_ptr(dd)
{
diff --git a/src/location/maps/qgeorouterequest.cpp b/src/location/maps/qgeorouterequest.cpp
index 57ef1c03..a252b101 100644
--- a/src/location/maps/qgeorouterequest.cpp
+++ b/src/location/maps/qgeorouterequest.cpp
@@ -296,7 +296,7 @@ QList<QGeoCoordinate> QGeoRouteRequest::waypoints() const
}
/*!
- Sets \a waypoint metadata as the metadata for the waypoints set in this request.
+ Sets \a waypointMetadata as the metadata for the waypoints set in this request.
The metadata are intended as one QVariantMap per waypoint, given in the same order as
the waypoints.
@@ -468,7 +468,7 @@ QGeoRouteRequest::ManeuverDetail QGeoRouteRequest::maneuverDetail() const
}
/*!
- Sets the extra parameters for the route request.
+ Sets the extra parameters \a extraParameters for the route request.
The format of the extra parameters is plugin specific, and documented per plugin.
\since 5.11
diff --git a/src/location/places/qplace.cpp b/src/location/places/qplace.cpp
index 33623f54..ab115b5b 100644
--- a/src/location/places/qplace.cpp
+++ b/src/location/places/qplace.cpp
@@ -127,7 +127,7 @@ QPlace::QPlace()
}
/*!
- Constructs an place object using dd as private implementation.
+ Constructs an place object using \a dd as private implementation.
*/
QPlace::QPlace(const QSharedDataPointer<QPlacePrivate> &dd): d_ptr(dd)
{
diff --git a/src/location/places/qplacecontent.cpp b/src/location/places/qplacecontent.cpp
index a3334c6a..97aaa4ec 100644
--- a/src/location/places/qplacecontent.cpp
+++ b/src/location/places/qplacecontent.cpp
@@ -115,13 +115,15 @@ bool QPlaceContentPrivate::compare(const QPlaceContentPrivate *other) const
Defines the type of content.
\value NoType
The content object is default constructed, any other content type may be assigned
- to this content object.
+ to this content object
\value ImageType
- The content object is an image.
+ The content object is an image
\value ReviewType
- The content object is a review.
+ The content object is a review
\value EditorialType
The content object is an editorial
+ \value CustomType
+ The content object is of a custom type
*/
/*!
diff --git a/src/location/places/qplaceproposedsearchresult.cpp b/src/location/places/qplaceproposedsearchresult.cpp
index 20a6be92..4acc66c1 100644
--- a/src/location/places/qplaceproposedsearchresult.cpp
+++ b/src/location/places/qplaceproposedsearchresult.cpp
@@ -63,7 +63,7 @@ bool QPlaceProposedSearchResultPrivate::compare(const QPlaceSearchResultPrivate
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-data
- \since Qt Location 5.2
+ \since QtLocation 5.2
\brief The QPlaceProposedSearchResult class represents a search result containing a proposed search.
diff --git a/src/location/qlocationglobal.h b/src/location/qlocationglobal.h
index 7992c097..e7355f04 100644
--- a/src/location/qlocationglobal.h
+++ b/src/location/qlocationglobal.h
@@ -50,6 +50,10 @@ QT_BEGIN_NAMESPACE
# define Q_LOCATION_EXPORT
#endif
+#ifdef Q_CLANG_QDOC
+#include "qlocation.h"
+#endif
+
QT_END_NAMESPACE
#endif // QLOCATIONGLOBAL_H
diff --git a/src/plugins/geoservices/nokia/qgeotiledmap_nokia.cpp b/src/plugins/geoservices/nokia/qgeotiledmap_nokia.cpp
index 90be0ae9..2f5fa2e8 100644
--- a/src/plugins/geoservices/nokia/qgeotiledmap_nokia.cpp
+++ b/src/plugins/geoservices/nokia/qgeotiledmap_nokia.cpp
@@ -49,7 +49,7 @@
QT_BEGIN_NAMESPACE
-/*!
+/*
Constructs a new tiled map data object, which stores the map data required by
\a geoMap and makes use of the functionality provided by \a engine.
*/
diff --git a/src/positioning/doc/qtpositioning.qdocconf b/src/positioning/doc/qtpositioning.qdocconf
index 608b30a1..3f6438ef 100644
--- a/src/positioning/doc/qtpositioning.qdocconf
+++ b/src/positioning/doc/qtpositioning.qdocconf
@@ -35,10 +35,12 @@ tagfile = ../../../doc/qtpositioning/qtpositioning.tags
depends += qtcore qtdoc qtquick qtqml qtnetwork qtlocation
headerdirs += .. \
- ../../imports/positioning
+ ../../imports/positioning \
+ ../../positioningquick
sourcedirs += .. \
- ../../imports/positioning
+ ../../imports/positioning \
+ ../../positioningquick
examplesinstallpath = positioning
diff --git a/src/positioning/doc/src/qml-position.qdoc b/src/positioning/doc/src/qml-position.qdoc
index 7ca7eb1b..dd3b5e40 100644
--- a/src/positioning/doc/src/qml-position.qdoc
+++ b/src/positioning/doc/src/qml-position.qdoc
@@ -61,18 +61,18 @@ location data source within the API is that it provides a
latitude-longitude coordinate with a date/time value, with the option of
providing the other attributes listed above.
-\section2 Coordinate
+\section2 Coordinates
The \l {coordinate} is a basic unit of geographical information. The
\l {coordinate} type has attributes to hold the \c {latitude},
\c longitude and \c altitude.
-\section2 Position
+\section2 Positions
The three dimensional position of an object such as a mobile device can be specified by giving
the latitude, longitude and altitude. That is the values held in the
l\ {coordinate} type. Additionally for computation of future
-positions we would like to know if the object is moving, what \l {Position::speed}{speed} it is
+positions we would like to know if the object is moving, what \l [QML] {Position::}{speed} it is
doing and what is the \l {Position::timestamp}{timestamp} of the last position data. Position
therefore includes values for the \l {Position::coordinate}{coordinate},
\l {Position::speed}{speed} and a \l {Position::timestamp}{timestamp}. \l Position also takes
@@ -83,7 +83,7 @@ the \l {Position::latitudeValid}{latitudeValid}, \l {Position::longitudeValid}{l
\l {Position::verticalAccuracyValid}{verticalAccuracyValid} properties.
-\section2 PositionSource
+\section2 PositionSource Type
We have a Position type, a \l {coordinate} type but where does the data come from?
Also it is a good idea to be able to indicate alternative sources.
@@ -111,7 +111,7 @@ PositionSource {
-\section2 \b{GeoFlickr Example}
+\section2 GeoFlickr Example
The \l{GeoFlickr (QML)}{GeoFlickr Example} uses the Location to download thumbnail
images from Flickr relevant to the current location.
diff --git a/src/positioning/qgeocircle.cpp b/src/positioning/qgeocircle.cpp
index 6fccb8af..140f78aa 100644
--- a/src/positioning/qgeocircle.cpp
+++ b/src/positioning/qgeocircle.cpp
@@ -356,8 +356,8 @@ bool QGeoCirclePrivate::crossSouthPole() const
return false;
}
-/*!
- Extends the circle to include \a coordinate
+/*
+ Extends the circle to include \a coordinate.
*/
void QGeoCirclePrivate::extendShape(const QGeoCoordinate &coordinate)
{
diff --git a/src/positioning/qgeocoordinate.cpp b/src/positioning/qgeocoordinate.cpp
index 12f5ad52..4353d214 100644
--- a/src/positioning/qgeocoordinate.cpp
+++ b/src/positioning/qgeocoordinate.cpp
@@ -273,6 +273,12 @@ QGeoCoordinate &QGeoCoordinate::operator=(const QGeoCoordinate &other)
return (*this);
}
+/*!
+ \fn QGeoCoordinate &QGeoCoordinate::operator=(const QGeoCoordinateObject &coordinateoObject)
+ \fn QGeoCoordinate &QGeoCoordinate::operator=(const QGeoCoordinateObject *coordinateoObject)
+
+ Assigns \a coordinateoObject to this coordinate and returns a reference to this coordinate.
+*/
QGeoCoordinate &QGeoCoordinate::operator=(const QGeoCoordinateObject &coordinateoObject)
{
d = coordinateoObject.coordinate().d;
@@ -314,7 +320,11 @@ bool QGeoCoordinate::operator==(const QGeoCoordinate &other) const
}
/*!
+ \fn bool QGeoCoordinate::operator==(const QGeoCoordinateObject &other) const
+ \fn bool QGeoCoordinate::operator==(const QGeoCoordinateObject *other) const
+ Returns \c true if latitude, longitude, and altitude of this
+ coordinate are identical to \a other.
*/
bool QGeoCoordinate::operator==(const QGeoCoordinateObject &other) const
{
@@ -327,14 +337,16 @@ bool QGeoCoordinate::operator==(const QGeoCoordinateObject *other) const
}
/*!
- \fn bool QGeoCoordinate::operator!=(const QGeoCoordinate &other) const;
+ \fn bool QGeoCoordinate::operator!=(const QGeoCoordinate &other) const
+ \fn bool QGeoCoordinate::operator!=(const QGeoCoordinateObject &other) const
+ \fn bool QGeoCoordinate::operator!=(const QGeoCoordinateObject *other) const
- Returns true if the latitude, longitude or altitude of this
- coordinate are not the same as those of \a other.
+ Returns \c true if latitude, longitude, or altitude of this
+ coordinate are not identical to \a other.
*/
/*!
- Returns true if the \l longitude and \l latitude are valid.
+ Returns \c true if the \l longitude and \l latitude are valid.
*/
bool QGeoCoordinate::isValid() const
{
diff --git a/src/positioning/qgeopath.cpp b/src/positioning/qgeopath.cpp
index 6fd02d77..592933a9 100644
--- a/src/positioning/qgeopath.cpp
+++ b/src/positioning/qgeopath.cpp
@@ -177,7 +177,7 @@ bool QGeoPath::operator!=(const QGeoPath &other) const
}
/*!
- Sets all the elements of the path.
+ Sets all the elements of the \a path.
*/
void QGeoPath::setPath(const QList<QGeoCoordinate> &path)
{
@@ -222,6 +222,12 @@ QVariantList QGeoPath::variantPath() const
return p;
}
+
+/*!
+ \property QGeoPath::width
+
+ \brief the width of the path in meters.
+*/
void QGeoPath::setWidth(const qreal &width)
{
Q_D(QGeoPath);
@@ -229,7 +235,7 @@ void QGeoPath::setWidth(const qreal &width)
}
/*!
- Returns the width of the path, in meters. This information is used in the \l contains method
+ Returns the width of the path, in meters. This information is used in the \l contains method.
The default value is 0.
*/
qreal QGeoPath::width() const
diff --git a/src/positioning/qgeopolygon.cpp b/src/positioning/qgeopolygon.cpp
index d817ea07..cbdda939 100644
--- a/src/positioning/qgeopolygon.cpp
+++ b/src/positioning/qgeopolygon.cpp
@@ -77,7 +77,7 @@ QT_BEGIN_NAMESPACE
It can be \l{Cpp_value_integration_positioning}{directly used from C++ and QML}.
*/
-/*!
+/*
\property QGeoPolygon::path
\brief This property holds the list of coordinates for the geo polygon.
@@ -117,8 +117,7 @@ QGeoPolygon::QGeoPolygon()
}
/*!
- Constructs a new geo path from a list of coordinates
- (\a path and \a width).
+ Constructs a new geo \a path from a list of coordinates.
*/
QGeoPolygon::QGeoPolygon(const QList<QGeoCoordinate> &path)
: QGeoShape(new QGeoPolygonPrivate(QGeoShape::PolygonType, path))
@@ -178,6 +177,9 @@ bool QGeoPolygon::operator!=(const QGeoPolygon &other) const
return !(*d == *other.d_func());
}
+/*!
+ Sets the \a path from a list of coordinates.
+*/
void QGeoPolygon::setPath(const QList<QGeoCoordinate> &path)
{
Q_D(QGeoPolygon);
diff --git a/src/positioning/qgeosatelliteinfo.cpp b/src/positioning/qgeosatelliteinfo.cpp
index 79e39eff..e62bd164 100644
--- a/src/positioning/qgeosatelliteinfo.cpp
+++ b/src/positioning/qgeosatelliteinfo.cpp
@@ -274,7 +274,7 @@ QDebug operator<<(QDebug dbg, const QGeoSatelliteInfo &info)
Writes the given \a info to the specified \a stream.
- \sa \link datastreamformat.html Format of the QDataStream operators \endlink
+ \sa {Serializing Qt Data Types}
*/
@@ -296,7 +296,7 @@ QDataStream &operator<<(QDataStream &stream, const QGeoSatelliteInfo &info)
Reads satellite information from the specified \a stream into the given
\a info.
- \sa \link datastreamformat.html Format of the QDataStream operators \endlink
+ \sa {Serializing Qt Data Types}
*/
QDataStream &operator>>(QDataStream &stream, QGeoSatelliteInfo &info)
diff --git a/src/positioning/qgeoshape.cpp b/src/positioning/qgeoshape.cpp
index 7acbc9fa..d17f9eea 100644
--- a/src/positioning/qgeoshape.cpp
+++ b/src/positioning/qgeoshape.cpp
@@ -93,10 +93,11 @@ bool QGeoShapePrivate::operator==(const QGeoShapePrivate &other) const
Describes the type of the shape.
- \value UnknownType A shape of unknown type.
- \value RectangleType A rectangular shape.
- \value CircleType A circular shape.
- \value PathType A path type.
+ \value UnknownType A shape of unknown type
+ \value RectangleType A rectangular shape
+ \value CircleType A circular shape
+ \value PathType A path type
+ \value PolygonType A polygon type
*/
/*!
diff --git a/src/positioningquick/qdeclarativeposition.cpp b/src/positioningquick/qdeclarativeposition.cpp
index 7e72f358..b63aaab8 100644
--- a/src/positioningquick/qdeclarativeposition.cpp
+++ b/src/positioningquick/qdeclarativeposition.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmltype Position
- \instantiates QDeclarativePosition
+ //! \instantiates QDeclarativePosition
\inqmlmodule QtPositioning
\since 5.2
diff --git a/src/positioningquick/qdeclarativepositionsource.cpp b/src/positioningquick/qdeclarativepositionsource.cpp
index d290de25..ec462f23 100644
--- a/src/positioningquick/qdeclarativepositionsource.cpp
+++ b/src/positioningquick/qdeclarativepositionsource.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmltype PositionSource
- \instantiates QDeclarativePositionSource
+ //! \instantiates QDeclarativePositionSource
\inqmlmodule QtPositioning
\since 5.2