summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2017-01-30 12:48:04 +0100
committerTopi Reiniƶ <topi.reinio@qt.io>2017-01-30 13:18:26 +0000
commit25b42f4165d23b64faa02adf6c71d6c5f6d985bb (patch)
tree4932f43f43356ef06b1c5e5c468a4a1e5bfdfffa
parentbe13464a488ccc2837b0c178ff16086be341e570 (diff)
Doc: Location *Reply classes: Document aborted() signal
Fixes the following qdoc warnings: src/location/maps/qgeocodereply.h:83: warning: No documentation for 'QGeoCodeReply::aborted()' src/location/maps/qgeoroutereply.h:77: warning: No documentation for 'QGeoRouteReply::aborted()' src/location/places/qplacereply.h:89: warning: No documentation for 'QPlaceReply::aborted()' Change-Id: Id8c871abf2a197e41042bfa74e1abf9db94a65e4 Reviewed-by: Paolo Angelelli <paolo.angelelli@qt.io> Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
-rw-r--r--src/location/maps/qgeocodereply.cpp11
-rw-r--r--src/location/maps/qgeoroutereply.cpp9
-rw-r--r--src/location/places/qplacereply.cpp13
3 files changed, 32 insertions, 1 deletions
diff --git a/src/location/maps/qgeocodereply.cpp b/src/location/maps/qgeocodereply.cpp
index d5112a69..85e6e1f5 100644
--- a/src/location/maps/qgeocodereply.cpp
+++ b/src/location/maps/qgeocodereply.cpp
@@ -225,9 +225,20 @@ void QGeoCodeReply::setLocations(const QList<QGeoLocation> &locations)
}
/*!
+ \fn void QGeoCodeReply::aborted()
+ \since 5.9
+
+ This signal is emitted when the operation has been cancelled.
+
+ \sa abort()
+*/
+
+/*!
Cancels the operation immediately.
This will do nothing if the reply is finished.
+
+ \sa aborted()
*/
void QGeoCodeReply::abort()
{
diff --git a/src/location/maps/qgeoroutereply.cpp b/src/location/maps/qgeoroutereply.cpp
index b1c98349..6f7b3129 100644
--- a/src/location/maps/qgeoroutereply.cpp
+++ b/src/location/maps/qgeoroutereply.cpp
@@ -212,6 +212,15 @@ void QGeoRouteReply::addRoutes(const QList<QGeoRoute> &routes)
}
/*!
+ \fn void QGeoRouteReply::aborted()
+ \since 5.9
+
+ This signal is emitted when the operation has been cancelled.
+
+ \sa abort()
+*/
+
+/*!
Cancels the operation immediately.
This will do nothing if the reply is finished.
diff --git a/src/location/places/qplacereply.cpp b/src/location/places/qplacereply.cpp
index 582987b4..55e67e43 100644
--- a/src/location/places/qplacereply.cpp
+++ b/src/location/places/qplacereply.cpp
@@ -195,7 +195,18 @@ QPlaceReply::Error QPlaceReply::error() const
}
/*!
- Aborts the operation.
+ \fn void QPlaceReply::aborted()
+ \since 5.9
+
+ This signal is emitted when the operation has been cancelled.
+
+ \sa abort()
+*/
+
+/*!
+ Cancels the operation immediately.
+
+ \sa aborted()
*/
void QPlaceReply::abort()
{