diff options
| author | Andreas Eliasson <andreas.eliasson@qt.io> | 2023-08-31 11:02:01 +0200 |
|---|---|---|
| committer | Andreas Eliasson <andreas.eliasson@qt.io> | 2023-08-31 16:04:23 +0200 |
| commit | 55d3b8087f22e097a09c07bfc33a64146881df2f (patch) | |
| tree | 30137f9b2d3abd11ce4549619249855480ab2acf | |
| parent | 3a1b28126a0a182bef9fe0ccb85409fceb39d1f3 (diff) | |
Doc: Fix qdoc warnings
Fixes the following qdoc warnings:
* Can't link to 'QGeoJsonData'
* Can't link to 'item'
* Undocumented parameter 'item' in GeoJsonData::addItem()
* Undocumented return value (hint: use 'return' or 'returns' in the text
Change-Id: Iece31b3c94fbbde1b2d18800ba52d5323fd2ba61
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
| -rw-r--r-- | examples/location/geojson_viewer/doc/src/geojson_viewer.qdoc | 2 | ||||
| -rw-r--r-- | src/location/declarativemaps/qdeclarativegeojsondata.cpp | 4 |
2 files changed, 4 insertions, 2 deletions
diff --git a/examples/location/geojson_viewer/doc/src/geojson_viewer.qdoc b/examples/location/geojson_viewer/doc/src/geojson_viewer.qdoc index 62ab0388..a0d01c84 100644 --- a/examples/location/geojson_viewer/doc/src/geojson_viewer.qdoc +++ b/examples/location/geojson_viewer/doc/src/geojson_viewer.qdoc @@ -13,7 +13,7 @@ \image geojson_viewer.png The example displays a map with various MapItems. The MapItems are either imported from a - GeoJson file, using the \l {QGeoJsonData} API of \l {QtLocation} or drawn by the user using + GeoJson file, using the \l {GeoJsonData} API of \l {QtLocation} or drawn by the user using \l {TapHandler}{TapHandlers}. Examples for GeoJson files can be found in the directory data within the example directory. diff --git a/src/location/declarativemaps/qdeclarativegeojsondata.cpp b/src/location/declarativemaps/qdeclarativegeojsondata.cpp index 21c4e83f..3640943f 100644 --- a/src/location/declarativemaps/qdeclarativegeojsondata.cpp +++ b/src/location/declarativemaps/qdeclarativegeojsondata.cpp @@ -166,7 +166,7 @@ void QDeclarativeGeoJsonData::clear() /*! \qmlmethod bool QtLocation::GeoJsonData::addItem(Item item) - Add the \l item to the \l model of the GeoJsonData. + Add the \a item to the \l model of the GeoJsonData. Returns \c true if the file was read successfully, \c false otherwise. */ @@ -282,6 +282,8 @@ bool QDeclarativeGeoJsonData::save() object. Previously stored mapItems are deleted from the \l model. + Returns \c true if mapItemView is set successfully, \c false otherwise. + \sa addItem */ void QDeclarativeGeoJsonData::setModelToMapContents(QDeclarativeGeoMap *map) |