Document return types for invokable functions in QtLocation QML

Change-Id: I94aa0e16ff316e791f071ed1c299a717d74ce792
Reviewed-by: Michal Klocek <michal.klocek@theqtcompany.com>
Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>

8 files changed, 36 insertions, 36 deletions

diff --git a/src/imports/location/declarativeplaces/qdeclarativeplace.cpp b/src/imports/location/declarativeplaces/qdeclarativeplace.cpp
index 19f61f45..bcfbb247 100644
--- a/src/imports/location/declarativeplaces/qdeclarativeplace.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativeplace.cpp
@@ -1042,7 +1042,7 @@ void QDeclarativePlace::setFavorite(QDeclarativePlace *favorite)
 }
 
 /*!
-    \qmlmethod Place::copyFrom(Place original)
+    \qmlmethod void Place::copyFrom(Place original)
 
     Copies data from an \a original place into this place.  Only data that is supported by this
     place's plugin is copied over and plugin specific data such as place identifier is not copied over.
@@ -1057,7 +1057,7 @@ void QDeclarativePlace::copyFrom(QDeclarativePlace *original)
 }
 
 /*!
-    \qmlmethod Place::initializeFavorite(Plugin destinationPlugin)
+    \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
diff --git a/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp
index d0020d67..f3a42c5d 100644
--- a/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp
@@ -260,7 +260,7 @@ QT_USE_NAMESPACE
 */
 
 /*!
-    \qmlmethod PlaceSearchModel::update()
+    \qmlmethod void PlaceSearchModel::update()
 
     Updates the model based on the provided query parameters.  The model will be populated with a
     list of places matching the search parameters specified by the type's properties.  Search
@@ -297,7 +297,7 @@ QT_USE_NAMESPACE
 */
 
 /*!
-    \qmlmethod PlaceSearchModel::cancel()
+    \qmlmethod void PlaceSearchModel::cancel()
 
     Cancels an ongoing search operation immediately and sets the model
     status to PlaceSearchModel.Ready.  The model retains any search
@@ -309,7 +309,7 @@ QT_USE_NAMESPACE
 */
 
 /*!
-    \qmlmethod PlaceSearchModel::reset()
+    \qmlmethod void PlaceSearchModel::reset()
 
     Resets the model.  All search results are cleared, any outstanding requests are aborted and
     possible errors are cleared.  Model status will be set to PlaceSearchModel.Null.
@@ -326,14 +326,14 @@ QT_USE_NAMESPACE
 */
 
 /*!
-    \qmlmethod PlaceSearchModel::previousPage()
+    \qmlmethod void PlaceSearchModel::previousPage()
 
     Updates the model to display the previous page of search results. If there is no previous page
     then this method does nothing.
 */
 
 /*!
-    \qmlmethod PlaceSearchModel::nextPage()
+    \qmlmethod void PlaceSearchModel::nextPage()
 
     Updates the model to display the next page of search results. If there is no next page then
     this method does nothing.
@@ -664,7 +664,7 @@ QHash<int, QByteArray> QDeclarativeSearchResultModel::roleNames() const
 }
 
 /*!
-    \qmlmethod PlaceSearchModel::updateWith(int proposedSearchIndex)
+    \qmlmethod void PlaceSearchModel::updateWith(int proposedSearchIndex)
 
     Updates the model based on the ProposedSearchResult at index \a proposedSearchIndex. The model
     will be populated with a list of places matching the proposed search. Model status will be set
@@ -800,7 +800,7 @@ void QDeclarativeSearchResultModel::queryFinished()
 }
 
 /*!
-    \qmlmethod PlaceSearchModel::data(int index, string role)
+    \qmlmethod void PlaceSearchModel::data(int index, string role)
 
     Returns the data for a given \a role at the specified row \a index.
 */
diff --git a/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp
index dfcb8efc..0be58afe 100644
--- a/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp
@@ -149,7 +149,7 @@ QT_USE_NAMESPACE
 */
 
 /*!
-    \qmlmethod PlaceSearchSuggestionModel::update()
+    \qmlmethod void PlaceSearchSuggestionModel::update()
 
     Updates the model based on the provided query parameters.  The model will be populated with a
     list of search suggestions for the partial \l searchTerm and \l searchArea.  If the \l plugin
@@ -189,7 +189,7 @@ QT_USE_NAMESPACE
 */
 
 /*!
-    \qmlmethod PlaceSearchSuggestionModel::cancel()
+    \qmlmethod void PlaceSearchSuggestionModel::cancel()
 
     Cancels an ongoing search suggestion operation immediately and sets the model
     status to PlaceSearchSuggestionModel.Ready.  The model retains any search
@@ -201,7 +201,7 @@ QT_USE_NAMESPACE
 */
 
 /*!
-    \qmlmethod PlaceSearchSuggestionModel::reset()
+    \qmlmethod void PlaceSearchSuggestionModel::reset()
 
     Resets the model.  All search suggestions are cleared, any outstanding requests are aborted and
     possible errors are cleared.  Model status will be set to PlaceSearchSuggestionModel.Null.
diff --git a/src/imports/location/qdeclarativegeocodemodel.cpp b/src/imports/location/qdeclarativegeocodemodel.cpp
index fef5cc6e..0b7ec215 100644
--- a/src/imports/location/qdeclarativegeocodemodel.cpp
+++ b/src/imports/location/qdeclarativegeocodemodel.cpp
@@ -138,7 +138,7 @@ void QDeclarativeGeocodeModel::componentComplete()
 }
 
 /*!
-    \qmlmethod QtLocation::GeocodeModel::update()
+    \qmlmethod void QtLocation::GeocodeModel::update()
 
     Instructs the GeocodeModel to update its data. This is most useful
     when \l autoUpdate is disabled, to force a refresh when the query
@@ -575,7 +575,7 @@ void QDeclarativeGeocodeModel::setOffset(int offset)
 }
 
 /*!
-    \qmlmethod QtLocation::GeocodeModel::reset()
+    \qmlmethod void QtLocation::GeocodeModel::reset()
 
     Resets the model. All location data is cleared, any outstanding requests
     are aborted and possible errors are cleared. Model status will be set
@@ -598,7 +598,7 @@ void QDeclarativeGeocodeModel::reset()
 }
 
 /*!
-    \qmlmethod QtLocation::GeocodeModel::cancel()
+    \qmlmethod void QtLocation::GeocodeModel::cancel()
 
     Cancels any outstanding requests and clears errors.  Model status will be set to either
     GeocodeModel.Null or GeocodeModel.Ready.
diff --git a/src/imports/location/qdeclarativegeomap.cpp b/src/imports/location/qdeclarativegeomap.cpp
index a8cdd25d..b00d46b7 100644
--- a/src/imports/location/qdeclarativegeomap.cpp
+++ b/src/imports/location/qdeclarativegeomap.cpp
@@ -824,7 +824,7 @@ QQmlListProperty<QDeclarativeGeoMapType> QDeclarativeGeoMap::supportedMapTypes()
 }
 
 /*!
-    \qmlmethod QtLocation::Map::toCoordinate(QPointF position)
+    \qmlmethod coordinate QtLocation::Map::toCoordinate(QPointF position)
 
     Returns the coordinate which corresponds to the \a position relative to the map item.
 
@@ -839,7 +839,7 @@ QGeoCoordinate QDeclarativeGeoMap::toCoordinate(const QPointF &position) const
 }
 
 /*!
-    \qmlmethod QtLocation::Map::fromCoordinate(coordinate coordinate)
+    \qmlmethod point QtLocation::Map::fromCoordinate(coordinate coordinate)
 
     Returns the position relative to the map item which corresponds to the \a coordinate.
 
@@ -1012,7 +1012,7 @@ bool QDeclarativeGeoMap::childMouseEventFilter(QQuickItem *item, QEvent *event)
 }
 
 /*!
-    \qmlmethod QtLocation::Map::addMapItem(MapItem item)
+    \qmlmethod void QtLocation::Map::addMapItem(MapItem item)
 
     Adds the given \a item to the Map (for example MapQuickItem, MapCircle). If the object
     already is on the Map, it will not be added again.
@@ -1161,7 +1161,7 @@ void QDeclarativeGeoMap::geometryChanged(const QRectF &newGeometry, const QRectF
 
 // TODO Remove this function -> BC break
 /*!
-    \qmlmethod QtLocation::Map::fitViewportToGeoShape(QGeoShape shape)
+    \qmlmethod void QtLocation::Map::fitViewportToGeoShape(QGeoShape shape)
 
     \internal
 
@@ -1243,7 +1243,7 @@ void QDeclarativeGeoMap::fitViewportToGeoShape(const QVariant &variantShape)
 }
 
 /*!
-    \qmlmethod QtLocation::Map::fitViewportToMapItems()
+    \qmlmethod void QtLocation::Map::fitViewportToMapItems()
 
     Fits the current viewport to the boundary of all map items. The camera is positioned
     in the center of the map items, and at the largest integral zoom level possible which
diff --git a/src/imports/location/qdeclarativegeoroutemodel.cpp b/src/imports/location/qdeclarativegeoroutemodel.cpp
index dfc79910..3f02eb83 100644
--- a/src/imports/location/qdeclarativegeoroutemodel.cpp
+++ b/src/imports/location/qdeclarativegeoroutemodel.cpp
@@ -150,7 +150,7 @@ int QDeclarativeGeoRouteModel::count() const
 }
 
 /*!
-    \qmlmethod QtLocation::RouteModel::reset()
+    \qmlmethod void QtLocation::RouteModel::reset()
 
     Resets the model. All route data is cleared, any outstanding requests
     are aborted and possible errors are cleared. Model status will be set
@@ -175,7 +175,7 @@ void QDeclarativeGeoRouteModel::reset()
 }
 
 /*!
-    \qmlmethod QtLocation::RouteModel::cancel()
+    \qmlmethod void QtLocation::RouteModel::cancel()
 
     Cancels any outstanding requests and clears errors.  Model status will be set to either
     RouteModel.Null or RouteModel.Ready.
@@ -202,7 +202,7 @@ void QDeclarativeGeoRouteModel::abortRequest()
 
 
 /*!
-    \qmlmethod QtLocation::RouteModel::get(int)
+    \qmlmethod void QtLocation::RouteModel::get(int)
 
     Returns the Route at given index. Use \l count property to check the
     amount of routes available. The routes are indexed from zero, so the accessible range
@@ -557,7 +557,7 @@ void QDeclarativeGeoRouteModel::setError(RouteError error)
 }
 
 /*!
-    \qmlmethod QtLocation::RouteModel::update()
+    \qmlmethod void QtLocation::RouteModel::update()
 
     Instructs the RouteModel to update its data. This is most useful
     when \l autoUpdate is disabled, to force a refresh when the query
@@ -894,7 +894,7 @@ void QDeclarativeGeoRouteQuery::setExcludedAreas(const QJSValue &value)
 }
 
 /*!
-    \qmlmethod QtLocation::RouteQuery::addExcludedArea(georectangle)
+    \qmlmethod void QtLocation::RouteQuery::addExcludedArea(georectangle)
 
     Adds the given area to excluded areas (areas that the route must not cross).
     Same area can only be added once.
@@ -924,7 +924,7 @@ void QDeclarativeGeoRouteQuery::addExcludedArea(const QGeoRectangle &area)
 }
 
 /*!
-    \qmlmethod QtLocation::RouteQuery::removeExcludedArea(georectangle)
+    \qmlmethod void QtLocation::RouteQuery::removeExcludedArea(georectangle)
 
     Removes the given area to excluded areas (areas that the route must not cross).
 
@@ -951,7 +951,7 @@ void QDeclarativeGeoRouteQuery::removeExcludedArea(const QGeoRectangle &area)
 }
 
 /*!
-    \qmlmethod QtLocation::RouteQuery::clearExcludedAreas()
+    \qmlmethod void QtLocation::RouteQuery::clearExcludedAreas()
 
     Clears all excluded areas (areas that the route must not cross).
 
@@ -970,7 +970,7 @@ void QDeclarativeGeoRouteQuery::clearExcludedAreas()
 }
 
 /*!
-    \qmlmethod QtLocation::RouteQuery::addWaypoint(coordinate)
+    \qmlmethod void QtLocation::RouteQuery::addWaypoint(coordinate)
 
     Appends a coordinate to the list of waypoints. Same coordinate
     can be set multiple times.
@@ -995,7 +995,7 @@ void QDeclarativeGeoRouteQuery::addWaypoint(const QGeoCoordinate &waypoint)
 }
 
 /*!
-    \qmlmethod QtLocation::RouteQuery::removeWaypoint(coordinate)
+    \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
@@ -1022,7 +1022,7 @@ void QDeclarativeGeoRouteQuery::removeWaypoint(const QGeoCoordinate &waypoint)
 }
 
 /*!
-    \qmlmethod QtLocation::RouteQuery::clearWaypoints()
+    \qmlmethod void QtLocation::RouteQuery::clearWaypoints()
 
     Clears all waypoints.
 
@@ -1040,7 +1040,7 @@ void QDeclarativeGeoRouteQuery::clearWaypoints()
 }
 
 /*!
-    \qmlmethod QtLocation::RouteQuery::setFeatureWeight(FeatureType, FeatureWeight)
+    \qmlmethod void QtLocation::RouteQuery::setFeatureWeight(FeatureType, FeatureWeight)
 
     Defines the weight to associate with a feature during the planning of a
     route.
@@ -1082,7 +1082,7 @@ void QDeclarativeGeoRouteQuery::setFeatureWeight(FeatureType featureType, Featur
 }
 
 /*!
-    \qmlmethod QtLocation::RouteQuery::resetFeatureWeights()
+    \qmlmethod void QtLocation::RouteQuery::resetFeatureWeights()
 
     Resets all feature weights to their default state (NeutralFeatureWeight).
 
diff --git a/src/imports/location/qdeclarativepolygonmapitem.cpp b/src/imports/location/qdeclarativepolygonmapitem.cpp
index d82a6771..0b097edb 100644
--- a/src/imports/location/qdeclarativepolygonmapitem.cpp
+++ b/src/imports/location/qdeclarativepolygonmapitem.cpp
@@ -428,7 +428,7 @@ void QDeclarativePolygonMapItem::setPath(const QJSValue &value)
 }
 
 /*!
-    \qmlmethod MapPolygon::addCoordinate(coordinate)
+    \qmlmethod void MapPolygon::addCoordinate(coordinate)
 
     Adds a coordinate to the path.
 
@@ -446,7 +446,7 @@ void QDeclarativePolygonMapItem::addCoordinate(const QGeoCoordinate &coordinate)
 }
 
 /*!
-    \qmlmethod MapPolygon::removeCoordinate(coordinate)
+    \qmlmethod void MapPolygon::removeCoordinate(coordinate)
 
     Removes a coordinate from the path. If there are multiple instances of the
     same coordinate, the one added last is removed.
diff --git a/src/imports/location/qdeclarativepolylinemapitem.cpp b/src/imports/location/qdeclarativepolylinemapitem.cpp
index dade8e22..d88b89b8 100644
--- a/src/imports/location/qdeclarativepolylinemapitem.cpp
+++ b/src/imports/location/qdeclarativepolylinemapitem.cpp
@@ -543,7 +543,7 @@ void QDeclarativePolylineMapItem::setPathFromGeoList(const QList<QGeoCoordinate>
 }
 
 /*!
-    \qmlmethod MapPolyline::addCoordinate(coordinate)
+    \qmlmethod void MapPolyline::addCoordinate(coordinate)
 
     Adds a coordinate to the path.
 
@@ -560,7 +560,7 @@ void QDeclarativePolylineMapItem::addCoordinate(const QGeoCoordinate &coordinate
 }
 
 /*!
-    \qmlmethod MapPolyline::removeCoordinate(coordinate)
+    \qmlmethod void MapPolyline::removeCoordinate(coordinate)
 
     Removes a coordinate from the path. If there are multiple instances of the
     same coordinate, the one added last is removed.