diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2018-03-26 09:40:56 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@qt.io> | 2018-03-27 10:16:26 +0000 |
| commit | acc8bc079cda6a31a9d19dca860a1a2db378addf (patch) | |
| tree | ba4062a266431d7724d528c89364e9c1dc2f2be2 /src/location/declarativemaps/qdeclarativegeomap.cpp | |
| parent | 0af62cbe7ddf6a6ef858daa63b0ab02426d3aad9 (diff) | |
| download | qtlocation-acc8bc079cda6a31a9d19dca860a1a2db378addf.tar.gz | |
Doc: Fix all documentation warnings
Fix multiple warnings caused by invalid documentation configuration,
missing QML module specifiers, wrong QML type names, incorrect
arguments for the \fn command, and missing documentation.
Remove incorrect statement from the example usage of the Waypoint
QML type.
Use 'QtLocation' as the name for the module throughout the docs.
Clang (used as the parser for QDoc in Qt 5.11) was unable to
resolve the path for qlocation.h, causing QDoc to omit the
QLocation namespace documentation. Fix this by including the
file explicitly from qlocationglobal.h for documentation
builds.
Change-Id: I2bd790db1ff5ad96f0cdb415a682b97593b3a6dc
Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'src/location/declarativemaps/qdeclarativegeomap.cpp')
| -rw-r--r-- | src/location/declarativemaps/qdeclarativegeomap.cpp | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/src/location/declarativemaps/qdeclarativegeomap.cpp b/src/location/declarativemaps/qdeclarativegeomap.cpp index 5d0acede..17131c3d 100644 --- a/src/location/declarativemaps/qdeclarativegeomap.cpp +++ b/src/location/declarativemaps/qdeclarativegeomap.cpp @@ -76,7 +76,7 @@ static qreal sanitizeBearing(qreal bearing) \instantiates QDeclarativeGeoMap \inqmlmodule QtLocation \ingroup qml-QtLocation5-maps - \since Qt Location 5.0 + \since QtLocation 5.0 \brief The Map type displays a map. @@ -947,7 +947,7 @@ qreal QDeclarativeGeoMap::zoomLevel() const If the Plugin used for the Map supports bearing, the valid range for this value is between 0 and 360. If the Plugin used for the Map does not support bearing, changing this property will have no effect. - \since Qt Location 5.9 + \since QtLocation 5.9 */ void QDeclarativeGeoMap::setBearing(qreal bearing) { @@ -1015,7 +1015,7 @@ qreal QDeclarativeGeoMap::bearing() const \sa minimumTilt, maximumTilt - \since Qt Location 5.9 + \since QtLocation 5.9 */ void QDeclarativeGeoMap::setTilt(qreal tilt) { @@ -1067,7 +1067,7 @@ void QDeclarativeGeoMap::setMinimumTilt(qreal minimumTilt, bool userSet) \sa minimumFieldOfView, maximumFieldOfView - \since Qt Location 5.9 + \since QtLocation 5.9 */ void QDeclarativeGeoMap::setFieldOfView(qreal fieldOfView) { @@ -1116,7 +1116,7 @@ void QDeclarativeGeoMap::setMinimumFieldOfView(qreal minimumFieldOfView, bool us \sa fieldOfView, maximumFieldOfView - \since Qt Location 5.9 + \since QtLocation 5.9 */ qreal QDeclarativeGeoMap::minimumFieldOfView() const { @@ -1153,7 +1153,7 @@ void QDeclarativeGeoMap::setMaximumFieldOfView(qreal maximumFieldOfView, bool us \sa fieldOfView, minimumFieldOfView - \since Qt Location 5.9 + \since QtLocation 5.9 */ qreal QDeclarativeGeoMap::maximumFieldOfView() const { @@ -1171,7 +1171,7 @@ qreal QDeclarativeGeoMap::maximumFieldOfView() const \sa tilt, maximumTilt - \since Qt Location 5.9 + \since QtLocation 5.9 */ qreal QDeclarativeGeoMap::minimumTilt() const { @@ -1208,7 +1208,7 @@ void QDeclarativeGeoMap::setMaximumTilt(qreal maximumTilt, bool userSet) \sa tilt, minimumTilt - \since Qt Location 5.9 + \since QtLocation 5.9 */ qreal QDeclarativeGeoMap::maximumTilt() const { @@ -2082,7 +2082,7 @@ void QDeclarativeGeoMap::geometryChanged(const QRectF &newGeometry, const QRectF } } - /*! + /* The fitViewportTo*() functions depend on a valid map geometry. If they were called prior to the first resize they cause the zoomlevel to jump to 0 (showing the world). Therefore the |