summaryrefslogtreecommitdiff
path: root/src/location/labs/qgeojson.cpp
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2019-11-08 23:57:52 +0100
committerTopi Reinio <topi.reinio@qt.io>2019-11-14 12:14:14 +0100
commita467eadd46bec7a66e2e97bc4fd3a5271430bc93 (patch)
treeda0f988be1b020ea64c9cb66c09e80552e1afc90 /src/location/labs/qgeojson.cpp
parent664a83674b2bf8313763870c9eca7c4c558a14bc (diff)
downloadqtlocation-a467eadd46bec7a66e2e97bc4fd3a5271430bc93.tar.gz
Doc: Fix documentation warnings
Fix missing/incorrect parameter documentation, linking warnings, and \instantiates references to undocumented/internal classes. Remove mention of Navigator::currentRoute, as such a property no longer exists. Fixes: QTBUG-79811 Change-Id: I048a13109aa19f3db75e76611473d60a2396f028 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/location/labs/qgeojson.cpp')
-rw-r--r--src/location/labs/qgeojson.cpp14
1 files changed, 7 insertions, 7 deletions
diff --git a/src/location/labs/qgeojson.cpp b/src/location/labs/qgeojson.cpp
index f7f37661..151091ca 100644
--- a/src/location/labs/qgeojson.cpp
+++ b/src/location/labs/qgeojson.cpp
@@ -65,7 +65,7 @@ QT_BEGIN_NAMESPACE
\section2 Importing GeoJSON
- The method \l importGeoJson accepts a \l
+ The importGeoJson() method accepts a \l
{http://doc.qt.io/qt-5/qjsondocument.html} {QJsonDocument} from which it
extracts a single \l {https://tools.ietf.org/html/rfc7159} {JSON} object,
since the GeoJSON RFC expects that a valid GeoJSON Document has in its root
@@ -503,9 +503,9 @@ QT_BEGIN_NAMESPACE
\section2 Exporting GeoJSON
- The exporter accepts the QVariantList returned by \l {The importer}, and
- returns a JSON document. The exporter is complementary to the importer
- because it executes the inverse action.
+ The exporter accepts the QVariantList returned by the \l {Importing GeoJSON}
+ {importer}, and returns a JSON document. The exporter is complementary to
+ the importer because it executes the inverse action.
\section2 The toString function
@@ -1231,9 +1231,9 @@ QString printQvariant(const QVariant v, int tabs = 0) {
}
/*!
-This method accepts the QVariantLists structured like described in section \l
-{Importing GeoJSON}, and returns a string containing the same data in a
-readable form.
+ This method accepts the QVariantList \a geoData, structured as described in
+ \l {Importing GeoJSON}, and returns a string containing the same data in a
+ readable form.
*/
QString QGeoJson::toString(const QVariantList &geoData) {
return printQvariant(geoData.first(), 0);