From 118dac89625a8f713bb12e7e9f30bc37b10754b7 Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Wed, 24 Apr 2019 12:09:21 +0200 Subject: Doc: Fix link errors and complete parameter specs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I786ab35a0e9c8dfa2c8124692289d98e8eee4a8d Reviewed-by: Topi Reiniö --- .../positioning/geoflickr/doc/src/geoflickr.qdoc | 46 +++++++++++----------- src/imports/positioning/locationsingleton.cpp | 7 ++-- .../declarativemaps/qdeclarativegeoroute.cpp | 6 +-- .../declarativemaps/qdeclarativegeoroutemodel.cpp | 29 ++++++++------ .../declarativemaps/qdeclarativepolygonmapitem.cpp | 2 +- .../qdeclarativepolylinemapitem.cpp | 2 +- src/location/doc/qtlocation.qdocconf | 2 +- src/positioning/doc/qtpositioning.qdocconf | 2 +- src/positioning/qgeolocation.cpp | 3 +- src/positioning/qgeopolygon.cpp | 17 +++++--- src/positioningquick/qdeclarativegeoaddress.cpp | 1 - src/positioningquick/qdeclarativegeolocation.cpp | 1 - .../qquickgeocoordinateanimation.cpp | 1 - 13 files changed, 62 insertions(+), 57 deletions(-) diff --git a/examples/positioning/geoflickr/doc/src/geoflickr.qdoc b/examples/positioning/geoflickr/doc/src/geoflickr.qdoc index de74a9d6..14d6e88a 100644 --- a/examples/positioning/geoflickr/doc/src/geoflickr.qdoc +++ b/examples/positioning/geoflickr/doc/src/geoflickr.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -30,12 +30,12 @@ \title GeoFlickr (QML) \ingroup qtpositioning-examples - \brief The GeoFlickr example shows how to use the user's current position to - fetch local content from a web service. + \brief The GeoFlickr example shows how to use the user's current + position to fetch local content from a web service. - This is a small example, illustrating one of the very core parts of the - \l{Qt Positioning} API: the ability to retrieve and use the user's current - geographic position. + This is a small example, illustrating one of the very core parts + of the \l{Qt Positioning} API: the ability to retrieve and use the + user's current geographic position. Key QML types shown in this example: \list @@ -50,38 +50,38 @@ \section1 Retrieving the Current Position Retrieving the user's current position is achieved using the PositionSource - type. In this example, we instantiate the PositionSource as part of the - GeoTab component (the floating "window" describing current position and - status). + type. In this example, we instantiate the PositionSource as part + of the GeoTab component (the floating "window" describing current + position and status). \snippet geoflickr/flickrmobile/GeoTab.qml possrc - When the "Locate and update" button is pressed, we first interrogate the - PositionSource to check if it has an available backend for positioning - data. If it does not, we fall back to using a pre-recorded NMEA log - for demonstration. We then instruct the PositionSource to update. + When the "Locate and update" button is pressed, we first interrogate + the PositionSource to check if it has an available backend for + positioning data. If it does not, we fall back to using a pre-recorded + NMEA log for demonstration. We then instruct the PositionSource to update. \snippet geoflickr/flickrmobile/GeoTab.qml locatebutton-top \snippet geoflickr/flickrmobile/GeoTab.qml locatebutton-clicked - To share the new position data with the rest of the application, we use - properties that we have created on the GeoTab component: + To share the new position data with the rest of the application, we + use properties that we have created on the GeoTab component: \snippet geoflickr/flickrmobile/GeoTab.qml props \section1 Using the Current Position - The longitude and latitude values retrieved here are eventually set on - in properties on the RestModel component. The RestModel is an XmlListModel, - which retrieves XML data from a URL and creates a data model by performing - XPath queries on it. + The longitude and latitude values retrieved here are eventually set + in the properties on the RestModel component. The RestModel is an + XmlListModel, which retrieves XML data from a URL and creates a data + model by performing XPath queries on it. - In this case, it retrieves data from the Flickr REST API online, based on - our current position + In this case, it retrieves data from the Flickr REST API online, + based on our current position \snippet geoflickr/flickrcommon/RestModel.qml restmodel - This model data is then shown in a variety of Qt Quick views to produce - the example application. + This model data is then shown in a variety of Qt Quick views to + produce the example application. */ diff --git a/src/imports/positioning/locationsingleton.cpp b/src/imports/positioning/locationsingleton.cpp index 8f810d94..5bc848f3 100644 --- a/src/imports/positioning/locationsingleton.cpp +++ b/src/imports/positioning/locationsingleton.cpp @@ -97,7 +97,7 @@ QGeoCoordinate LocationSingleton::coordinate() const } /*! - \qmlmethod coordinate QtPositioning::coordinate(real latitude, real longitue, real altitude) const + \qmlmethod coordinate QtPositioning::coordinate(real latitude, real longitude, real altitude) const Constructs a coordinate with the specified \a latitude, \a longitude and optional \a altitude. Both \a latitude and \a longitude must be valid, otherwise an invalid coordinate is returned. @@ -151,7 +151,7 @@ QGeoRectangle LocationSingleton::rectangle(const QGeoCoordinate ¢er, \qmlmethod georectangle QtPositioning::rectangle(coordinate topLeft, coordinate bottomRight) const Constructs a georectangle with its top left corner positioned at \a topLeft and its bottom - right corner positioned at \a {bottomLeft}. + right corner positioned at \a {bottomRight}. \sa {georectangle} */ @@ -376,8 +376,7 @@ QGeoCoordinate LocationSingleton::mercatorToCoord(const QPointF &mercator) const /*! \qmlmethod point QtPositioning::coordToMercator(coordinate coord) const - Converts a coordinate into a mercator coordinate. - + Converts a coordinate \a coord into a mercator coordinate and returns it. \sa {mercatorToCoord} \since 5.12 */ diff --git a/src/location/declarativemaps/qdeclarativegeoroute.cpp b/src/location/declarativemaps/qdeclarativegeoroute.cpp index 8f5ec5fe..3837272e 100644 --- a/src/location/declarativemaps/qdeclarativegeoroute.cpp +++ b/src/location/declarativemaps/qdeclarativegeoroute.cpp @@ -383,9 +383,9 @@ QQmlPropertyMap *QDeclarativeGeoRoute::extendedAttributes() const /*! \qmlmethod bool QtLocation::Route::equals(Route other) - This method performs a deep comparison between this route and \a other. - - Returns \c true if the routes are considered equal, \c false otherwise. + This method performs deep comparison if the present route + is identical to the \a other route. + Returns \c true if the routes are equal. \since 5.12 */ diff --git a/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp b/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp index 695f6972..6401ba3e 100644 --- a/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp +++ b/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp @@ -115,8 +115,9 @@ static QList waypointMetadata(const QList /*! \qmlmethod void QtLocation::RouteQuery::setFeatureWeight(FeatureType feature, FeatureWeight weight) - Defines the \a weight to associate with a \a feature during the planning of a - route. + Defines the weight (\a FeatureWeight) to associate with a feature + (\a FeatureType) during the planning of a route. Following lists the possible feature weights: diff --git a/src/location/declarativemaps/qdeclarativepolygonmapitem.cpp b/src/location/declarativemaps/qdeclarativepolygonmapitem.cpp index fcfa14a5..7e988775 100644 --- a/src/location/declarativemaps/qdeclarativepolygonmapitem.cpp +++ b/src/location/declarativemaps/qdeclarativepolygonmapitem.cpp @@ -402,7 +402,7 @@ void QDeclarativePolygonMapItem::setPath(const QJSValue &value) /*! \qmlmethod void MapPolygon::addCoordinate(coordinate) - Adds a \a coordinate to the path. + Adds the specified \a coordinate to the path. \sa removeCoordinate, path */ diff --git a/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp b/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp index 63146fbc..4da98516 100644 --- a/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp +++ b/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp @@ -849,7 +849,7 @@ int QDeclarativePolylineMapItem::pathLength() const /*! \qmlmethod void MapPolyline::addCoordinate(coordinate) - Adds a \a coordinate to the end of the path. + Adds the specified \a coordinate to the end of the path. \sa insertCoordinate, removeCoordinate, path */ diff --git a/src/location/doc/qtlocation.qdocconf b/src/location/doc/qtlocation.qdocconf index 0ffbe4d6..e5cf230b 100644 --- a/src/location/doc/qtlocation.qdocconf +++ b/src/location/doc/qtlocation.qdocconf @@ -33,7 +33,7 @@ qhp.QtLocation.subprojects.examples.selectors = fake:example tagfile = ../../../doc/qtlocation/qtlocation.tags -depends += qtcore qtdoc qtgui qtquick qtqml qtnetwork qtpositioning qtquickcontrols qtlinguist qtxmlpatterns +depends += qtcore qtdoc qtgui qtquick qtqml qtnetwork qtpositioning qtquickcontrols qtlinguist headerdirs += .. \ ../../imports/location diff --git a/src/positioning/doc/qtpositioning.qdocconf b/src/positioning/doc/qtpositioning.qdocconf index 41a06c49..968f9b31 100644 --- a/src/positioning/doc/qtpositioning.qdocconf +++ b/src/positioning/doc/qtpositioning.qdocconf @@ -33,7 +33,7 @@ qhp.QtPositioning.subprojects.examples.selectors = fake:example tagfile = ../../../doc/qtpositioning/qtpositioning.tags -depends += qtcore qtdoc qtquick qtqml qtnetwork qtlocation +depends += qtcore qtdoc qtquick qtqml qtnetwork qtlocation qtxmlpatterns headerdirs += .. \ ../../imports/positioning \ diff --git a/src/positioning/qgeolocation.cpp b/src/positioning/qgeolocation.cpp index dd34112f..7d826e84 100644 --- a/src/positioning/qgeolocation.cpp +++ b/src/positioning/qgeolocation.cpp @@ -206,7 +206,8 @@ QVariantMap QGeoLocation::extendedAttributes() const } /*! - Sets the extended attributes of the location. + Sets the extended attributes of the location with the + parameters specified in \a data. \since 5.13 */ diff --git a/src/positioning/qgeopolygon.cpp b/src/positioning/qgeopolygon.cpp index 4e902be5..04e09095 100644 --- a/src/positioning/qgeopolygon.cpp +++ b/src/positioning/qgeopolygon.cpp @@ -117,7 +117,8 @@ QGeoPolygon::QGeoPolygon() } /*! - Constructs a new geo \a polygon from a list of coordinates. + Constructs a new geo \a polygon from the coordinates specified + in \a path. */ QGeoPolygon::QGeoPolygon(const QList &path) : QGeoShape(new QGeoPolygonPrivate(path)) @@ -178,7 +179,7 @@ bool QGeoPolygon::operator!=(const QGeoPolygon &other) const } /*! - Sets the \a polygon's boundary from a list of coordinates. + Sets the \a path for the polygon. */ void QGeoPolygon::setPath(const QList &path) { @@ -196,7 +197,9 @@ const QList &QGeoPolygon::path() const } /*! - Sets all the elements of the polygon's perimeter. + Sets all the elements of the polygon's perimeter + based on a list of coordinates (\a path). +. \since QtPositioning 5.12 */ @@ -355,7 +358,8 @@ QString QGeoPolygon::toString() const } /*! - Sets the \a path for a hole inside the polygon. The hole is a QVariant containing a QList. + Sets the \a holePath for a hole inside the polygon. The hole is a + QVariant containing a QList. \since 5.12 */ @@ -375,7 +379,7 @@ void QGeoPolygon::addHole(const QVariant &holePath) } /*! - Overloaded method. Sets the \a path for a hole inside the polygon. The hole is a QList. + Overloaded method. Sets the \a holePath for a hole inside the polygon. The hole is a QList. \since 5.12 */ @@ -386,7 +390,8 @@ void QGeoPolygon::addHole(const QList &holePath) } /*! - Returns a QVariant containing a QVariant containing a QList which represents the hole at index. + Returns a QVariant containing a QVariant containing a QList + which represents the hole at \a index. \since 5.12 */ diff --git a/src/positioningquick/qdeclarativegeoaddress.cpp b/src/positioningquick/qdeclarativegeoaddress.cpp index 470a4c12..14403581 100644 --- a/src/positioningquick/qdeclarativegeoaddress.cpp +++ b/src/positioningquick/qdeclarativegeoaddress.cpp @@ -43,7 +43,6 @@ QT_BEGIN_NAMESPACE /*! \qmltype Address - \instantiates QDeclarativeGeoAddress \inqmlmodule QtPositioning \since 5.2 diff --git a/src/positioningquick/qdeclarativegeolocation.cpp b/src/positioningquick/qdeclarativegeolocation.cpp index c06fcff2..3ad8854a 100644 --- a/src/positioningquick/qdeclarativegeolocation.cpp +++ b/src/positioningquick/qdeclarativegeolocation.cpp @@ -43,7 +43,6 @@ QT_USE_NAMESPACE /*! \qmltype Location - \instantiates QDeclarativeGeoLocation \inqmlmodule QtPositioning \since 5.2 diff --git a/src/positioningquick/qquickgeocoordinateanimation.cpp b/src/positioningquick/qquickgeocoordinateanimation.cpp index b00f187d..df467dd0 100644 --- a/src/positioningquick/qquickgeocoordinateanimation.cpp +++ b/src/positioningquick/qquickgeocoordinateanimation.cpp @@ -48,7 +48,6 @@ QT_BEGIN_NAMESPACE /*! \qmltype CoordinateAnimation - \instantiates QQuickGeoCoordinateAnimation \inherits PropertyAnimation \inqmlmodule QtPositioning \since 5.3 -- cgit v1.2.1