From a467eadd46bec7a66e2e97bc4fd3a5271430bc93 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Fri, 8 Nov 2019 23:57:52 +0100 Subject: Doc: Fix documentation warnings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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ö Reviewed-by: Paul Wicking --- src/location/labs/qgeojson.cpp | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'src/location/labs/qgeojson.cpp') 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); -- cgit v1.2.1