diff options
author | Ian Chen <ian.1.chen@nokia.com> | 2012-03-26 18:12:56 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-03-27 03:16:28 +0200 |
commit | 712b8a611089c6436747f966cb813160d78da605 (patch) | |
tree | f3d61fc38db3bdebe0cbe64d6bec8d3f8dca592c | |
parent | b60dc91cebdea5d6737e45dc8718cb8d77bcb49c (diff) |
Documentation fixes
MapFlickable:
- Documentation now uses US english, customises -> customizes
- 'deceleration' documented as real as opposed to bool
- correct grammatical error in description for onMovementStarted
MapCircle, MapRectangle:
- rephrase description of the 'opacity' property
MapPolygon, MapPolygon:
- Minor corrections to [add/remove]Coordinate function descriptions
MapPolygon:
- Changed references to 'polyline' to lowercase first letter
Change-Id: Ia62665848efbe59c95e81c1c16203fbae394edce
Reviewed-by: Alex Wilson <alex.wilson@nokia.com>
5 files changed, 14 insertions, 13 deletions
diff --git a/src/imports/location/qdeclarativecirclemapitem.cpp b/src/imports/location/qdeclarativecirclemapitem.cpp index b25f480d..4f7135c3 100644 --- a/src/imports/location/qdeclarativecirclemapitem.cpp +++ b/src/imports/location/qdeclarativecirclemapitem.cpp @@ -313,7 +313,7 @@ qreal QDeclarativeCircleMapItem::radius() const number between 0 (fully transparent) and 1 (fully opaque). The default is 1. If an item's opacity is set to 0, the item will no longer receive mouse - events. In contrast, setting the visible property to false stops mouse events. + events. Similarly, setting the visible property to false stops mouse events. */ diff --git a/src/imports/location/qdeclarativegeomapflickable.cpp b/src/imports/location/qdeclarativegeomapflickable.cpp index 5e0418a3..06ab7871 100644 --- a/src/imports/location/qdeclarativegeomapflickable.cpp +++ b/src/imports/location/qdeclarativegeomapflickable.cpp @@ -88,7 +88,7 @@ QT_BEGIN_NAMESPACE The two most commonly used properties of the MapFlickable are \l enabled and \l deceleration. The former must be set in order for the MapFlickable to - have any effect upon its parent Map. The latter property customises the + have any effect upon its parent Map. The latter property customizes the response of the MapFlickable to input from the user, by adjusting how much "friction" slows down the flick after the user has raised their finger or released the mouse button. @@ -130,9 +130,10 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlproperty bool QtLocation5::MapFlickable::deceleration + \qmlproperty real QtLocation5::MapFlickable::deceleration - This property holds the rate at which a flick will decelerate. + This property holds the rate at which a flick will decelerate. The + larger the value, the faster the flick decelerates. Default value is 2500, minimum value is 500 and maximum value is 10000. */ @@ -140,8 +141,8 @@ QT_BEGIN_NAMESPACE \qmlsignal QtLocation5::MapFlickable::onMovementStarted() This handler is called when the view begins moving due to user - interaction. Typically this means that user is dragging finger - or mouse on the map (mouse with pressed button) but has not released yet. + interaction. Typically this means that the user is dragging a finger - + or a mouse with one of more mouse buttons pressed - on the map. */ /*! diff --git a/src/imports/location/qdeclarativepolygonmapitem.cpp b/src/imports/location/qdeclarativepolygonmapitem.cpp index cd17be65..8ace4c9d 100644 --- a/src/imports/location/qdeclarativepolygonmapitem.cpp +++ b/src/imports/location/qdeclarativepolygonmapitem.cpp @@ -326,7 +326,7 @@ void QDeclarativePolygonMapItem::path_clear( /*! \qmlmethod MapPolygon::addCoordinate(Coordinate) - Adds coordinate to the path. + Adds a coordinate to the path. \sa removeCoordinate path */ @@ -348,7 +348,7 @@ void QDeclarativePolygonMapItem::addCoordinate(QDeclarativeCoordinate* coordinat /*! \qmlmethod MapPolygon::removeCoordinate(Coordinate) - Remove coordinate from the path. If there are multiple instances of the + Removes a coordinate from the path. If there are multiple instances of the same coordinate, the one added last is removed. \sa addCoordinate path diff --git a/src/imports/location/qdeclarativepolylinemapitem.cpp b/src/imports/location/qdeclarativepolylinemapitem.cpp index dea4d192..e8c5440d 100644 --- a/src/imports/location/qdeclarativepolylinemapitem.cpp +++ b/src/imports/location/qdeclarativepolylinemapitem.cpp @@ -74,8 +74,8 @@ QT_BEGIN_NAMESPACE \section2 Performance MapPolylines have a rendering cost that is O(n) with respect to the number - of vertices. This means that the per frame cost of having a Polyline on - the Map grows in direct proportion to the number of points in the Polyline. + of vertices. This means that the per frame cost of having a polyline on + the Map grows in direct proportion to the number of points in the polyline. Like the other map objects, MapPolyline is normally drawn without a smooth appearance. Setting the \l opacity property will force the object to be @@ -497,7 +497,7 @@ void QDeclarativePolylineMapItem::path_clear( /*! \qmlmethod MapPolyline::addCoordinate(Coordinate) - Adds coordinate to the path. + Adds a coordinate to the path. \sa removeCoordinate path */ @@ -518,7 +518,7 @@ void QDeclarativePolylineMapItem::addCoordinate(QDeclarativeCoordinate* coordina /*! \qmlmethod MapPolyline::removeCoordinate(Coordinate) - Remove coordinate from the path. If there are multiple instances of the + Removes a coordinate from the path. If there are multiple instances of the same coordinate, the one added last is removed. \sa addCoordinate path diff --git a/src/imports/location/qdeclarativerectanglemapitem.cpp b/src/imports/location/qdeclarativerectanglemapitem.cpp index a0f3ae10..95a56d50 100644 --- a/src/imports/location/qdeclarativerectanglemapitem.cpp +++ b/src/imports/location/qdeclarativerectanglemapitem.cpp @@ -282,7 +282,7 @@ void QDeclarativeRectangleMapItem::setColor(const QColor &color) number between 0 (fully transparent) and 1 (fully opaque). The default is 1. If an item's opacity is set to 0, the item will no longer receive mouse - events. In contrast, setting the visible property to false stops mouse events. + events. Similarly, setting the visible property to false stops mouse events. */ QSGNode* QDeclarativeRectangleMapItem::updatePaintNode(QSGNode* oldNode, UpdatePaintNodeData* data) { |