diff options
author | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2022-11-25 17:13:21 +0100 |
---|---|---|
committer | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2022-11-28 11:11:04 +0100 |
commit | c59ffd95ad36b8307d1fa6ab97973781f7f23a69 (patch) | |
tree | e93d5a8b1ec59dc443fb54054cb2757b249f9737 | |
parent | 33e191469ddbe8fd20373512879baac373efa90a (diff) | |
download | qtlocation-c59ffd95ad36b8307d1fa6ab97973781f7f23a69.tar.gz |
Documentation fixes
Correct spelling of and links to QML value types and to properties of
value types. Remove some documentation and snippets that are mostly
outdated, and links to specific plugin providers.
Silence some warnings.
Task-number: QTBUG-96795
Change-Id: Ifba3ae8144e0d949f1c72a4ea230e7f84fa28bd4
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
30 files changed, 100 insertions, 250 deletions
diff --git a/examples/location/places/doc/src/places.qdoc b/examples/location/places/doc/src/places.qdoc index b3c18313..d442f2b1 100644 --- a/examples/location/places/doc/src/places.qdoc +++ b/examples/location/places/doc/src/places.qdoc @@ -51,9 +51,9 @@ desired category. The place search query will be for places that are near the current location shown on the map. - For some plugins like \l {Qt Location HERE Plugin} the search box provides search term - suggestions when three or more characters are entered. Selecting one of the suggestions will - cause a place search to be performed with the selected search text. + For some plugins, the search box provides search term suggestions when three or more characters + are entered. Selecting one of the suggestions will cause a place search to be performed with + the selected search text. Clicking on a search result will display details about the place. If a places has rich content (editorials, reviews and images), these can be accessed by the buttons on the details page. diff --git a/examples/location/places_list/doc/src/places_list.qdoc b/examples/location/places_list/doc/src/places_list.qdoc index bc19d561..b66d8e44 100644 --- a/examples/location/places_list/doc/src/places_list.qdoc +++ b/examples/location/places_list/doc/src/places_list.qdoc @@ -50,9 +50,8 @@ from where places are sourced from. Depending on the type of the plugin, some mandatory parameters may be need to be filled in. The most likely type of PluginParameter are some form of service access token which are documented - in the service plugin. As an example see the \l - {Mandatory Parameters} {HERE Plugin} documentation. In this snippet the \c osm - plugin is used which does not require any further parameter: + in the service plugin. In this snippet the \c osm plugin is used which does + not require any further parameter: \snippet places_list/places_list.qml Initialize Plugin diff --git a/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp b/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp index 5ad1df4e..6a622a72 100644 --- a/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp +++ b/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp @@ -106,8 +106,8 @@ static QList<QGeoCoordinate> waypointCoordinates(const QList<QDeclarativeGeoWayp Otherwise, the \l{update} method may be used. By default, autoUpdate is disabled. - The data stored and returned in the RouteModel consists of \l Route objects, - as a list with the role name "routeData". See the documentation for \l Route + The data stored and returned in the RouteModel consists of \l route objects, + as a list with the role name "routeData". See the documentation for \l route for further details on its structure and contents. \section2 Example Usage @@ -1493,9 +1493,6 @@ void QDeclarativeGeoRouteQuery::doCoordinateChanged() A Waypoint is a type that allows to specify properties of a waypoint in a \l RouteQuery, such as the waypoint coordinate, or the angle of approach to the waypoint. - Additional information that are backend-specific can be specified by nesting \l MapParameter - elements. - Changing properties of the waypoint or of its nested MapParameteters will cause the containing \l RouteQuery to emit the queryDetailsChanged signal. diff --git a/src/location/declarativemaps/qdeclarativegeoserviceprovider.cpp b/src/location/declarativemaps/qdeclarativegeoserviceprovider.cpp index 27c32166..cc2ec2bb 100644 --- a/src/location/declarativemaps/qdeclarativegeoserviceprovider.cpp +++ b/src/location/declarativemaps/qdeclarativegeoserviceprovider.cpp @@ -860,33 +860,17 @@ bool QDeclarativeGeoServiceProviderRequirements::operator == (const QDeclarative \ingroup qml-QtLocation5-common \since QtLocation 5.5 - \brief The PluginParameter type describes a parameter for a plugin, either - geo service \l Plugin, or \l{Qt Positioning plugins}{position Plugin}. + \brief The PluginParameter type describes a parameter for a plugin. The PluginParameter object is used to provide a parameter of some kind to a plugin. Typically these parameters contain details like an application token for access to a service, or a proxy server to use for network access, or the serial port to which a serial GPS receiver is connected. - To set such a parameter, declare a PluginParameter inside an element that accepts - plugin parameters as configuration objects, such as a \l Plugin object, or a - \l PositionSource object, and give it \l{name} and \l{value} properties. A list of valid - parameter names for each plugin is available from the - \l {Qt Location#Plugin References and Parameters}{plugin reference pages} for geoservice plugins, - and \l {Qt Positioning plugins#Default plugins} for position plugins. - - \section2 Example Usage - - The following example shows an instantiation of the \l {Qt Location HERE Plugin}{HERE} plugin - with a mapping API \e app_id and \e token pair specific to the application. - - \code - Plugin { - name: "here" - PluginParameter { name: "here.app_id"; value: "EXAMPLE_API_ID" } - PluginParameter { name: "here.token"; value: "EXAMPLE_TOKEN_123" } - } - \endcode + To set such a parameter, declare a PluginParameter inside an \l Plugin object + and give it \l{name} and \l{value} properties. A list of valid parameter names + is available from the + \l {Qt Location#Plugin References and Parameters}{plugin reference pages}. */ /*! diff --git a/src/location/declarativeplaces/qdeclarativecategory.cpp b/src/location/declarativeplaces/qdeclarativecategory.cpp index a8bcf10c..0f67fac7 100644 --- a/src/location/declarativeplaces/qdeclarativecategory.cpp +++ b/src/location/declarativeplaces/qdeclarativecategory.cpp @@ -148,11 +148,7 @@ void QDeclarativeCategory::pluginReady() /*! - \qmlproperty QPlaceCategory Category::category - \keyword Category::category - - For details on how to use this property to interface between C++ and QML see - "\l {Category - QPlaceCategory} {Interfaces between C++ and QML Code}". + \internal */ void QDeclarativeCategory::setCategory(const QPlaceCategory &category) { diff --git a/src/location/declarativeplaces/qdeclarativecontactdetails.cpp b/src/location/declarativeplaces/qdeclarativecontactdetails.cpp index 20114aa1..e45cedba 100644 --- a/src/location/declarativeplaces/qdeclarativecontactdetails.cpp +++ b/src/location/declarativeplaces/qdeclarativecontactdetails.cpp @@ -53,10 +53,9 @@ QT_BEGIN_NAMESPACE \brief The ContactDetails type holds contact details for a \l Place. - The ContactDetails type is a map of \l {QtLocation::ContactDetail}{ContactDetail} objects. + The ContactDetails type is a map of \l contactDetail objects. To access contact details in the map use the \l keys() method to get the list of keys stored in - the map and then use the \c {[]} operator to access the - \l {QtLocation::ContactDetail}{ContactDetail} items. + the map and then use the \c {[]} operator to access the \l contactDetail items. The following keys are defined in the API. \l Plugin implementations are free to define additional keys. @@ -74,7 +73,7 @@ QT_BEGIN_NAMESPACE \section1 Examples - The following example shows how to access all \l {QtLocation::ContactDetail}{ContactDetails} + The following example shows how to access all \l {contactDetail}{contact details} and print them to the console: \snippet declarative/maps.qml QtLocation import diff --git a/src/location/declarativeplaces/qdeclarativeplace.cpp b/src/location/declarativeplaces/qdeclarativeplace.cpp index f4b14f9c..dd7ab785 100644 --- a/src/location/declarativeplaces/qdeclarativeplace.cpp +++ b/src/location/declarativeplaces/qdeclarativeplace.cpp @@ -302,10 +302,7 @@ QDeclarativePlaceEditorialModel *QDeclarativePlace::editorialModel() } /*! - \qmlproperty QPlace Place::place - - For details on how to use this property to interface between C++ and QML see - "\l {Place - QPlace} {Interfaces between C++ and QML Code}". + \internal */ void QDeclarativePlace::setPlace(const QPlace &src) { @@ -828,7 +825,7 @@ QQmlPropertyMap *QDeclarativePlace::extendedAttributes() const \qmlproperty ContactDetails Place::contactDetails This property holds the contact information for this place, for example a phone number or - a website URL. This property is a map of \l ContactDetail objects. + a website URL. This property is a map of \l contactDetail objects. */ QDeclarativeContactDetails *QDeclarativePlace::contactDetails() const { diff --git a/src/location/declarativeplaces/qdeclarativeplacecontentmodel.cpp b/src/location/declarativeplaces/qdeclarativeplacecontentmodel.cpp index bd2d182a..245a2119 100644 --- a/src/location/declarativeplaces/qdeclarativeplacecontentmodel.cpp +++ b/src/location/declarativeplaces/qdeclarativeplacecontentmodel.cpp @@ -51,14 +51,13 @@ QT_BEGIN_NAMESPACE /*! - \qmltype ContentModel - \instantiates QDeclarativePlaceContentModel + \qmltype EditorialModel \inqmlmodule QtLocation \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-models \since QtLocation 5.5 - \brief The EditorialModel type provides a model of place content. + \brief The EditorialModel type provides a model of place editorials. The EditorialModel is a read-only model used to fetch editorials related to a \l Place. Binding a \l Place via \l EditorialModel::place initiates an initial fetch of editorials. @@ -66,8 +65,9 @@ QT_BEGIN_NAMESPACE with a View such as a \l ListView. When the View reaches the last of the editorials currently in the model, a fetch is performed to retrieve more if they are available. The View is automatically updated as the editorials are received. The number of - editorials which are fetched at a time is specified by the \l batchSize property. - The total number of editorials available can be accessed via the \l totalCount property. + editorials which are fetched at a time is specified by the + \l {EditorialModel::}{batchSize} property. The total number of editorials available can be + accessed via the \l {EditorialModel::}{totalCount} property. The model returns data for the following roles: @@ -78,11 +78,11 @@ QT_BEGIN_NAMESPACE \li Description \row \li supplier - \li \l Supplier + \li \l supplier \li The supplier of the content. \row \li user - \li \l {QtLocation::User}{User} + \li \l user \li The user who contributed the content. \row \li attribution @@ -169,6 +169,29 @@ QT_BEGIN_NAMESPACE This property holds the total number of editorial items for the place. */ +/*! + \qmltype ImageModel + \inqmlmodule QtLocation + \ingroup qml-QtLocation5-places + \ingroup qml-QtLocation5-places-models + \since QtLocation 5.5 + + \brief The ImageModel type provides a model of place images. + + \sa EditorialModel +*/ + +/*! + \qmltype ReviewModel + \inqmlmodule QtLocation + \ingroup qml-QtLocation5-places + \ingroup qml-QtLocation5-places-models + \since QtLocation 5.5 + + \brief The ReviewModel type provides a model of place reviews. + + \sa EditorialModel +*/ QDeclarativePlaceContentModel::QDeclarativePlaceContentModel(QPlaceContent::Type type, QObject *parent) diff --git a/src/location/doc/qtlocation.qdocconf b/src/location/doc/qtlocation.qdocconf index c03d4000..8840e3f5 100644 --- a/src/location/doc/qtlocation.qdocconf +++ b/src/location/doc/qtlocation.qdocconf @@ -32,17 +32,12 @@ tagfile = ../../../doc/qtlocation/qtlocation.tags depends += qtcore qtdoc qtgui qtquick qtqml qtnetwork qtpositioning qtlinguist -headerdirs += .. \ - ../../imports/location +headerdirs += .. -sourcedirs += .. \ - ../../imports/location \ - ../../plugins/geoservices/nokia +sourcedirs += .. examplesinstallpath = location -manifestmeta.highlighted.names = "QtLocation/Map Viewer (QML)" - exampledirs += ../../../examples/location \ snippets/ diff --git a/src/location/doc/src/cpp-qml.qdoc b/src/location/doc/src/cpp-qml.qdoc deleted file mode 100644 index b8a49fa5..00000000 --- a/src/location/doc/src/cpp-qml.qdoc +++ /dev/null @@ -1,115 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2017 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! -\page location-cpp-qml.html -\title Interfaces between C++ and QML Code in Qt Location - -\brief Some of the location QML types providing interfaces to access and modify properties in C++. - -\section2 Category - QPlaceCategory -The \l {Category::category} {Category.category} property is used to provide an interface between C++ and QML code. First a pointer to a -Category object must be obtained from C++, then use the \l {QObject::property()}{property()} and -\l {QObject::setProperty()}{setProperty()} functions to get and set the \c category property. -The following gets the QPlaceCategory representing this object from C++: -\snippet cpp/cppqml.cpp Category get -The following sets the properties of this object based on a QPlaceCategory object from C++: -\snippet cpp/cppqml.cpp Category set - - -\section2 ContactDetail - QDeclarativeContactDetail -The \l {ContactDetail::contactDetail} {ContactDetail.contactDetail} property is used to provide an interface between C++ and QML code. First a pointer to a ContactDetail object must be obtained from C++, then use the -\l {QObject::property()}{property()} and \l {QObject::setProperty()}{setProperty()} functions -to get and set the \c contactDetail property. -The following gets the QPlaceContactDetail representing this object from C++: -\snippet cpp/cppqml.cpp ContactDetail get -The following sets the properties of this object based on a QPlaceContactDetail object from -C++: -\snippet cpp/cppqml.cpp ContactDetail set - - -\section2 Place - QPlace -The \l {Place::place} {Place.place} property is used to provide an interface between C++ and QML code. First a pointer to a Place object must be obtained from C++, then use the -\l {QObject::property()}{property()} and \l {QObject::setProperty()}{setProperty()} functions -to get and set the \c place property. -The following gets the QPlace representing this object from C++: -\snippet cpp/cppqml.cpp Place get -The following sets the properties of this object based on a QPlace object from C++: -\snippet cpp/cppqml.cpp Place set - - - -\section2 PlaceAttribute - QPlaceAttribute -The \l {PlaceAttribute::attribute} {PlaceAttribute.attribute} property is used to provide an interface between C++ and QML code. First a pointer to a -PlaceAttribute object must be obtained from C++, then use the -\l {QObject::property()}{property()} and \l {QObject::setProperty()}{setProperty()} functions -to get and set the \c attribute property. -The following gets the QPlaceAttribute representing this object from C++: -\snippet cpp/cppqml.cpp PlaceAttribute get -The following sets the properties of this object based on a QPlaceAttribute object from C++: -\snippet cpp/cppqml.cpp PlaceAttribute set - - -\section2 Icon - QPlaceIcon -The \l {Icon::icon} {Icon.icon} property is used to provide an interface between C++ and QML code. First a pointer to a Icon object must be obtained from C++, then use the \l {QObject::property()}{property()} and -\l {QObject::setProperty()}{setProperty()} functions to get and set the \c icon property. -The following gets the QPlaceIcon representing this object from C++: -\snippet cpp/cppqml.cpp Icon get -The following sets the properties of this object based on a QPlaceIcon object from C++: -\snippet cpp/cppqml.cpp Icon set - - -\section2 User - QPlaceUser -The \l {User::user} {User.user} property is used to provide an interface between C++ and QML code. First a pointer to a -User object must be obtained from C++, then use the \l {QObject::property()}{property()} and -\l {QObject::setProperty()}{setProperty()} functions to get and set the \c user property. -The following gets the QPlaceUser representing this object from C++: -\snippet cpp/cppqml.cpp User get -The following sets the properties of this object based on a QPlaceUser object from C++: -\snippet cpp/cppqml.cpp User set - - -\section2 Ratings - QPlaceRatings -The \l {Ratings::ratings} {Ratings.ratings} property is used to provide an interface between C++ and QML code. First a pointer to a -Ratings object must be obtained from C++, then use the \l {QObject::property()}{property()} and -\l {QObject::setProperty()}{setProperty()} functions to get and set the \c ratings property. -The following gets the QPlaceRating representing this object from C++: -\snippet cpp/cppqml.cpp Ratings get -The following sets the properties of this object based on a QPlaceRatings object from C++: -\snippet cpp/cppqml.cpp Ratings set - - -\section2 Supplier - QPlaceSupplier -The \l {Supplier::supplier} {Supplier.supplier} property is used to provide an interface between C++ and QML code. First a pointer to a -Supplier object must be obtained from C++, then use the \l {QObject::property()}{property()} and -\l {QObject::setProperty()}{setProperty()} functions to get and set the \c supplier property. -The following gets the QPlaceSupplier representing this object from C++: -\snippet cpp/cppqml.cpp Supplier get -The following sets the properties of this object based on a QPlaceSupplier object from C++: -\snippet cpp/cppqml.cpp Supplier set - -*/ diff --git a/src/location/doc/src/maps.qdoc b/src/location/doc/src/maps.qdoc index f633145d..3d5ee946 100644 --- a/src/location/doc/src/maps.qdoc +++ b/src/location/doc/src/maps.qdoc @@ -166,7 +166,7 @@ between the segments. \b{Key Types} \table \row - \li \l{QtLocation::Route}{Route} + \li \l route \li The entire path to be navigated. \row \li \l{QtLocation::routeSegment}{routeSegment} diff --git a/src/location/doc/src/places.qdoc b/src/location/doc/src/places.qdoc index 9c01fba7..68d04950 100644 --- a/src/location/doc/src/places.qdoc +++ b/src/location/doc/src/places.qdoc @@ -52,9 +52,6 @@ \snippet places_list/places_list.qml Initialize Plugin - \note The HERE plugin must be supplied with some mandatory parameters as outlined - in the \l {Mandatory Parameters} {HERE Plugin} documentation. - \section2 Models, Views and Delegates The QML Places API is built around the notion of models, views and delegates. diff --git a/src/location/doc/src/plugins/esri.qdoc b/src/location/doc/src/plugins/esri.qdoc index dc28c906..11bb0395 100644 --- a/src/location/doc/src/plugins/esri.qdoc +++ b/src/location/doc/src/plugins/esri.qdoc @@ -26,6 +26,7 @@ ****************************************************************************/ /*! +\internal \page location-plugin-esri.html \title Qt Location Esri Plugin \ingroup QtLocation-plugins diff --git a/src/location/doc/src/plugins/mapboxgl.qdoc b/src/location/doc/src/plugins/mapboxgl.qdoc index 3bfd8b97..dfedb104 100644 --- a/src/location/doc/src/plugins/mapboxgl.qdoc +++ b/src/location/doc/src/plugins/mapboxgl.qdoc @@ -28,6 +28,7 @@ ****************************************************************************/ /*! +\internal \page location-plugin-mapboxgl.html \title Qt Location Mapbox GL Plugin \ingroup QtLocation-plugins diff --git a/src/location/doc/src/plugins/nokia.qdoc b/src/location/doc/src/plugins/nokia.qdoc index 79bd728f..edf7766b 100644 --- a/src/location/doc/src/plugins/nokia.qdoc +++ b/src/location/doc/src/plugins/nokia.qdoc @@ -26,6 +26,7 @@ ****************************************************************************/ /*! +\internal \page location-plugin-here.html \title Qt Location HERE Plugin \ingroup QtLocation-plugins diff --git a/src/location/doc/src/qt6-changes.qdoc b/src/location/doc/src/qt6-changes.qdoc index 2179ba41..ece5e208 100644 --- a/src/location/doc/src/qt6-changes.qdoc +++ b/src/location/doc/src/qt6-changes.qdoc @@ -74,9 +74,9 @@ \list \li The former QML element types \c PlaceUser, \c PlaceRatings, \c PlaceAttribute, \c PlaceIcon, \c PlaceSupplier, and - \c PlaceContactDetail are now value types \l placeUser, - \l placeRatings, \l placeAttribute, \l placeIcon, - \l placeSupplier, and \l placeContactDetail. + \c PlaceContactDetail are now value types \l user, + \l ratings, \l placeAttribute, \l icon, + \l supplier, and \l contactDetail. They can no longer be instantiated as items from QML, and their properties can not be bound to. \endlist diff --git a/src/location/doc/src/qtlocation-examples.qdoc b/src/location/doc/src/qtlocation-examples.qdoc index 02938c0e..79b6209e 100644 --- a/src/location/doc/src/qtlocation-examples.qdoc +++ b/src/location/doc/src/qtlocation-examples.qdoc @@ -39,7 +39,6 @@ These examples can work with any of the available geo services plugins. However, some plugins may require additional \l {QtLocation::PluginParameter}{plugin parameters} in order to function correctly. The default plugin used by these examples is \l {Qt Location Open Street Map Plugin}, which does not - require any parameters. The \l {Qt Location Mapbox GL Plugin} was used for the screenshots and can also - be used without any parameters, for development purposes, on the platforms it is available. + require any parameters. */ diff --git a/src/location/doc/src/qtlocation-qml.qdoc b/src/location/doc/src/qtlocation-qml.qdoc index 05d5d763..cba13fae 100644 --- a/src/location/doc/src/qtlocation-qml.qdoc +++ b/src/location/doc/src/qtlocation-qml.qdoc @@ -41,7 +41,7 @@ paths, roads, or forms of transport, enabling navigation optimization and assistance. - To perform navigation we need \l {Route}s from start to destination. + To perform navigation we need \l {route}s from start to destination. These routes are made up of segments, where each \l {QtLocation::} {routeSegment} can be considered a navigation subtask; for example, "drive 100 meters", or "turn left". The beginning and end of each @@ -68,7 +68,7 @@ \l [QML] {Place} objects to be displayed, panned, zoomed, and so on. - \li The \l [QML] Route is be determined by a \e plugin, with each + \li The \l [QML] route is be determined by a \e plugin, with each \l [QML] routeSegment holding the navigation instructions, guided by the continuously updated current \l [QML] Location. diff --git a/src/location/maps/qgeocameracapabilities.cpp b/src/location/maps/qgeocameracapabilities.cpp index 95c68e98..3091bb72 100644 --- a/src/location/maps/qgeocameracapabilities.cpp +++ b/src/location/maps/qgeocameracapabilities.cpp @@ -109,12 +109,12 @@ bool QGeoCameraCapabilitiesPrivate::operator==(const QGeoCameraCapabilitiesPriva */ /*! - \qmltype CameraCapabilities + \qmlvaluetype cameraCapabilities \inqmlmodule QtLocation \ingroup qml-QtLocation5-maps \since QtLocation 5.10 - \brief The CameraCapabilities type holds information about the camera capabilities for a specific map type. + \brief The cameraCapabilities type holds information about the camera capabilities for a specific map type. This includes the map minimum and maximum zoom level, minimum and maximum tilt angle and minimum and maximum field of view. @@ -178,7 +178,7 @@ bool QGeoCameraCapabilities::isValid() const } /*! - \qmlproperty qreal CameraCapabilities::minimumZoomLevel + \qmlproperty qreal cameraCapabilities::minimumZoomLevel This read-only property holds the minimum available zoom level with this map type. */ @@ -209,7 +209,7 @@ double QGeoCameraCapabilities::minimumZoomLevelAt256() const } /*! - \qmlproperty qreal CameraCapabilities::maximumZoomLevel + \qmlproperty qreal cameraCapabilities::maximumZoomLevel This read-only property holds the maximum available zoom level with this map type. */ @@ -297,7 +297,7 @@ bool QGeoCameraCapabilities::supportsTilting() const } /*! - \qmlproperty qreal CameraCapabilities::minimumTilt + \qmlproperty qreal cameraCapabilities::minimumTilt This read-only property holds the minimum available tilt with this map type. */ @@ -321,7 +321,7 @@ double QGeoCameraCapabilities::minimumTilt() const } /*! - \qmlproperty qreal CameraCapabilities::maximumTilt + \qmlproperty qreal cameraCapabilities::maximumTilt This read-only property holds the maximum available tilt with this map type. */ @@ -345,7 +345,7 @@ double QGeoCameraCapabilities::maximumTilt() const } /*! - \qmlproperty qreal CameraCapabilities::minimumFieldOfView + \qmlproperty qreal cameraCapabilities::minimumFieldOfView This read-only property holds the minimum available field of view with this map type. */ @@ -370,7 +370,7 @@ double QGeoCameraCapabilities::minimumFieldOfView() const } /*! - \qmlproperty qreal CameraCapabilities::maximumFieldOfView + \qmlproperty qreal cameraCapabilities::maximumFieldOfView This read-only property holds the maximum available field of view with this map type. */ diff --git a/src/location/maps/qgeoroute.cpp b/src/location/maps/qgeoroute.cpp index 0144edb9..0159332e 100644 --- a/src/location/maps/qgeoroute.cpp +++ b/src/location/maps/qgeoroute.cpp @@ -75,7 +75,6 @@ QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QGeoRoutePrivate) /*! \qmlvaluetype route - \instantiates QDeclarativeGeoRoute \inqmlmodule QtLocation \ingroup qml-QtLocation5-routing \since QtLocation 5.5 @@ -186,9 +185,10 @@ QString QGeoRoute::routeId() const } /*! + \internal \property QGeoRoute::request \brief the route request which describes the criteria used in the - calculcation of this route + calculation of this route */ void QGeoRoute::setRequest(const QGeoRouteRequest &request) { @@ -290,7 +290,7 @@ QList<QGeoRouteSegment> QGeoRoute::segments() const */ /*! - \property QGeoRoute::traveltime + \property QGeoRoute::travelTime \brief the estimated amount of time it will take to traverse this route, in seconds */ @@ -391,7 +391,6 @@ QList<QGeoCoordinate> QGeoRoute::path() const \property QGeoRoute::routeLegs \brief the route \a legs for a multi-waypoint route - \sa QGeoRouteLeg \since 5.12 */ void QGeoRoute::setRouteLegs(const QList<QGeoRoute> &legs) diff --git a/src/location/maps/qgeoserviceprovider.cpp b/src/location/maps/qgeoserviceprovider.cpp index 17ee11ce..989bcf9d 100644 --- a/src/location/maps/qgeoserviceprovider.cpp +++ b/src/location/maps/qgeoserviceprovider.cpp @@ -96,20 +96,9 @@ Q_GLOBAL_STATIC_WITH_ARGS(QFactoryLoader, loader, Subclasses of QGeoServiceProvider guarantee that the different services that they provide are interoperable. - At this point there are two GeoServices plugins packaged with Qt. They are - accessible using their provider names: - - \list - \li "mapbox" -> \l {Qt Location Mapbox Plugin}{Mapbox service} - \li "here" -> \l {Qt Location HERE Plugin}{HERE Services} - \li "osm" -> \l {Qt Location Open Street Map Plugin}{OpenStreetMap Services} - \li "esri" -> \l {Qt Location Esri Plugin}{ESRI Services} - \endlist - Each service provider must follow a naming convention for their service specific parameter names/keys. They use the provider name as prefix for all their - parameter names. For example, the \l {Qt Location HERE Plugin}{HERE} service provider - requires the \c here.app_id parameter. When a provider is loaded only those parameters are + parameter names. When a provider is loaded only those parameters are passed on whose parameter names start with the provider name. This avoids the sharing sensitive parameters such as confidential \c token or \c app_id parameters with other plugins. diff --git a/src/location/maps/qgeoserviceproviderfactory.cpp b/src/location/maps/qgeoserviceproviderfactory.cpp index d58773bd..984215aa 100644 --- a/src/location/maps/qgeoserviceproviderfactory.cpp +++ b/src/location/maps/qgeoserviceproviderfactory.cpp @@ -173,7 +173,7 @@ QGeoServiceProviderFactory::createPlaceManagerEngine(const QVariantMap ¶mete } /*! - Notify the plugin when the qml engine is ready. In this moment the plugins can use it + Notify the plugin when the qml \a engine is ready. In this moment the plugins can use it to register Image Providers. The default implementation does nothing. diff --git a/src/location/places/qplaceattribute.cpp b/src/location/places/qplaceattribute.cpp index 3c4aabda..6aea68eb 100644 --- a/src/location/places/qplaceattribute.cpp +++ b/src/location/places/qplaceattribute.cpp @@ -199,9 +199,10 @@ bool QPlaceAttributePrivate::isEmpty() const A place attribute stores an additional piece of information about a \l Place that is not otherwise exposed through the \l Place type. A placeAttribute is a textual piece of data, - accessible through the \l text property, and a \l label. Both the \l text and \l label - properties are intended to be displayed to the user. placeAttributes are stored in an - \l ExtendedAttributes map with a unique key. + accessible through the \l {placeAttribute::}{text} property, and a \l {placeAttribute::}{label}. + Both the l {placeAttribute::}{text} and \l {placeAttribute::}{label} properties are intended + to be displayed to the user. placeAttributes are stored in an \l ExtendedAttributes map with + a unique key. The following example shows how to display all attributes in a list: diff --git a/src/location/places/qplacecontactdetail.cpp b/src/location/places/qplacecontactdetail.cpp index 63425527..940b330b 100644 --- a/src/location/places/qplacecontactdetail.cpp +++ b/src/location/places/qplacecontactdetail.cpp @@ -94,8 +94,9 @@ types if necessary. address. The contactDetail provides a single detail on how one could contact a \l Place. The - contactDetail consists of a \l label, which is a localized string describing the contact - method, and a \l value representing the actual contact detail. + contactDetail consists of a \l {contactDetail::}{label}, which is a localized string + describing the contact method, and a \l {contactDetail::}{value} representing the actual + contact detail. \section1 Examples @@ -186,7 +187,7 @@ bool QPlaceContactDetail::isEqual(const QPlaceContactDetail &other) const noexce */ /*! - \qmlproperty string QtLocation::ContactDetail::label + \qmlproperty string QtLocation::contactDetail::label This property holds a label describing the contact detail. @@ -214,7 +215,7 @@ void QPlaceContactDetail::setLabel(const QString &label) } /*! - \qmlproperty string QtLocation::ContactDetail::value + \qmlproperty string QtLocation::contactDetail::value This property holds the value of the contact detail which may be a phone number, an email address, a website url and so on. diff --git a/src/location/places/qplacecontent.cpp b/src/location/places/qplacecontent.cpp index 512fcabf..e0826316 100644 --- a/src/location/places/qplacecontent.cpp +++ b/src/location/places/qplacecontent.cpp @@ -66,33 +66,24 @@ QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QPlaceContentPrivate) \ingroup QtLocation-places-data \since 5.6 - \brief The QPlaceContent class serves as the base class for rich content types. + \brief The QPlaceContent class holds content about places. - Rich content such as \l {QPlaceImage}{images}, \l {QPlaceReview}{reviews} - and \l {QPlaceEditorial}{editorials} inherit - from the QPlaceContent class which contains common properties such as - an attribution string and content contributor, which may take the form of a - \l {QPlaceUser}{user} and/or \l {QPlaceSupplier}{supplier}. It is possible that - a user from a supplier is contributing content, hence both fields could - be filled in simultaneously. + A QPlaceContent holds rich content such as images, reviews, or editorials, as well + as attributes about the content such as the user or supplier of the content. Content + objects might hold multiple data, e.g. an item holding a review typically includes + the user that wrote the review. Use type() to inspect the type of content a + QPlaceContent object represents, and dataTags() to see which data is held. Use value() + to get the individual data as a QVariant. \b {Note:} Some providers may \e {require} that the attribution string be displayed to the user whenever a piece of content is viewed. - Conversion between QPlaceContent and it's subclasses can be easily performed without - casting. Due to the way it has been implemented, object slicing is not an issue, - the following code is valid: - \snippet places/requesthandler.h Content conversion - - The rich content of a place is typically made available as paginated items. The ability - to convert between QPlaceContent and it's subclasses means that code which handles - the mechanics of paging can be easily shared for each of the sub types. + The rich content of a place is typically made available as paginated items. At present the QPlaceContent class is not extensible by 3rd parties. Note: The Places API considers content objects to be 'retrieve-only' objects. Submission of content to a provider is not a supported use case. - \sa QPlaceImage, QPlaceReview, QPlaceEditorial */ /*! @@ -168,7 +159,7 @@ QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QPlaceContentPrivate) */ /*! - Constructs an default content object which has no type. + Constructs an content object for \a type. */ QPlaceContent::QPlaceContent(Type type) : d_ptr(new QPlaceContentPrivate(type)) diff --git a/src/location/places/qplaceratings.cpp b/src/location/places/qplaceratings.cpp index 81c342d5..6bea884c 100644 --- a/src/location/places/qplaceratings.cpp +++ b/src/location/places/qplaceratings.cpp @@ -76,18 +76,13 @@ bool QPlaceRatingsPrivate::isEmpty() const \inqmlmodule QtLocation \ingroup qml-QtLocation5-places \ingroup qml-QtLocation5-places-data - \since QtLocation 5.5 + \since QtLocation 6.5 \brief The ratings type holds place rating information. Rating information is used to describe how \e good a place is conceived to be. Typically this - information is visualized as a number of stars. The \l average property gives an aggregated - ratings value out of a possible maximum as given by the \l maximum property. - - \snippet declarative/places.qml QtQuick import - \snippet declarative/maps.qml QtLocation import - \codeline - \snippet declarative/places.qml ratings + information is visualized as a number of stars. The \l {ratings::}{average} property gives an aggregated + ratings value out of a possible maximum as given by the \l {ratings::maximum} property. */ /*! diff --git a/src/location/places/qplacesupplier.cpp b/src/location/places/qplacesupplier.cpp index fc9d8f87..f328f3bf 100644 --- a/src/location/places/qplacesupplier.cpp +++ b/src/location/places/qplacesupplier.cpp @@ -95,8 +95,6 @@ bool QPlaceSupplierPrivate::isEmpty() const Note: The Places API only supports suppliers as 'retrieve-only' objects. Submitting suppliers to a provider is not a supported use case. - \sa ImageModel, ReviewModel, EditorialModel - \section1 Example The following example shows how to create and display a supplier in QML: @@ -105,6 +103,8 @@ bool QPlaceSupplierPrivate::isEmpty() const \snippet declarative/maps.qml QtLocation import \codeline \snippet declarative/places.qml Supplier + + \sa ImageModel, ReviewModel, EditorialModel */ /*! diff --git a/src/location/places/qplaceuser.cpp b/src/location/places/qplaceuser.cpp index 6815e68f..eb2f3885 100644 --- a/src/location/places/qplaceuser.cpp +++ b/src/location/places/qplaceuser.cpp @@ -71,8 +71,6 @@ bool QPlaceUserPrivate::operator==(const QPlaceUserPrivate &other) const Each \l Place content item has an associated user who contributed the content. This type provides information about that user. - \sa ImageModel, ReviewModel, EditorialModel - \section1 Example The following example shows how to display information about the user who @@ -82,6 +80,8 @@ bool QPlaceUserPrivate::operator==(const QPlaceUserPrivate &other) const \snippet declarative/maps.qml QtLocation import \codeline \snippet declarative/places.qml EditorialModel + + \sa ImageModel, ReviewModel, EditorialModel */ /*! diff --git a/src/location/quickmapitems/qdeclarativegeomapitemview.cpp b/src/location/quickmapitems/qdeclarativegeomapitemview.cpp index 27527d35..931623c5 100644 --- a/src/location/quickmapitems/qdeclarativegeomapitemview.cpp +++ b/src/location/quickmapitems/qdeclarativegeomapitemview.cpp @@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE \section2 Example Usage This example demonstrates how to use the MapViewItem object to display - a \l{Route}{route} on a \l{Map}{map}: + a \l{route}{route} on a \l{Map}{map}: \snippet declarative/maps.qml QtQuick import \snippet declarative/maps.qml QtLocation import diff --git a/src/location/quickmapitems/qdeclarativeroutemapitem.cpp b/src/location/quickmapitems/qdeclarativeroutemapitem.cpp index b1d788ca..ea86e831 100644 --- a/src/location/quickmapitems/qdeclarativeroutemapitem.cpp +++ b/src/location/quickmapitems/qdeclarativeroutemapitem.cpp @@ -71,7 +71,7 @@ QT_BEGIN_NAMESPACE \section2 Example Usage - Here is how to draw a \l{Route}{route} on a \l{Map}{map}: + Here is how to draw a \l{route}{route} on a \l{Map}{map}: \snippet declarative/maps.qml QtQuick import \snippet declarative/maps.qml QtLocation import |