summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSze Howe Koh <szehowe.koh@gmail.com>2014-03-15 09:06:39 +0800
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-18 12:50:41 +0100
commita13d8e8862402a144ace00e409341185783927df (patch)
treedac8ceb83fb8d6702a405c10d00f79d18898ec35
parent5619874cadc3c0f7524883d11da3ed0de17b28fb (diff)
Doc: Document signals (not handlers) under \qmlsignalv5.3.0-beta1
Append the handler names to the end of the corresponding signal doc. Task-number: QTBUG-35846 Change-Id: Ib4699ff82b8411b4cfb4400097deaca62f6d3bb0 Reviewed-by: Alex Blasche <alexander.blasche@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
-rw-r--r--src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp6
-rw-r--r--src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp4
-rw-r--r--src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp4
-rw-r--r--src/imports/location/qdeclarativegeomapgesturearea.cpp36
4 files changed, 35 insertions, 15 deletions
diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp
index 0edd0d1c..fdb893dc 100644
--- a/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp
@@ -113,10 +113,12 @@
*/
/*!
- \qmlsignal void ExtendedAttributes::onValueChanged(string key, variant value)
+ \qmlsignal void ExtendedAttributes::valueChanged(string key, variant value)
- This signal is raised when the set of attributes changes. \a key is the key
+ This signal is emitted when the set of attributes changes. \a key is the key
corresponding to the \a value that was changed.
+
+ The corresponding handler is \c onValueChanged.
*/
/*!
diff --git a/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp
index ed97e93e..8378b33b 100644
--- a/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp
@@ -908,11 +908,13 @@ int QDeclarativeSearchResultModel::getRow(const QString &placeId) const
/*!
\qmlsignal PlaceSearchResultModel::dataChanged()
- Indicates that significant changes have been made to the underlying datastore.
+ This signal is emitted when significant changes have been made to the underlying datastore.
Applications should act on this signal at their own discretion. The data
provided by the model could be out of date and so the model should be reupdated
sometime, however an immediate reupdate may be disconcerting to users if the results
change without any action on their part.
+
+ The corresponding handler is \c onDataChanged.
*/
diff --git a/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp
index 7d50af7e..c2d765e4 100644
--- a/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp
+++ b/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp
@@ -671,10 +671,12 @@ int QDeclarativeSupportedCategoriesModel::rowToAddChild(PlaceCategoryNode *node,
/*!
\qmlsignal CategoryModel::dataChanged()
- Indicates that significant changes have been made to the underlying datastore.
+ This signal is emitted when significant changes have been made to the underlying datastore.
Applications should act on this signal at their own discretion. The data
provided by the model could be out of date and so the model should be reupdated
sometime, however an immediate reupdate may be disconcerting to users if the categories
change without any action on their part.
+
+ The corresponding handler is \c onDataChanged.
*/
diff --git a/src/imports/location/qdeclarativegeomapgesturearea.cpp b/src/imports/location/qdeclarativegeomapgesturearea.cpp
index 9adc422d..336f922f 100644
--- a/src/imports/location/qdeclarativegeomapgesturearea.cpp
+++ b/src/imports/location/qdeclarativegeomapgesturearea.cpp
@@ -263,7 +263,9 @@ QT_BEGIN_NAMESPACE
/*!
\qmlsignal QtLocation::MapGestureArea::pinchStarted(PinchEvent event)
- Raised when a pinch gesture is started.
+ This signal is emitted when a pinch gesture is started.
+
+ The corresponding handler is \c onPinchStarted.
\sa pinchUpdated, pinchFinished
*/
@@ -271,8 +273,10 @@ QT_BEGIN_NAMESPACE
/*!
\qmlsignal QtLocation::MapGestureArea::pinchUpdated(PinchEvent event)
- Once a pinch has begun this event gets raised as the user moves her fingers
- across the map.
+ This signal is emitted as the user's fingers move across the map,
+ after the the \l pinchStarted signal is emitted.
+
+ The corresponding handler is \c onPinchUpdated.
\sa pinchStarted, pinchFinished
*/
@@ -280,7 +284,9 @@ QT_BEGIN_NAMESPACE
/*!
\qmlsignal QtLocation::MapGestureArea::pinchFinished(PinchEvent event)
- The end of a pinch gesture is signaled by this event.
+ This signal is emitted at the end of a pinch gesture.
+
+ The corresponding handler is \c onPinchFinished.
\sa pinchStarted, pinchUpdated
*/
@@ -288,35 +294,43 @@ QT_BEGIN_NAMESPACE
/*!
\qmlsignal QtLocation::MapGestureArea::panStarted()
- This handler is called when the view begins moving due to user
+ This signal is emitted when the view begins moving due to user
interaction. Typically this means that the user is dragging a finger -
or a mouse with one of more mouse buttons pressed - on the map.
+
+ The corresponding handler is \c onPanStarted.
*/
/*!
\qmlsignal QtLocation::MapGestureArea::panFinished()
- This handler is called when the view stops moving due to user
- interaction. If a flick was generated, this handler will
- be triggered once the flick stops. If a flick was not
- generated, the handler will be triggered when the
+ This signal is emitted when the view stops moving due to user
+ interaction. If a flick was generated, this signal is
+ emitted when the flick stops. If a flick was not
+ generated, this signal is emitted when the
user stops dragging - that is a mouse or touch release.
+ The corresponding handler is \c onPanFinished.
+
*/
/*!
\qmlsignal QtLocation::MapGestureArea::flickStarted()
- This handler is called when the view is flicked. A flick
+ This signal is emitted when the view is flicked. A flick
starts from the point that the mouse or touch is released,
while still in motion.
+
+ The corresponding handler is \c onFlichStarted.
*/
/*!
\qmlsignal QtLocation::MapGestureArea::flickFinished()
- This handler is called when the view stops moving due to a flick.
+ This signal is emitted when the view stops moving due to a flick.
The order of panFinished() and flickFinished() is not specified.
+
+ The corresponding handler is \c onFlickFinished.
*/
QDeclarativeGeoMapGestureArea::QDeclarativeGeoMapGestureArea(QDeclarativeGeoMap *map, QObject *parent)