summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorVolker Hilsheimer <volker.hilsheimer@qt.io>2023-03-03 10:24:55 +0100
committerVolker Hilsheimer <volker.hilsheimer@qt.io>2023-03-06 17:49:01 +0100
commitfea04eea8b142aa5ac89b1024bbfc5298685fb0c (patch)
tree936accd138dd20ee0912daa1c8ca4d0347c549a1 /examples
parentb150a6c61e9bc26fa5ab503f59932deaed3f795e (diff)
downloadqtlocation-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 'examples')
-rw-r--r--examples/location/geojson_viewer/doc/src/geojson_viewer.qdoc6
-rw-r--r--examples/location/mapviewer/doc/src/mapviewer.qdoc2
-rw-r--r--examples/location/mapviewer/map/MapComponent.qml2
-rw-r--r--examples/location/places/doc/src/places.qdoc5
4 files changed, 5 insertions, 10 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