diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2019-05-15 11:25:30 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@qt.io> | 2019-05-16 08:07:18 +0000 |
| commit | 90defc33dceb341aa8dac03c0511b1ef2a20c6c2 (patch) | |
| tree | d33bc5a8991bfd68df70e9a350aa78f70cc13d3d /src/location/declarativemaps/qdeclarativegeomap.cpp | |
| parent | 190909eb1e537f9840b38eff47713281edc8a204 (diff) | |
| download | qtlocation-90defc33dceb341aa8dac03c0511b1ef2a20c6c2.tar.gz | |
Doc: Fix documentation issues
Fix various documentation-related issues, including
missing parameter documentation, broken links, and
typos.
Do some minor language editing.
Change-Id: I0a8f8457e0d1ab56b4fc4670376509adf1fd26a3
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/location/declarativemaps/qdeclarativegeomap.cpp')
| -rw-r--r-- | src/location/declarativemaps/qdeclarativegeomap.cpp | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/src/location/declarativemaps/qdeclarativegeomap.cpp b/src/location/declarativemaps/qdeclarativegeomap.cpp index 1b5ea11c..5997bd3e 100644 --- a/src/location/declarativemaps/qdeclarativegeomap.cpp +++ b/src/location/declarativemaps/qdeclarativegeomap.cpp @@ -1505,7 +1505,7 @@ void QDeclarativeGeoMap::alignCoordinateToPoint(const QGeoCoordinate &coordinate Returns the coordinate which corresponds to the \a position relative to the map item. - If \a cliptoViewPort is \c true, or not supplied then returns an invalid coordinate if + If \a clipToViewPort is \c true, or not supplied then returns an invalid coordinate if \a position is not within the current viewport. */ QGeoCoordinate QDeclarativeGeoMap::toCoordinate(const QPointF &position, bool clipToViewPort) const @@ -1521,7 +1521,7 @@ QGeoCoordinate QDeclarativeGeoMap::toCoordinate(const QPointF &position, bool cl Returns the position relative to the map item which corresponds to the \a coordinate. - If \a cliptoViewPort is \c true, or not supplied then returns an invalid QPointF if + If \a clipToViewPort is \c true, or not supplied then returns an invalid QPointF if \a coordinate is not within the current viewport. */ QPointF QDeclarativeGeoMap::fromCoordinate(const QGeoCoordinate &coordinate, bool clipToViewPort) const @@ -1585,8 +1585,8 @@ void QDeclarativeGeoMap::clearData() /*! \qmlmethod void QtLocation::Map::fitViewportToGeoShape(geoShape, margins) - Fits the viewport to a specific geo shape. - The margins are in screen pixels. + Fits the viewport to a specific geo shape \a geoShape. + The \a margins are in screen pixels. \note If the projection used by the plugin is not WebMercator, and the plugin does not have fitting to shape capability, this method will do nothing. @@ -1760,7 +1760,7 @@ void QDeclarativeGeoMap::onCameraDataChanged(const QGeoCameraData &cameraData) /*! \qmlmethod void QtLocation::Map::addMapParameter(MapParameter parameter) - Adds a MapParameter object to the map. The effect of this call is dependent + Adds the \a parameter object to the map. The effect of this call is dependent on the combination of the content of the MapParameter and the type of underlying QGeoMap. If a MapParameter that is not supported by the underlying QGeoMap gets added, the call has no effect. @@ -1790,7 +1790,7 @@ void QDeclarativeGeoMap::addMapParameter(QDeclarativeGeoMapParameter *parameter) /*! \qmlmethod void QtLocation::Map::removeMapParameter(MapParameter parameter) - Removes the given MapParameter object from the map. + Removes the given \a parameter object from the map. The release of this API with Qt 5.9 is a Technology Preview. |