diff options
| author | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2023-03-03 10:24:55 +0100 |
|---|---|---|
| committer | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2023-03-06 17:49:01 +0100 |
| commit | fea04eea8b142aa5ac89b1024bbfc5298685fb0c (patch) | |
| tree | 936accd138dd20ee0912daa1c8ca4d0347c549a1 /src | |
| parent | b150a6c61e9bc26fa5ab503f59932deaed3f795e (diff) | |
| download | qtlocation-fea04eea8b142aa5ac89b1024bbfc5298685fb0c.tar.gz | |
Doc: Fix links and snippets
Add modules in which linked-to types live to the qdoc dependencies, fix
links, and adapt snippets to changes in the examples (and add tags to
quoted files as needed).
This makes the documentation generate without warnings, so set the
warninglimit to 0 as well to block future regressions.
Pick-to: 6.5 6.5.0
Change-Id: I43fdfce1087c2a35212f91b41bba1ff9481e609d
Reviewed-by: Matthias Rauter <matthias.rauter@qt.io>
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
Reviewed-by: <safiyyah.moosa@qt.io>
Diffstat (limited to 'src')
| -rw-r--r-- | src/location/doc/qtlocation.qdocconf | 5 | ||||
| -rw-r--r-- | src/location/doc/src/qml-maps.qdoc | 4 | ||||
| -rw-r--r-- | src/location/quickmapitems/qdeclarativepolygonmapitem.cpp | 2 |
3 files changed, 7 insertions, 4 deletions
diff --git a/src/location/doc/qtlocation.qdocconf b/src/location/doc/qtlocation.qdocconf index 8840e3f5..12f6de8b 100644 --- a/src/location/doc/qtlocation.qdocconf +++ b/src/location/doc/qtlocation.qdocconf @@ -30,7 +30,7 @@ qhp.QtLocation.subprojects.examples.selectors = fake:example tagfile = ../../../doc/qtlocation/qtlocation.tags -depends += qtcore qtdoc qtgui qtquick qtqml qtnetwork qtpositioning qtlinguist +depends += qtcore qtdoc qtgui qtwidgets qtquick qtquickcontrols qtqml qtqmlmodels qtnetwork qtpositioning qtlinguist headerdirs += .. @@ -47,3 +47,6 @@ imagedirs += images navigation.landingpage = "Qt Location" navigation.cppclassespage = "Qt Location C++ Classes" navigation.qmltypespage = "Qt Location QML Types" + +# Fail the documentation build when warnings get introduced +warninglimit = 0 diff --git a/src/location/doc/src/qml-maps.qdoc b/src/location/doc/src/qml-maps.qdoc index 6a78ae32..8c7407fd 100644 --- a/src/location/doc/src/qml-maps.qdoc +++ b/src/location/doc/src/qml-maps.qdoc @@ -175,10 +175,10 @@ The \l Map item also supports user interface interactions with the map using tactile and mouse gestures. That is features such as swiping to pan, pinching to zoom. -Enabling and configuring pinch and flickable is easy within the \l Map type. +Enabling and configuring pinch and flickable is easy within the \l MapView type. \snippet mapviewer/map/MapComponent.qml top -\snippet mapviewer/map/MapComponent.qml mapnavigation +\snippet mapviewer/map/MapComponent.qml handler \snippet mapviewer/map/MapComponent.qml end Zoom can also be controlled by other objects like sliders, with binding diff --git a/src/location/quickmapitems/qdeclarativepolygonmapitem.cpp b/src/location/quickmapitems/qdeclarativepolygonmapitem.cpp index 1acd3e60..0ace1629 100644 --- a/src/location/quickmapitems/qdeclarativepolygonmapitem.cpp +++ b/src/location/quickmapitems/qdeclarativepolygonmapitem.cpp @@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE \l border.width properties. \note Since MapPolygons are geographic items, dragging a MapPolygon - (through the use of \l MouseArea or \l PointHander) causes its vertices to be + (through the use of \l MouseArea or \l PointHandler) causes its vertices to be recalculated in the geographic coordinate space. The edges retain the same geographic lengths (latitude and longitude differences between the vertices), but they remain straight. Apparent stretching of the item occurs |