From fea04eea8b142aa5ac89b1024bbfc5298685fb0c Mon Sep 17 00:00:00 2001 From: Volker Hilsheimer Date: Fri, 3 Mar 2023 10:24:55 +0100 Subject: 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 Reviewed-by: Andreas Eliasson Reviewed-by: --- examples/location/geojson_viewer/doc/src/geojson_viewer.qdoc | 6 +++--- examples/location/mapviewer/doc/src/mapviewer.qdoc | 2 -- examples/location/mapviewer/map/MapComponent.qml | 2 ++ examples/location/places/doc/src/places.qdoc | 5 ----- src/location/doc/qtlocation.qdocconf | 5 ++++- src/location/doc/src/qml-maps.qdoc | 4 ++-- src/location/quickmapitems/qdeclarativepolygonmapitem.cpp | 2 +- 7 files changed, 12 insertions(+), 14 deletions(-) diff --git a/examples/location/geojson_viewer/doc/src/geojson_viewer.qdoc b/examples/location/geojson_viewer/doc/src/geojson_viewer.qdoc index b90c02b8..98c7cb93 100644 --- a/examples/location/geojson_viewer/doc/src/geojson_viewer.qdoc +++ b/examples/location/geojson_viewer/doc/src/geojson_viewer.qdoc @@ -45,7 +45,7 @@ \section1 Setting up the GeoJson Model / Display MapItems In order to display file contents on the map we will use a design pattern known as - \l {model-view-programming}{Model/View Programming}. First we need to set up a suitable view, + \l {model-view-programming.html}{Model/View Programming}. First we need to set up a suitable view, in this example a \l {MapItemView} element. Its parent must be set to the underlying map of the \l {MapView} to correctly display all items placed in it. @@ -135,7 +135,7 @@ The \l {TapHandler} is used to write some information about the item on the console when the item is tapped. The \l {HoverHandler} is used to highlight items that lie beneath the mouse pointer. This is implemented by describing the property - \l {MapCircle::border::color}{border.color} depending on the property / state + \l {MapCircle::border.color}{border.color} depending on the property / state \l {HoverHandler::hovered}{hovered} of the \l{HoverHandler}. @@ -151,7 +151,7 @@ \snippet geojson_viewer/main.qml Taphandler Map - The \l {HoverHandler::pointChanged}{pointChanged} signal is used to temporarily update a + The \l {SinglePointHandler::point}{pointChanged} signal is used to temporarily update a MapItem, giving the user a preview. \snippet geojson_viewer/main.qml Hoverhandler Map diff --git a/examples/location/mapviewer/doc/src/mapviewer.qdoc b/examples/location/mapviewer/doc/src/mapviewer.qdoc index b1d2e01d..eb778bb4 100644 --- a/examples/location/mapviewer/doc/src/mapviewer.qdoc +++ b/examples/location/mapviewer/doc/src/mapviewer.qdoc @@ -107,13 +107,11 @@ we will use a MapItemView, to display the Routes as objects on the Map: \snippet mapviewer/map/MapComponent.qml routeview0 - \snippet mapviewer/map/MapComponent.qml routeview1 To act as a template for the objects we wish the view to create, we create a delegate component: \snippet mapviewer/map/MapComponent.qml routedelegate0 - \snippet mapviewer/map/MapComponent.qml routedelegate1 With the model, view and delegate now complete, the only missing component is some kind of control over the model to begin the Route request process. diff --git a/examples/location/mapviewer/map/MapComponent.qml b/examples/location/mapviewer/map/MapComponent.qml index 6f887536..2a2b0a5f 100644 --- a/examples/location/mapviewer/map/MapComponent.qml +++ b/examples/location/mapviewer/map/MapComponent.qml @@ -460,6 +460,7 @@ MapView { onTriggered: view.calculateScale() } + //! [handler] TapHandler { id: tapHandler property variant lastCoordinate @@ -492,6 +493,7 @@ MapView { view.map.center.longitude - dy); } } + //! [handler] //! [end] } //! [end] diff --git a/examples/location/places/doc/src/places.qdoc b/examples/location/places/doc/src/places.qdoc index 9ae584f0..9d82cdff 100644 --- a/examples/location/places/doc/src/places.qdoc +++ b/examples/location/places/doc/src/places.qdoc @@ -69,11 +69,6 @@ \snippet places/views/CategoryDelegate.qml CategoryModel delegate text - The \e CategoryDelegate also displays \e arrow \l {ToolButton} when \e hasModelChildren property is set. - - \snippet places/views/CategoryDelegate.qml CategoryModel delegate arrow - - \target Presenting-Search-Suggestions \section1 Presenting Search Suggestions 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 -- cgit v1.2.1