diff options
author | Aaron McCarthy <aaron.mccarthy@nokia.com> | 2011-10-25 12:59:22 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2011-10-25 05:01:07 +0200 |
commit | 06f46c6b69a4234b3449eac5ab44989546cb52c9 (patch) | |
tree | 709cd99b8ef43309f17dc95d13aab8882b39ec4c /src | |
parent | 53909f3cb2a02aca9f87b298b935845d9301d0d0 (diff) | |
download | qtlocation-06f46c6b69a4234b3449eac5ab44989546cb52c9.tar.gz |
Update structure of QtLocation documentation.
Separate out into sections for C++ and QML.
Mark all classes as "since QtLocation 5.0" as there has been
many API changes since Qt Mobility.
Change-Id: Ie71c5f7cb8341e76d41b9fefce4781979f3e898c
Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
Diffstat (limited to 'src')
83 files changed, 407 insertions, 352 deletions
diff --git a/src/imports/location/declarativeplaces/qdeclarativecategory.cpp b/src/imports/location/declarativeplaces/qdeclarativecategory.cpp index ce3da77a..3e234ed6 100644 --- a/src/imports/location/declarativeplaces/qdeclarativecategory.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativecategory.cpp @@ -50,13 +50,12 @@ QT_USE_NAMESPACE /*! - \qmlclass Category + \qmlclass Category QDeclarativeCategory + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-places + \since QtLocation 5.0 - \brief The Category element holds various positional data, such as \l - latitude and \l longitude and. - \inherits QObject - - \ingroup qml-places + \brief The Category element represents a categorical grouping of places. */ QDeclarativeCategory::QDeclarativeCategory(QObject* parent) diff --git a/src/imports/location/declarativeplaces/qdeclarativeplace.cpp b/src/imports/location/declarativeplaces/qdeclarativeplace.cpp index 4c4b8895..55712875 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplace.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplace.cpp @@ -54,15 +54,15 @@ QT_USE_NAMESPACE /*! - \qmlclass Place + \qmlclass Place QDeclarativePlace + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-places + \since QtLocation 5.0 \brief The Place element holds place data. - \inherits QObject Place cointains many properties holding data of the place like location, id, name etc. - - \ingroup qml-places */ QDeclarativePlace::QDeclarativePlace(QObject* parent) diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp index d2d334b4..7a4e1744 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp @@ -42,12 +42,23 @@ #include "qdeclarativeplaceattribute_p.h" /*! - \qmlclass PlaceAttribute + \qmlclass ExtendedAttributes QDeclarativePropertyMap + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-places + \since QtLocation 5.0 - \brief The PlaceAttribute element holds generic place attribute information. - \inherits QObject + \brief The ExtendedAttributes elements holds addition data about a Place. + + \sa PlaceAttribute +*/ - \ingroup qml-places +/*! + \qmlclass PlaceAttribute QDeclarativePlaceAttribute + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-places + \since QtLocation 5.0 + + \brief The PlaceAttribute element holds generic place attribute information. */ QDeclarativePlaceAttribute::QDeclarativePlaceAttribute(QObject *parent) : QObject(parent) diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp index b63ea30f..4d99ef22 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceeditorialmodel.cpp @@ -47,11 +47,12 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass PlaceEditorialModel QDeclarativePlaceEditorialModel + \qmlclass EditorialModel QDeclarativePlaceEditorialModel + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-places + \since QtLocation 5.0 \brief The PlaceEditorialModel element provides access to place editorials. - \ingroup qml-places - \since 5.0 The PlaceEditorialModel is a read-only model used to fetch editorials related to a Place. The model performs fetches incrementally. The number of editorials which are fetched at a time is diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceicon.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceicon.cpp index e2ff0c02..f9ae23bf 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceicon.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceicon.cpp @@ -49,13 +49,14 @@ QT_USE_NAMESPACE /*! - \qmlclass PlaceIcon + \qmlclass PlaceIcon QDeclarativePlaceIcon + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-places + \since QtLocation 5.0 \brief The PlaceIcon element holds icon related information, most prominently the icon's urls. - \inherits QObject - - \ingroup qml-places */ + QDeclarativePlaceIcon::QDeclarativePlaceIcon(QObject *parent) : QObject(parent), m_plugin(0) { diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp index b7f2fb73..98b22f7d 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceimagemodel.cpp @@ -48,13 +48,14 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass PlaceImageModel QDeclarativePlaceImage + \qmlclass ImageModel QDeclarativePlaceImageModel + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-places + \since QtLocation 5.0 - \brief The PlaceImageModel element provides access to place images. - \ingroup qml-places - \since 5.0 + \brief The ImageModel element provides access to place images. - The PlaceImageModel is a read-only model used to fetch images related to a Place. The model + The ImageModel is a read-only model used to fetch images related to a Place. The model performs fetches incrmentally. The number of images which are fetched at a time is specified by the batchSize property. The total number of images available can be accessed via the totalCount property and the number of fetched images via the count @@ -95,19 +96,19 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlproperty Place PlaceImageModel::place + \qmlproperty Place ImageModel::place This property holds the Place that the images are for. */ /*! - \qmlproperty int PlaceImageModel::batchSize + \qmlproperty int ImageModel::batchSize This property holds the batch size to use when fetching more image items. */ /*! - \qmlproperty int PlaceImageModel::totalCount + \qmlproperty int ImageModel::totalCount This property holds the total number of image items for the place. */ diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp index 617164f8..acbfc313 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceuser.cpp @@ -44,12 +44,12 @@ QT_USE_NAMESPACE /*! - \qmlclass User + \qmlclass User QDeclarativePlaceUser + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-places + \since QtLocation 5.0 \brief The User element identifies a particular user. - \inherits QObject - - \ingroup qml-places */ QDeclarativePlaceUser::QDeclarativePlaceUser(QObject* parent) diff --git a/src/imports/location/declarativeplaces/qdeclarativerating.cpp b/src/imports/location/declarativeplaces/qdeclarativerating.cpp index 3da972ce..a237aac7 100644 --- a/src/imports/location/declarativeplaces/qdeclarativerating.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativerating.cpp @@ -44,12 +44,12 @@ QT_USE_NAMESPACE /*! - \qmlclass Rating + \qmlclass Rating QDeclarativeRating + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-places + \since QtLocation 5.0 \brief The Rating element holds place rating information. - \inherits QObject - - \ingroup qml-places */ QDeclarativeRating::QDeclarativeRating(QObject* parent) diff --git a/src/imports/location/declarativeplaces/qdeclarativerecommendationmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativerecommendationmodel.cpp index b2211efb..8820b94c 100644 --- a/src/imports/location/declarativeplaces/qdeclarativerecommendationmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativerecommendationmodel.cpp @@ -52,9 +52,11 @@ QT_USE_NAMESPACE /*! \qmlclass RecommendationModel QDeclarativeRecommenadationModel + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-places + \since QtLocation 5.0 + \brief The RecommendationModel element provides access to place recommendations. - \inherits QAbstractListModel - \ingroup qml-places RecommendationModel provides a model of place recommendation results within the \l searchArea, that are similiar to the place identified by the \l placeId property. diff --git a/src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp index 4c7f657e..96a2edda 100644 --- a/src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp @@ -49,10 +49,11 @@ QT_BEGIN_NAMESPACE /*! \qmlclass ReviewModel QDeclarativeReviewModel + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-places + \since QtLocation 5.0 \brief The ReviewModel element provides access to reviews of a Place. - \ingroup qml-places - \since 5.0 The ReviewModel is a read-only model used to fetch reviews about a Place. The model incrementally fetches reviews. The number of reviews which are fetched at a time is specified diff --git a/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp index bb08a6d1..92227958 100644 --- a/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp @@ -51,12 +51,14 @@ QT_USE_NAMESPACE /*! - \qmlclass SearchResultModel QDeclarativeSearchResultModel - \brief The SearchResultModel element provides access to place search results. - \inherits QAbstractListModel - \ingroup qml-places + \qmlclass PlaceSearchModel QDeclarativeSearchResultModel + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-places + \since QtLocation 5.0 - SearchResultModel provides a model of place search results within the \l searchArea. The + \brief The PlaceSearchModel element provides access to place search results. + + PlaceSearchModel provides a model of place search results within the \l searchArea. The \l searchTerm and \l searchCategory properties can be set to restrict the search results to places matching those criteria. @@ -91,13 +93,13 @@ QT_USE_NAMESPACE \o Valid only for did you mean search results, a suggested corrected search term. \endtable - The following example shows how to use the SearchResultModel to search for Pizza restaurants + The following example shows how to use the PlaceSearchModel to search for Pizza restaurants within a 5km radius: \code import QtLocation 5.0 - SearchResultModel { + PlaceSearchModel { id: searchModel searchTerm: "Pizza" @@ -118,11 +120,11 @@ QT_USE_NAMESPACE } \endcode - \sa RecommendationModel, SupportedCategoryModel, {QPlaceManager} + \sa RecommendationModel, CategoriesModel, {QPlaceManager} */ /*! - \qmlproperty GeoCoordinate SearchResultModel::searchArea + \qmlproperty GeoCoordinate PlaceSearchModel::searchArea This element holds the search area. @@ -131,7 +133,7 @@ QT_USE_NAMESPACE */ /*! - \qmlproperty int SearchResultModel::offset + \qmlproperty int PlaceSearchModel::offset This element holds offset for items that would be returned. Less then 0 means that it is undefined. @@ -139,27 +141,27 @@ QT_USE_NAMESPACE /*! - \qmlproperty int SearchResultModel::limit + \qmlproperty int PlaceSearchModel::limit This element holds limit of items that would be returned. Less then -1 means that limit is undefined. */ /*! - \qmlproperty bool SearchResultModel::executing + \qmlproperty bool PlaceSearchModel::executing This property indicates whether a search query is currently being executed. */ /*! - \qmlmethod SearchResultModel::execute() + \qmlmethod PlaceSearchModel::execute() Parameter searchTerm should contain string for which search should be started. Updates the items represented by the model from the underlying proivider. */ /*! - \qmlmethod SearchResultModel::cancel() + \qmlmethod PlaceSearchModel::cancel() Cancels ongoing request. */ @@ -180,7 +182,7 @@ QDeclarativeSearchResultModel::~QDeclarativeSearchResultModel() } /*! - \qmlproperty string SearchResultModel::searchTerm + \qmlproperty string PlaceSearchModel::searchTerm This element holds search term used in query. */ @@ -199,7 +201,7 @@ void QDeclarativeSearchResultModel::setSearchTerm(const QString &searchTerm) } /*! - \qmlproperty QDeclarativeListProperty<QDeclarativeCategory> Place::categories + \qmlproperty QDeclarativeListProperty<QDeclarativeCategory> PlaceSearchModel::categories This property holds a categories list to be used when searching. It is expected that any places that match at least one of the categories is returned. @@ -265,7 +267,7 @@ void QDeclarativeSearchResultModel::categories_clear(QDeclarativeListProperty<QD } /*! - \qmlproperty enumeration SearchResultModel::relevanceHint + \qmlproperty enumeration PlaceSearchModel::relevanceHint This property holds a relevance hint for the search model. The hint is given to the provider to help but not dictate the ranking of results. e.g a distance @@ -296,7 +298,7 @@ void QDeclarativeSearchResultModel::setRelevanceHint(QDeclarativeSearchResultMod } /*! - \qmlproperty int SearchResultModel::maximumCorrections + \qmlproperty int PlaceSearchModel::maximumCorrections This element holds maximum number of search term corrections that may be returned. */ @@ -315,7 +317,7 @@ void QDeclarativeSearchResultModel::setMaximumCorrections(int corrections) } /*! - \qmlproperty QDeclarativePlace::Visibility SearchResultModel::visibilityScope + \qmlproperty QDeclarativePlace::Visibility PlaceSearchModel::visibilityScope This property holds the visibility scope of the places to search. */ diff --git a/src/imports/location/declarativeplaces/qdeclarativesupplier.cpp b/src/imports/location/declarativeplaces/qdeclarativesupplier.cpp index 17fc3c87..c564a1df 100644 --- a/src/imports/location/declarativeplaces/qdeclarativesupplier.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativesupplier.cpp @@ -47,10 +47,11 @@ QT_USE_NAMESPACE /*! \qmlclass Supplier QDeclarativeSupplier + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-places + \since QtLocation 5.0 \brief The Supplier element holds supplier data. - \ingroup qml-places - \since 5.0 Supplier cointains many properties holding data of the supplier like name, id, etc. diff --git a/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp index 71adf45b..2ec0c565 100644 --- a/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativesupportedcategoriesmodel.cpp @@ -50,24 +50,25 @@ QT_USE_NAMESPACE /*! - \qmlclass SupportedCategoryModel QDeclarativeSupportedCategoriesModel - \brief The SupportedCategoryModel element provides access to supported categories list. - \inherits QAbstractListModel - \ingroup qml-places + \qmlclass CategoryModel QDeclarativeSupportedCategoriesModel + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-places \since QtLocation 5.0 - SupportedCategoryModel provides a model of categories from the supported categories list. The + \brief The CategoriesModel element provides access to supported categories list. + + CategoriesModel provides a model of categories from the supported categories list. The model can provide both a flat list of categories or a hierarchical tree representing category grouping. This can be controlled by the \l hierarchy property. The model provides a single data role, \c category (\l Category). - To use SupportedCategoryModel user need to create it in qml file and connect it to some view + To use the CategoriesModel the user needs to create it in qml file and connect it to some view \code import QtQuick 2.0 import QtLocation 5.0 - SupportedCategoriesModel { + CategoriesModel { id: categoriesModel hierarchical: false } @@ -88,13 +89,13 @@ QT_USE_NAMESPACE */ /*! - \qmlproperty Plugin SupportedCategoriesModel::plugin + \qmlproperty Plugin CategoriesModel::plugin this property holds the provider Plugin used by this model. */ /*! - \qmlproperty bool SupportedCategoriesModel::hierarchical + \qmlproperty bool CategoriesModel::hierarchical This property holds whether the model provides a hierarchical tree of categories or a flat list. The default is true. diff --git a/src/imports/location/declarativeplaces/qdeclarativetextpredictionmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativetextpredictionmodel.cpp index e4a63d34..29634e41 100644 --- a/src/imports/location/declarativeplaces/qdeclarativetextpredictionmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativetextpredictionmodel.cpp @@ -52,9 +52,11 @@ QT_USE_NAMESPACE /*! \qmlclass TextPredictionModel QDeclarativeTextPredictionModel + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-places + \since QtLocation 5.0 + \brief The TextPredictionModel element provides access to text predictions. - \inherits QAbstractListModel - \ingroup qml-places TextPredictionModel provides a model of text prediction from PlaceManager. The contents of the model is string list. User can add additional parameters diff --git a/src/imports/location/location.cpp b/src/imports/location/location.cpp index ed25f8a1..9a8e8186 100644 --- a/src/imports/location/location.cpp +++ b/src/imports/location/location.cpp @@ -102,7 +102,7 @@ public: qmlRegisterType<QDeclarativePosition>(uri, 5, 0, "Position"); qmlRegisterType<QDeclarativePositionSource>(uri, 5, 0, "PositionSource"); qmlRegisterType<QDeclarativeCoordinate>(uri, 5, 0, "Coordinate"); - qmlRegisterType<QDeclarativeGeoBoundingArea>(); + qmlRegisterUncreatableType<QDeclarativeGeoBoundingArea>(uri, 5, 0, "BoundingArea", QDeclarativeGeoBoundingArea::tr("(Positioning)BoundingArea is not intended instantiable by developer.")); qmlRegisterType<QDeclarativeGeoBoundingBox>(uri, 5, 0, "BoundingBox"); qmlRegisterType<QDeclarativeGeoBoundingCircle>(uri, 5, 0, "BoundingCircle"); qmlRegisterType<QDeclarativeGeoAddress>(uri, 5, 0, "Address"); @@ -121,7 +121,6 @@ public: qmlRegisterType<QDeclarativeGeoRoute>(uri, 5, 0, "Route"); // data type qmlRegisterType<QDeclarativeGeoRouteSegment>(uri, 5, 0, "RouteSegment"); qmlRegisterType<QDeclarativeGeoManeuver>(uri, 5, 0, "RouteManeuver"); - qmlRegisterType<QDeclarativeGeoBoundingCircle>(uri, 5, 0, "BoundingCircle"); qmlRegisterUncreatableType<QDeclarativeGeoMapFlickable>(uri, 5, 0, "MapFlickable", QDeclarativeGeoMapFlickable::tr("(Map)Flickable is not intended instantiable by developer.")); qmlRegisterUncreatableType<QDeclarativeGeoMapPinchArea>(uri, 5, 0, "MapPinch", QDeclarativeGeoMapPinchArea::tr("(Map)PinchArea is not intended instantiable by developer.")); qmlRegisterUncreatableType<QDeclarativeGeoMapPinchEvent>(uri, 5, 0, "", QDeclarativeGeoMapPinchEvent::tr("(Map)PinchEvent is not intended instantiable by developer.")); @@ -138,7 +137,7 @@ public: qmlRegisterType<QDeclarativePlaceUser>(uri, 5, 0, "User"); qmlRegisterType<QDeclarativeRecommendationModel>(uri, 5, 0, "RecommendationModel"); - qmlRegisterType<QDeclarativeSupportedCategoriesModel>(uri, 5, 0, "CategoriesModel"); + qmlRegisterType<QDeclarativeSupportedCategoriesModel>(uri, 5, 0, "CategoryModel"); qmlRegisterType<QDeclarativeSearchResultModel>(uri, 5, 0, "PlaceSearchModel"); qmlRegisterType<QDeclarativeTextPredictionModel>(uri, 5, 0, "TextPredictionModel"); qmlRegisterType<QDeclarativePropertyMap>(uri, 5,0,"ExtendedAttributes"); diff --git a/src/imports/location/location.pro b/src/imports/location/location.pro index b0ee6297..3abb186b 100644 --- a/src/imports/location/location.pro +++ b/src/imports/location/location.pro @@ -49,6 +49,7 @@ SOURCES += qdeclarativeposition.cpp \ qdeclarativegeomapmousearea.cpp \ qdeclarativegeoserviceprovider.cpp \ qdeclarativegeoaddress.cpp \ + qdeclarativegeoboundingarea.cpp \ qdeclarativegeoboundingbox.cpp \ qdeclarativegeocodemodel.cpp \ qdeclarativegeoroutemodel.cpp \ diff --git a/src/imports/location/qdeclarative3dgraphicsgeomap.cpp b/src/imports/location/qdeclarative3dgraphicsgeomap.cpp index b9a026a7..87c3bb82 100644 --- a/src/imports/location/qdeclarative3dgraphicsgeomap.cpp +++ b/src/imports/location/qdeclarative3dgraphicsgeomap.cpp @@ -74,12 +74,12 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass Map + \qmlclass Map QDeclarative3DGraphicsGeoMap + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-maps + \since QtLocation 5.0 \brief The Map element displays a map. - \inherits QDeclarativeItem - - \ingroup qml-location-maps The Map element can be used be used to display a map of the world. The bulk of the functionality is provided by a mapping plugin described @@ -101,8 +101,6 @@ QT_BEGIN_NAMESPACE Mouse handling is done by adding MapMouseArea items as children of either MapItems or the Map item itself. - - The Map element is part of the \bold{QtLocation 5.0} module. */ QDeclarative3DGraphicsGeoMap::QDeclarative3DGraphicsGeoMap(QQuickItem *parent) diff --git a/src/imports/location/qdeclarativecoordinate.cpp b/src/imports/location/qdeclarativecoordinate.cpp index e63ebf49..400d06e5 100644 --- a/src/imports/location/qdeclarativecoordinate.cpp +++ b/src/imports/location/qdeclarativecoordinate.cpp @@ -46,15 +46,13 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass Coordinate + \qmlclass Coordinate QDeclarativeCoordinate + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-positioning + \since QtLocation 5.0 \brief The Coordinate element holds various positional data, such as \l latitude, \l longitude and \l altitude. - \inherits QObject - - \ingroup qml-location - - The Coordinate element is part of the \bold{QtMobility.location 1.1} module. */ QDeclarativeCoordinate::QDeclarativeCoordinate(QObject* parent) diff --git a/src/imports/location/qdeclarativegeoaddress.cpp b/src/imports/location/qdeclarativegeoaddress.cpp index 9dbad502..1f22c5bd 100644 --- a/src/imports/location/qdeclarativegeoaddress.cpp +++ b/src/imports/location/qdeclarativegeoaddress.cpp @@ -45,11 +45,13 @@ QT_BEGIN_NAMESPACE /*! \qmlclass Address QDeclarativeGeoAddress + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-positioning + \since QtLocation 5.0 + \brief The Address element presents an address. - \ingroup qml-location The Address element presents an address of a location. - This element is part of the \bold{QtLocation 5.0} module. \sa {QGeoAddress} */ diff --git a/src/imports/location/qdeclarativegeoboundingarea.cpp b/src/imports/location/qdeclarativegeoboundingarea.cpp new file mode 100644 index 00000000..fe8b8f0f --- /dev/null +++ b/src/imports/location/qdeclarativegeoboundingarea.cpp @@ -0,0 +1,60 @@ +/**************************************************************************** +** +** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtLocation module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** GNU Lesser General Public License Usage +** This file may be used under the terms of the GNU Lesser General Public +** License version 2.1 as published by the Free Software Foundation and +** appearing in the file LICENSE.LGPL included in the packaging of this +** file. Please review the following information to ensure the GNU Lesser +** General Public License version 2.1 requirements will be met: +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU General +** Public License version 3.0 as published by the Free Software Foundation +** and appearing in the file LICENSE.GPL included in the packaging of this +** file. Please review the following information to ensure the GNU General +** Public License version 3.0 requirements will be met: +** http://www.gnu.org/copyleft/gpl.html. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qdeclarativegeoboundingarea_p.h" + +QT_BEGIN_NAMESPACE + +/*! + \qmlclass BoundingArea QDeclarativeGeoBoundingArea + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-positioning + \since QtLocation 5.0 + + \brief The BoundingArea element represent an abstract geographic area. + + The BoundingArea element is not intended to be instantiated by the developer. Use BoundingBox + or BoundingCircle instead. + + \sa BoundingBox, BoundingCircle +*/ + +QT_END_NAMESPACE diff --git a/src/imports/location/qdeclarativegeoboundingbox.cpp b/src/imports/location/qdeclarativegeoboundingbox.cpp index 4b23c240..9d9a8292 100644 --- a/src/imports/location/qdeclarativegeoboundingbox.cpp +++ b/src/imports/location/qdeclarativegeoboundingbox.cpp @@ -46,14 +46,13 @@ QT_BEGIN_NAMESPACE /*! \qmlclass BoundingBox QDeclarativeGeoBoundingBox - \brief The QGeoBoundingBox class defines a rectangular geographic area. - \ingroup qml-location + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-positioning + \since QtLocation 5.0 - The BoundingBox class defines a rectangular geographic area. - This element is part of the \bold{QtMobility.location 1.1} module. - For behavioral details, please see \l QGeoBoundingBox. + \brief The BoundingBox element represents a rectangular geographic area. - \sa {QGeoBoundingBox} + For behavioral details, please see \l QGeoBoundingBox. */ QDeclarativeGeoBoundingBox::QDeclarativeGeoBoundingBox(QObject* parent) : diff --git a/src/imports/location/qdeclarativegeoboundingcircle.cpp b/src/imports/location/qdeclarativegeoboundingcircle.cpp index 90a418b1..fb7a076d 100644 --- a/src/imports/location/qdeclarativegeoboundingcircle.cpp +++ b/src/imports/location/qdeclarativegeoboundingcircle.cpp @@ -45,7 +45,14 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass Yippiaiee! TODO + \qmlclass BoundingCircle QDeclarativeGeoBoundingCircle + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-positioning + \since QtLocation 5.0 + + \brief The BoundingCircle element represents a circular geographic area. + + For behavioral details, please see \l QGeoBoundingCircle. */ QDeclarativeGeoBoundingCircle::QDeclarativeGeoBoundingCircle(QObject* parent) diff --git a/src/imports/location/qdeclarativegeocodemodel.cpp b/src/imports/location/qdeclarativegeocodemodel.cpp index 451fff7c..8b26a555 100644 --- a/src/imports/location/qdeclarativegeocodemodel.cpp +++ b/src/imports/location/qdeclarativegeocodemodel.cpp @@ -50,12 +50,13 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass GeocodeModel + \qmlclass GeocodeModel QDeclarativeGeocodeModel + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-geocoding + \since QtLocation 5.0 \brief The GeocodeModel element provides support for searching operations related to geographic information. - \ingroup qml-geocoding - \since 5.0 The GeocodeModel is a model used to perform geocoding. This includes both geocoding (address to coordinate) and reverse geocoding (coordinate to address). diff --git a/src/imports/location/qdeclarativegeolocation.cpp b/src/imports/location/qdeclarativegeolocation.cpp index 87cf4c18..d11cee5c 100644 --- a/src/imports/location/qdeclarativegeolocation.cpp +++ b/src/imports/location/qdeclarativegeolocation.cpp @@ -44,15 +44,15 @@ QT_USE_NAMESPACE /*! - \qmlclass Location + \qmlclass Location QDeclarativeGeoLocation + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-positioning + \since QtLocation 5.0 \brief The Location element holds location data. - \inherits QObject Location cointains many properties holding data of the location like geo coordinates, address, etc. - - \ingroup qml-places */ QDeclarativeGeoLocation::QDeclarativeGeoLocation(QObject* parent) diff --git a/src/imports/location/qdeclarativegeomaneuver.cpp b/src/imports/location/qdeclarativegeomaneuver.cpp index 9fafa6e2..099e6f02 100644 --- a/src/imports/location/qdeclarativegeomaneuver.cpp +++ b/src/imports/location/qdeclarativegeomaneuver.cpp @@ -44,12 +44,13 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass RouteManeuver + \qmlclass RouteManeuver QDeclarativeGeoManeuver + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-routing + \since QtLocation 5.0 \brief The RouteManeuver element represents the information relevant to the point at which two RouteSegments meet. - \ingroup qml-routing - \since 5.0 RouteSegment instances can be thought of as edges on a routing graph, with RouteManeuver instances as optional labels attached to the diff --git a/src/imports/location/qdeclarativegeomapitemview.cpp b/src/imports/location/qdeclarativegeomapitemview.cpp index 85b4345b..c41bc84d 100644 --- a/src/imports/location/qdeclarativegeomapitemview.cpp +++ b/src/imports/location/qdeclarativegeomapitemview.cpp @@ -52,18 +52,17 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass MapItemView - - \brief The MapItemView is used to populate Map from a model. + \qmlclass MapItemView QDeclarativeGeoMapItemView + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-maps + \since QtLocation 5.0 \inherits QQuickItem - \ingroup qml-location-maps + \brief The MapItemView is used to populate Map from a model. The MapItemView is used to populate Map with MapItems from a model. The MapItemView element only makes sense when contained in a Map, meaning that it has no standalone presentation. - - The MapItemView element is part of the \bold{QtLocation 5.0} module. */ QDeclarativeGeoMapItemView::QDeclarativeGeoMapItemView(QQuickItem *parent) diff --git a/src/imports/location/qdeclarativegeomapmouseevent.cpp b/src/imports/location/qdeclarativegeomapmouseevent.cpp index 1dc37c18..f596a4ce 100644 --- a/src/imports/location/qdeclarativegeomapmouseevent.cpp +++ b/src/imports/location/qdeclarativegeomapmouseevent.cpp @@ -45,11 +45,12 @@ QT_BEGIN_NAMESPACE /*! \qmlclass MapMouseEvent QDeclarativeGeoMapMouseEvent + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-maps + \since QtLocation 5.0 \brief The MapMouseEvent object provides information about a mouse event. - \ingroup qml-location-maps - The position of the mouse can be found via the \l x and \l y properties or the \l coordinate property. The button that caused the event is available via the \l button property. diff --git a/src/imports/location/qdeclarativegeoroute.cpp b/src/imports/location/qdeclarativegeoroute.cpp index 9e733a99..ee6e01ce 100644 --- a/src/imports/location/qdeclarativegeoroute.cpp +++ b/src/imports/location/qdeclarativegeoroute.cpp @@ -44,11 +44,12 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass Route + \qmlclass Route QDeclarativeGeoRoute + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-routing + \since QtLocation 5.0 \brief The Route element represents one geographical route. - \ingroup qml-routing - \since 5.0 A Route element contains high level information about a route, such as the length the route, the estimated travel time for the route, diff --git a/src/imports/location/qdeclarativegeoroutemodel.cpp b/src/imports/location/qdeclarativegeoroutemodel.cpp index 8552cc35..72fefa2b 100644 --- a/src/imports/location/qdeclarativegeoroutemodel.cpp +++ b/src/imports/location/qdeclarativegeoroutemodel.cpp @@ -49,11 +49,12 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass RouteModel + \qmlclass RouteModel QDeclarativeGeoRouteModel + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-routing + \since QtLocation 5.0 \brief The RouteModel element provides access to routes. - \ingroup qml-routing - \since 5.0 The RouteModel is model used to fetch routes. The routing result provider is determined by the \l plugin. The route data is set in \l query. @@ -460,7 +461,13 @@ void QDeclarativeGeoRouteModel::routingError(QGeoRouteReply *reply, reply_ = 0; } -// RouteQuery + +/*! + \qmlclass RouteQuery QDeclarativeGeoRouteQuery + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-routing + \since QtLocation 5.0 +*/ QDeclarativeGeoRouteQuery::QDeclarativeGeoRouteQuery(QObject *parent) : QObject(parent), diff --git a/src/imports/location/qdeclarativegeoroutesegment.cpp b/src/imports/location/qdeclarativegeoroutesegment.cpp index c1d1c0d8..51e71645 100644 --- a/src/imports/location/qdeclarativegeoroutesegment.cpp +++ b/src/imports/location/qdeclarativegeoroutesegment.cpp @@ -44,11 +44,12 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass RouteSegment + \qmlclass RouteSegment QDeclarativeGeoRouteSegment + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-routing + \since QtLocation 5.0 \brief The RouteSegment element represents a segment of a Route. - \ingroup qml-routing - \since 5.0 A RouteSegment instance has information about the physcial layout of the route segment, the length of the route and estimated time required diff --git a/src/imports/location/qdeclarativegeoserviceprovider.cpp b/src/imports/location/qdeclarativegeoserviceprovider.cpp index c0cf6b30..fc539404 100644 --- a/src/imports/location/qdeclarativegeoserviceprovider.cpp +++ b/src/imports/location/qdeclarativegeoserviceprovider.cpp @@ -51,14 +51,12 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass Plugin + \qmlclass Plugin QDeclarativeGeoServiceProvider + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-common + \since QtLocation 5.0 \brief The Plugin element describes a Location based services plugin. - \inherits QObject - - \ingroup qml-location-maps - - The Plugin element is part of the \bold{QtMobility.location 1.2} module. */ QDeclarativeGeoServiceProvider::QDeclarativeGeoServiceProvider(QObject *parent) @@ -328,14 +326,12 @@ QMap<QString, QVariant> QDeclarativeGeoServiceProvider::parameterMap() const *******************************************************************************/ /*! - \qmlclass PluginParameter + \qmlclass PluginParameter QDeclarativeGeoServiceProviderParameter + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-common + \since QtLocation 5.0 \brief The PluginParameter element describes the parameter to a \l Plugin. - \inherits QObject - - \ingroup qml-location-maps - - The PluginParameter element is part of the \bold{QtMobility.location 1.2} module. */ QDeclarativeGeoServiceProviderParameter::QDeclarativeGeoServiceProviderParameter(QObject *parent) diff --git a/src/imports/location/qdeclarativeposition.cpp b/src/imports/location/qdeclarativeposition.cpp index dd828481..ba590b5a 100644 --- a/src/imports/location/qdeclarativeposition.cpp +++ b/src/imports/location/qdeclarativeposition.cpp @@ -47,12 +47,13 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass Position + \qmlclass Position QDeclarativePosition + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-positioning + \since QtLocation 5.0 \brief The Position element holds various positional data, such as coordinate (longitude, latitude, altitude) and speed. - \inherits QObject - \ingroup qml-location The Position element holds various positional data, such as \l coordinate, (longitude, latitude, and altitude) and \l speed, as well as \l timestamp. @@ -64,8 +65,6 @@ QT_BEGIN_NAMESPACE At the time being the Position element is a read-only element (meaning it does not have exposed write accessors), primarily used by \l PositionSource. - The Position element is part of the \bold{QtMobility.location 1.1} module. - \sa PositionSource, Coordinate */ diff --git a/src/imports/location/qdeclarativepositionsource.cpp b/src/imports/location/qdeclarativepositionsource.cpp index e47b4e7e..b9851b7a 100644 --- a/src/imports/location/qdeclarativepositionsource.cpp +++ b/src/imports/location/qdeclarativepositionsource.cpp @@ -53,17 +53,17 @@ QT_BEGIN_NAMESPACE /*! - \qmlclass PositionSource + \qmlclass PositionSource QDeclarativePositionSource + \inqmlmodule QtLocation 5 + \ingroup qml-QtLocation5-positioning + \since QtLocation 5.0 \brief The PositionSource element allows you to get information about your current position. - \inherits QObject - - \ingroup qml-location The PositionSource element allows you to get information about your current position. You can receive information about things such as latitude, longitude, altitude, and - speed. This element is part of the \bold{QtMobility.location 1.1} module. + speed. Support for location sources are platform dependant. When declaring a PositionSource element, a default PositionSource source shall be created. Supported positioning methods are held in @@ -79,12 +79,6 @@ QT_BEGIN_NAMESPACE */ -/*! - \internal - \class QDeclarativePositionSource - \brief The QDeclarativePositionSource provides positional data. -*/ - QDeclarativePositionSource::QDeclarativePositionSource() : m_positionSource(0), m_positioningMethod(QDeclarativePositionSource::NoPositioningMethod), m_nmeaFile(0), m_active(false), m_singleUpdate(false), m_updateInterval(0) diff --git a/src/location/maps/qgeocodereply.cpp b/src/location/maps/qgeocodereply.cpp index 5182f430..50b9133a 100644 --- a/src/location/maps/qgeocodereply.cpp +++ b/src/location/maps/qgeocodereply.cpp @@ -45,15 +45,13 @@ QT_BEGIN_NAMESPACE /*! \class QGeocodeReply + \inmodule QtLocation + \ingroup QtLocation-geocoding + \since QtLocation 5.0 \brief The QGeocodeReply class manages an operation started by an instance of QGeocodingManager. - - \inmodule QtLocation - - \ingroup maps-places - Instances of QGeocodeReply manage the state and results of these operations. diff --git a/src/location/maps/qgeocodingmanager.cpp b/src/location/maps/qgeocodingmanager.cpp index fa3d30d1..5b37f61d 100644 --- a/src/location/maps/qgeocodingmanager.cpp +++ b/src/location/maps/qgeocodingmanager.cpp @@ -52,15 +52,13 @@ QT_BEGIN_NAMESPACE /*! \class QGeocodingManager + \inmodule QtLocation + \ingroup QtLocation-geocoding + \since QtLocation 5.0 \brief The QGeocodingManager class provides support for geocoding operations. - - \inmodule QtLocation - - \ingroup maps-places - The geocode(), reverseGeocode() and search() functions return QGeocodeReply objects, which manage these operations and report on the result of the operations and any errors which may have occurred. diff --git a/src/location/maps/qgeocodingmanagerengine.cpp b/src/location/maps/qgeocodingmanagerengine.cpp index 5eaea3ff..81dd6421 100644 --- a/src/location/maps/qgeocodingmanagerengine.cpp +++ b/src/location/maps/qgeocodingmanagerengine.cpp @@ -49,15 +49,14 @@ QT_BEGIN_NAMESPACE /*! \class QGeocodingManagerEngine + \inmodule QtLocation + \ingroup QtLocation-impl + \since QtLocation 5.0 \brief The QGeocodingManagerEngine class provides an interface and convenience methods to implementers of QGeoServiceProvider plugins who want to provide support for geocoding operations. - \inmodule QtLocation - - \ingroup maps-impl - In the default implementation, supportsGeocoding() and supportsReverseGeocoding() returns false while geocode() and reverseGeocode() cause QGeocodeReply::UnsupportedOptionError to occur. diff --git a/src/location/maps/qgeomaneuver.cpp b/src/location/maps/qgeomaneuver.cpp index c244e038..1660becd 100644 --- a/src/location/maps/qgeomaneuver.cpp +++ b/src/location/maps/qgeomaneuver.cpp @@ -48,12 +48,12 @@ QT_BEGIN_NAMESPACE /*! \class QGeoManeuver - \brief The QGeoManeuver class represents the information relevant to the - point at which two QGeoRouteSegments meet. - \inmodule QtLocation + \ingroup QtLocation-routing + \since QtLocation 5.0 - \ingroup maps-routing + \brief The QGeoManeuver class represents the information relevant to the + point at which two QGeoRouteSegments meet. QGeoRouteSegment instances can be thought of as edges on a routing graph, with QGeoManeuver instances as optional labels attached to the diff --git a/src/location/maps/qgeomappingmanager.cpp b/src/location/maps/qgeomappingmanager.cpp index b1196fb9..b9caf94f 100644 --- a/src/location/maps/qgeomappingmanager.cpp +++ b/src/location/maps/qgeomappingmanager.cpp @@ -53,12 +53,12 @@ QT_BEGIN_NAMESPACE /*! \class QGeoMappingManager - \brief The QGeoMappingManager class provides support for displaying - and interacting with maps. - \inmodule QtLocation + \ingroup QtLocation-maps + \since QtLocation 5.0 - \ingroup maps-mapping + \brief The QGeoMappingManager class provides support for displaying + and interacting with maps. A QGeoMappingManager instance can create QGeoMapData instances with createMapData(). The QGeoMapData instances can be used to contain and diff --git a/src/location/maps/qgeomappingmanagerengine.cpp b/src/location/maps/qgeomappingmanagerengine.cpp index 44b7b2c5..b6a36b9e 100644 --- a/src/location/maps/qgeomappingmanagerengine.cpp +++ b/src/location/maps/qgeomappingmanagerengine.cpp @@ -50,14 +50,14 @@ QT_BEGIN_NAMESPACE /*! \class QGeoMappingManagerEngine + \inmodule QtLocation + \ingroup QtLocation-impl + \since QtLocation 5.0 + \brief The QGeoMappingManagerEngine class provides an interface and convenience methods to implementors of QGeoServiceProvider plugins who want to provides support for displaying and interacting with maps. - \inmodule QtLocation - - \ingroup maps-impl - Subclasses of QGeoMappingManagerEngine need to provide an implementations of createMapData(). The QGeoMapData instances returned by createMapData() can be used to contain and manage information concerning what a particular diff --git a/src/location/maps/qgeoroute.cpp b/src/location/maps/qgeoroute.cpp index e61525d3..250c03f7 100644 --- a/src/location/maps/qgeoroute.cpp +++ b/src/location/maps/qgeoroute.cpp @@ -51,11 +51,11 @@ QT_BEGIN_NAMESPACE /*! \class QGeoRoute - \brief The QGeoRoute class represents a route between two points. - \inmodule QtLocation + \ingroup QtLocation-routing + \since QtLocation 5.0 - \ingroup maps-routing + \brief The QGeoRoute class represents a route between two points. A QGeoRoute object contains high level information about a route, such as the length the route, the estimated travel time for the route, diff --git a/src/location/maps/qgeoroutereply.cpp b/src/location/maps/qgeoroutereply.cpp index 50f0d97d..021a7dc5 100644 --- a/src/location/maps/qgeoroutereply.cpp +++ b/src/location/maps/qgeoroutereply.cpp @@ -46,14 +46,13 @@ QT_BEGIN_NAMESPACE /*! \class QGeoRouteReply + \inmodule QtLocation + \ingroup QtLocation-routing + \since QtLocation 5.0 \brief The QGeoRouteReply class manages an operation started by an instance of QGeoRoutingManager. - \inmodule QtLocation - - \ingroup maps-routing - Instances of QGeoRouteReply manage the state and results of these operations. diff --git a/src/location/maps/qgeorouterequest.cpp b/src/location/maps/qgeorouterequest.cpp index 674b68f0..bde5fd15 100644 --- a/src/location/maps/qgeorouterequest.cpp +++ b/src/location/maps/qgeorouterequest.cpp @@ -49,12 +49,12 @@ QT_BEGIN_NAMESPACE /*! \class QGeoRouteRequest - \brief The QGeoRouteRequest class represents the parameters and restrictions - which define a request for routing information. - \inmodule QtLocation + \ingroup QtLocation-routing + \since QtLocation 5.0 - \ingroup maps-routing + \brief The QGeoRouteRequest class represents the parameters and restrictions + which define a request for routing information. The default state of a QGeoRouteRequest instance will result in a request for basic route segment and navigation maneuvers describing the fastest diff --git a/src/location/maps/qgeoroutesegment.cpp b/src/location/maps/qgeoroutesegment.cpp index 9d373269..2f050487 100644 --- a/src/location/maps/qgeoroutesegment.cpp +++ b/src/location/maps/qgeoroutesegment.cpp @@ -49,11 +49,11 @@ QT_BEGIN_NAMESPACE /*! \class QGeoRouteSegment - \brief The QGeoRouteSegment class represents a segment of a route. - \inmodule QtLocation + \ingroup QtLocation-routing + \since QtLocation 5.0 - \ingroup maps-routing + \brief The QGeoRouteSegment class represents a segment of a route. A QGeoRouteSegment instance has information about the physcial layout of the route segment, the length of the route and estimated time required diff --git a/src/location/maps/qgeoroutingmanager.cpp b/src/location/maps/qgeoroutingmanager.cpp index 36a3a12d..91261cc1 100644 --- a/src/location/maps/qgeoroutingmanager.cpp +++ b/src/location/maps/qgeoroutingmanager.cpp @@ -49,15 +49,13 @@ QT_BEGIN_NAMESPACE /*! \class QGeoRoutingManager + \inmodule QtLocation + \ingroup QtLocation-routing + \since QtLocation 5.0 \brief The QGeoRoutingManager class provides support for geographic routing operations. - - \inmodule QtLocation - - \ingroup maps-routing - The calculateRoute() and updateRoute() methods function QGeoRouteReply objects, which manage these operations and report on the result of the operations and any errors which may have occurred. diff --git a/src/location/maps/qgeoroutingmanagerengine.cpp b/src/location/maps/qgeoroutingmanagerengine.cpp index 2c91924d..7b7abba2 100644 --- a/src/location/maps/qgeoroutingmanagerengine.cpp +++ b/src/location/maps/qgeoroutingmanagerengine.cpp @@ -46,16 +46,14 @@ QT_BEGIN_NAMESPACE /*! \class QGeoRoutingManagerEngine + \inmodule QtLocation + \ingroup QtLocation-impl + \since QtLocation 5.0 \brief The QGeoRoutingManagerEngine class provides an interface and convenience methods to implementers of QGeoServiceProvider plugins who want to provide access to geographic routing information. - - \inmodule QtLocation - - \ingroup maps-impl - Subclasses of QGeoRoutingManagerEngine need to provide an implementation of calculateRoute(). diff --git a/src/location/maps/qgeoserviceprovider.cpp b/src/location/maps/qgeoserviceprovider.cpp index e00a6edc..062e7d9b 100644 --- a/src/location/maps/qgeoserviceprovider.cpp +++ b/src/location/maps/qgeoserviceprovider.cpp @@ -71,12 +71,12 @@ QT_BEGIN_NAMESPACE /*! \class QGeoServiceProvider - \brief The QGeoServiceProvider class aggregates access to services which provide - geographical information. - \inmodule QtLocation + \ingroup QtLocation-common + \since QtLocation 5.0 - \ingroup maps + \brief The QGeoServiceProvider class aggregates access to services which provide + geographical information. The Maps and Navigation API allows people to access various kinds of geographical information, including functionality to perform geocoding, diff --git a/src/location/maps/qgeoserviceproviderfactory.cpp b/src/location/maps/qgeoserviceproviderfactory.cpp index a113de53..e9a7891a 100644 --- a/src/location/maps/qgeoserviceproviderfactory.cpp +++ b/src/location/maps/qgeoserviceproviderfactory.cpp @@ -45,15 +45,13 @@ QT_BEGIN_NAMESPACE /*! \class QGeoServiceProviderFactory + \inmodule QtLocation + \ingroup QtLocation-impl + \since QtLocation 5.0 \brief The QGeoServiceProviderFactory class is a factory class used as the plugin interface for services related to geographical information. - - \inmodule QtLocation - - \ingroup maps-impl - Implementers must provide a unique combination of providerName() and providerVersion() per plugin. diff --git a/src/location/maps/qgeotiledmapreply.cpp b/src/location/maps/qgeotiledmapreply.cpp index 282cfea0..400a0713 100644 --- a/src/location/maps/qgeotiledmapreply.cpp +++ b/src/location/maps/qgeotiledmapreply.cpp @@ -47,15 +47,13 @@ QT_BEGIN_NAMESPACE /*! \class QGeoTiledMapReply + \inmodule QtLocation + \ingroup QtLocation-impl + \since QtLocation 5.0 \brief The QGeoTiledMapReply class manages a tile fetch operation started by an instance of QGeoTiledManagerEngine. - \inmodule QtLocation - - \ingroup maps-impl-tiled - - Instances of QGeoTiledMapReply manage the state and results of these operations. diff --git a/src/location/places/qplaceattribute.cpp b/src/location/places/qplaceattribute.cpp index ce9b850a..405cbba7 100644 --- a/src/location/places/qplaceattribute.cpp +++ b/src/location/places/qplaceattribute.cpp @@ -66,12 +66,12 @@ bool QPlaceAttributePrivate::operator== (const QPlaceAttributePrivate &other) co } /*! -\class QPlaceAttribute -\brief The QPlaceAttribute class represents generic attribute information about a place. -\inmodule QtLocation + \class QPlaceAttribute + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 -\ingroup location -\ingroup places-main + \brief The QPlaceAttribute class represents generic attribute information about a place. */ /*! diff --git a/src/location/places/qplacecategory.cpp b/src/location/places/qplacecategory.cpp index 9d927395..2b922136 100644 --- a/src/location/places/qplacecategory.cpp +++ b/src/location/places/qplacecategory.cpp @@ -76,8 +76,9 @@ bool QPlaceCategoryPrivate::operator==(const QPlaceCategoryPrivate &other) const /*! \class QPlaceCategory - - \inmodule QPlaces + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 \brief The QPlaceCategory class represents a category object. @@ -89,9 +90,6 @@ bool QPlaceCategoryPrivate::operator==(const QPlaceCategoryPrivate &other) const contact object and add it to place. QPlaceCategory is an in memory representation of a contact object. - - \ingroup location - \ingroup places-main */ diff --git a/src/location/places/qplacecontentreply.cpp b/src/location/places/qplacecontentreply.cpp index 44217ec7..e1d7462b 100644 --- a/src/location/places/qplacecontentreply.cpp +++ b/src/location/places/qplacecontentreply.cpp @@ -60,13 +60,12 @@ QT_USE_NAMESPACE /*! \class QPlaceContentReply + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 \brief The QPlaceContentReply class manages a content retrieval operation started by an instance of QPlaceManager. - - \inmodule QtLocation - - \ingroup places-main */ /*! diff --git a/src/location/places/qplacecontentrequest.cpp b/src/location/places/qplacecontentrequest.cpp index e439ecd7..fdca36ef 100644 --- a/src/location/places/qplacecontentrequest.cpp +++ b/src/location/places/qplacecontentrequest.cpp @@ -74,13 +74,11 @@ void QPlaceContentRequestPrivate::clear() /*! \class QPlaceContentRequest + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 - \inmodule Location - - \brief The QPlaceContentRequest class represents the query parameters - of a content request. - - \ingroup places-main + \brief The QPlaceContentRequest class represents the query parameters of a content request. The QPlaceContentRequest class represents a query parameters object, it currently specifies the type of content to be retrived. diff --git a/src/location/places/qplacedetailsreply.cpp b/src/location/places/qplacedetailsreply.cpp index b45fde43..32dfa11d 100644 --- a/src/location/places/qplacedetailsreply.cpp +++ b/src/location/places/qplacedetailsreply.cpp @@ -57,13 +57,12 @@ QT_USE_NAMESPACE /*! \class QPlaceDetailsReply + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 \brief The QPlaceDetailsReply class manages a place datails operation started by an instance of QPlaceManager. - - \inmodule QtPlaces - - \ingroup places-main */ /*! diff --git a/src/location/places/qplaceeditorial.cpp b/src/location/places/qplaceeditorial.cpp index 3343d569..08458e5a 100644 --- a/src/location/places/qplaceeditorial.cpp +++ b/src/location/places/qplaceeditorial.cpp @@ -71,8 +71,9 @@ bool QPlaceEditorialPrivate::compare(const QPlaceContentPrivate *other) const /*! \class QPlaceEditorial - - \inmodule QPlaces + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 \brief The QPlaceEditorial class represents a address object. @@ -81,8 +82,6 @@ bool QPlaceEditorialPrivate::compare(const QPlaceContentPrivate *other) const Editorial objects are read-only, e.g. user of API might get editorial objects associated to specific place but can not edit its content. User might also create new editorial. - - \ingroup places-main */ /*! diff --git a/src/location/places/qplaceidreply.cpp b/src/location/places/qplaceidreply.cpp index f4972fb2..a80f4438 100644 --- a/src/location/places/qplaceidreply.cpp +++ b/src/location/places/qplaceidreply.cpp @@ -58,13 +58,12 @@ QT_USE_NAMESPACE /*! \class QPlaceIdReply + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 \brief The QPlaceIdReply class manages operations which return an id such as saving and removal operations of places and categories. - - \inmodule QtLocation - - \ingroup places-main */ /*! diff --git a/src/location/places/qplaceimage.cpp b/src/location/places/qplaceimage.cpp index 8322936f..91dda7eb 100644 --- a/src/location/places/qplaceimage.cpp +++ b/src/location/places/qplaceimage.cpp @@ -69,14 +69,12 @@ bool QPlaceImagePrivate::compare(const QPlaceContentPrivate *other) const /*! \class QPlaceImage - - \inmodule QPlaces - - \ingroup places-main + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 \brief The QPlaceImage class represents an image. - Each QPlaceImage represents an image with a number of attributes such as type, thumbnail, media provider etc. diff --git a/src/location/places/qplacemanager.cpp b/src/location/places/qplacemanager.cpp index 449f4766..2ebf3374 100644 --- a/src/location/places/qplacemanager.cpp +++ b/src/location/places/qplacemanager.cpp @@ -48,13 +48,11 @@ QT_BEGIN_NAMESPACE /*! \class QPlaceManager - - \brief The QPlaceManager class is responsible for the discovery and - management of places. - \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 - \ingroup places-main + \brief The QPlaceManager class is responsible for the discovery and management of places. */ /*! diff --git a/src/location/places/qplacemanagerengine.cpp b/src/location/places/qplacemanagerengine.cpp index 5574d283..f30f72f2 100644 --- a/src/location/places/qplacemanagerengine.cpp +++ b/src/location/places/qplacemanagerengine.cpp @@ -46,16 +46,14 @@ QT_USE_NAMESPACE /*! \class QPlaceManagerEngine + \inmodule QtLocation + \ingroup QtLocation-impl + \since QtLocation 5.0 \brief The QPlaceManagerEngine class provides an interface and convenience methods to implementers of QGeoServiceProvider plugins who want to provide access to place search functionality. - \inmodule QtLocation - \since 5.0 - - \ingroup maps-impl - Subclasses of QPlaceManagerEngine need to provide an implementation of getPlaceDetails(), getContent(), postRating(), getReviews(), searchForPlaces(), supportedSearchVisibilityScopes(), recommendations(), textPredictions(), savePlace(), supportedSaveVisibilityScopes(), removePlace(), diff --git a/src/location/places/qplacerating.cpp b/src/location/places/qplacerating.cpp index 5f2386bf..ab11fcbb 100644 --- a/src/location/places/qplacerating.cpp +++ b/src/location/places/qplacerating.cpp @@ -65,16 +65,15 @@ bool QPlaceRatingPrivate::operator==(const QPlaceRatingPrivate &other) const /*! \class QPlaceRating - - \inmodule QPlaces + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 \brief The QPlaceRating class represents a rating object. Each QPlaceRating represents a rating object with a count and value. QPlaceRating is an in memory representation of a rating object. - - \ingroup places-main */ /*! diff --git a/src/location/places/qplacereply.cpp b/src/location/places/qplacereply.cpp index 7466ccab..2c56e145 100644 --- a/src/location/places/qplacereply.cpp +++ b/src/location/places/qplacereply.cpp @@ -46,13 +46,11 @@ QT_USE_NAMESPACE /*! \class QPlaceReply + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 - \inmodule Location - - \brief The QPlaceReply class manages an operation started by - an instance of QPlaceManager. - - \ingroup places-main + \brief The QPlaceReply class manages an operation started by an instance of QPlaceManager. */ /*! diff --git a/src/location/places/qplacerequest.cpp b/src/location/places/qplacerequest.cpp index 82d9e802..6209f966 100644 --- a/src/location/places/qplacerequest.cpp +++ b/src/location/places/qplacerequest.cpp @@ -83,13 +83,11 @@ void QPlaceRequestPrivate::clear() /*! \class QPlaceQuery - - \inmodule Location + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 \brief The QPlaceQuery class is the base class used for various search queries. - - \ingroup places-main - */ /*! diff --git a/src/location/places/qplacereview.cpp b/src/location/places/qplacereview.cpp index 0d66f810..71a514b4 100644 --- a/src/location/places/qplacereview.cpp +++ b/src/location/places/qplacereview.cpp @@ -78,12 +78,12 @@ bool QPlaceReviewPrivate::compare(const QPlaceContentPrivate *other) const /*! \class QPlaceReview - - \inmodule QPlaces + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 \brief The QPlaceReview class represents a review object. - Each QPlaceReview represents a review object with a number of attributes such as rating, review id, connected media etc. Each QPlaceReview is associated with place. @@ -92,8 +92,6 @@ bool QPlaceReviewPrivate::compare(const QPlaceContentPrivate *other) const associated to specific place but can not edit its content. User might also create new review. QPlaceReview is an in memory representation of a review object. - - \ingroup places-main */ diff --git a/src/location/places/qplacesearchreply.cpp b/src/location/places/qplacesearchreply.cpp index 5b47bfca..96d74a1e 100644 --- a/src/location/places/qplacesearchreply.cpp +++ b/src/location/places/qplacesearchreply.cpp @@ -58,13 +58,12 @@ QT_USE_NAMESPACE /*! \class QPlaceSearchReply + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 \brief The QPlaceSearchReply class manages a search operation started by an instance of QPlaceManager. - - \inmodule QtLocation - - \ingroup places-main */ /*! diff --git a/src/location/places/qplacesearchrequest.cpp b/src/location/places/qplacesearchrequest.cpp index f10832f8..1e57f00e 100644 --- a/src/location/places/qplacesearchrequest.cpp +++ b/src/location/places/qplacesearchrequest.cpp @@ -129,13 +129,11 @@ void QPlaceSearchRequestPrivate::clear() /*! \class QPlaceSearchRequest + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 - \inmodule Location - - \brief The QPlaceSearchRequest class represents the query parameters - of a search request. - - \ingroup places-main + \brief The QPlaceSearchRequest class represents the query parameters of a search request. The QPlaceSearchRequest class represents a query parameters object. Each QPlaceSearchRequest cointans search query parameters like search term. diff --git a/src/location/places/qplacesearchresult.cpp b/src/location/places/qplacesearchresult.cpp index f4eeec50..63fc1f72 100644 --- a/src/location/places/qplacesearchresult.cpp +++ b/src/location/places/qplacesearchresult.cpp @@ -72,13 +72,12 @@ bool QPlaceSearchResultPrivate::operator==(const QPlaceSearchResultPrivate &othe /*! \class QPlaceSearchResult - - \inmodule QPlaces + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 \brief The QPlaceSearchResult class represents a search result object. - \ingroup places-main - Each QPlaceSearchResult represents a place with a number of attributes such as distance, relevance, etc. */ diff --git a/src/location/places/qplacesupplier.cpp b/src/location/places/qplacesupplier.cpp index eec44468..73596435 100644 --- a/src/location/places/qplacesupplier.cpp +++ b/src/location/places/qplacesupplier.cpp @@ -73,15 +73,14 @@ bool QPlaceSupplierPrivate::operator==(const QPlaceSupplierPrivate &other) const /*! \class QPlaceSupplier - - \inmodule QPlaces + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 \brief The QPlaceSupplier class represents a supplier object. Each QPlaceSupplier represents a supplier object with a number of attributes such as name, icon etc. Each QPlaceSupplier is associated with place, media, review or description. - - \ingroup places-main */ /*! diff --git a/src/location/places/qplacetextpredictionreply.cpp b/src/location/places/qplacetextpredictionreply.cpp index 5a810309..4fc26007 100644 --- a/src/location/places/qplacetextpredictionreply.cpp +++ b/src/location/places/qplacetextpredictionreply.cpp @@ -57,13 +57,12 @@ QT_USE_NAMESPACE /*! \class QPlaceTextPredictionReply + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 \brief The QPlaceTextPredictionReply class manages a text prediction operation started by an instance of QPlaceManager. - - \inmodule QtLocation - - \ingroup places-main */ /*! diff --git a/src/location/places/qplaceuser.cpp b/src/location/places/qplaceuser.cpp index 9f7e6d83..6e80e87c 100644 --- a/src/location/places/qplaceuser.cpp +++ b/src/location/places/qplaceuser.cpp @@ -65,8 +65,9 @@ bool QPlaceUserPrivate::operator==(const QPlaceUserPrivate &other) const /*! \class QPlaceUser - - \inmodule QPlaces + \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 \brief The QPlaceUser class represents a user. diff --git a/src/location/qgeoaddress.cpp b/src/location/qgeoaddress.cpp index 1bf0d72b..6fd78163 100644 --- a/src/location/qgeoaddress.cpp +++ b/src/location/qgeoaddress.cpp @@ -73,11 +73,11 @@ QGeoAddressPrivate::~QGeoAddressPrivate() /*! \class QGeoAddress - \brief The QGeoAddress class represents an address - \inmodule QtLocation + \ingroup QtLocation-positioning + \since QtLocation 5.0 - \ingroup location + \brief The QGeoAddress class represents an address This class represents an address of a location. */ diff --git a/src/location/qgeoareamonitor.cpp b/src/location/qgeoareamonitor.cpp index f1615dad..ca603933 100644 --- a/src/location/qgeoareamonitor.cpp +++ b/src/location/qgeoareamonitor.cpp @@ -47,12 +47,12 @@ /*! \class QGeoAreaMonitor - \brief The QGeoAreaMonitor class enables the detection of proximity - changes for a specified set of coordinates. - \inmodule QtLocation + \ingroup QtLocation-positioning + \since QtLocation 5.0 - \ingroup location + \brief The QGeoAreaMonitor class enables the detection of proximity + changes for a specified set of coordinates. A QGeoAreaMonitor emits signals when the current position is in range, or has moved out of range, of a specified circular area. diff --git a/src/location/qgeoboundingarea.cpp b/src/location/qgeoboundingarea.cpp index 13496169..41666734 100644 --- a/src/location/qgeoboundingarea.cpp +++ b/src/location/qgeoboundingarea.cpp @@ -45,11 +45,11 @@ QT_BEGIN_NAMESPACE /*! \class QGeoBoundingArea - \brief The QGeoBoundingArea class defines a geographic area. - \inmodule QtLocation + \ingroup QtLocation-positioning + \since QtLocation 5.0 - \ingroup maps + \brief The QGeoBoundingArea class defines a geographic area. This class is the base class for classes which specify a geographic area. diff --git a/src/location/qgeoboundingbox.cpp b/src/location/qgeoboundingbox.cpp index 862453ff..73a714bb 100644 --- a/src/location/qgeoboundingbox.cpp +++ b/src/location/qgeoboundingbox.cpp @@ -49,11 +49,11 @@ QT_BEGIN_NAMESPACE /*! \class QGeoBoundingBox - \brief The QGeoBoundingBox class defines a rectangular geographic area. - \inmodule QtLocation + \ingroup QtLocation-positioning + \since QtLocation 5.0 - \ingroup maps + \brief The QGeoBoundingBox class defines a rectangular geographic area. The rectangle is defined in terms of a QGeoCoordinate which specifies the top left coordinate of the rectangle and a QGeoCoordinate which specifies diff --git a/src/location/qgeoboundingcircle.cpp b/src/location/qgeoboundingcircle.cpp index 259626b8..4cdcf6a8 100644 --- a/src/location/qgeoboundingcircle.cpp +++ b/src/location/qgeoboundingcircle.cpp @@ -51,11 +51,11 @@ QT_BEGIN_NAMESPACE /*! \class QGeoBoundingCircle - \brief The QGeoBoundingCircle class defines a circular geographic area. - \inmodule QtLocation + \ingroup QtLocation-positioning + \since QtLocation 5.0 - \ingroup maps + \brief The QGeoBoundingCircle class defines a circular geographic area. The circle is defined in terms of a QGeoCoordinate which specifies the center of the circle and a qreal which specifies the radius of the circle diff --git a/src/location/qgeocoordinate.cpp b/src/location/qgeocoordinate.cpp index 6e53d8fb..0467e51a 100644 --- a/src/location/qgeocoordinate.cpp +++ b/src/location/qgeocoordinate.cpp @@ -79,11 +79,11 @@ QGeoCoordinatePrivate::QGeoCoordinatePrivate() { /*! \class QGeoCoordinate - \brief The QGeoCoordinate class defines a geographical position on the surface of the Earth. - \inmodule QtLocation + \ingroup QtLocation-positioning + \since QtLocation 5.0 - \ingroup location + \brief The QGeoCoordinate class defines a geographical position on the surface of the Earth. A QGeoCoordinate is defined by latitude, longitude, and optionally, altitude. diff --git a/src/location/qgeolocation.cpp b/src/location/qgeolocation.cpp index 8ca90b6e..558c450a 100644 --- a/src/location/qgeolocation.cpp +++ b/src/location/qgeolocation.cpp @@ -73,8 +73,9 @@ bool QGeoLocationPrivate::operator==(const QGeoLocationPrivate &other) const /*! \class QGeoLocation - - \inmodule QPlaces + \inmodule QtLocation + \ingroup QtLocation-positioning + \since QtLocation 5.0 \brief The QGeoLocation class represents a location object. diff --git a/src/location/qgeopositioninfo.cpp b/src/location/qgeopositioninfo.cpp index 283f9bad..a388fca4 100644 --- a/src/location/qgeopositioninfo.cpp +++ b/src/location/qgeopositioninfo.cpp @@ -56,11 +56,11 @@ public: /*! \class QGeoPositionInfo - \brief The QGeoPositionInfo class contains information gathered on a global position, direction and velocity at a particular point in time. - \inmodule QtLocation + \ingroup QtLocation-positioning + \since QtLocation 5.0 - \ingroup location + \brief The QGeoPositionInfo class contains information gathered on a global position, direction and velocity at a particular point in time. A QGeoPositionInfo contains, at a minimum, a geographical coordinate and a timestamp. It may also have heading and speed measurements as well as diff --git a/src/location/qgeopositioninfosource.cpp b/src/location/qgeopositioninfosource.cpp index ec635e7a..aa5ab282 100644 --- a/src/location/qgeopositioninfosource.cpp +++ b/src/location/qgeopositioninfosource.cpp @@ -72,11 +72,11 @@ QT_BEGIN_NAMESPACE /*! \class QGeoPositionInfoSource - \brief The QGeoPositionInfoSource class is an abstract base class for the distribution of positional updates. - \inmodule QtLocation + \ingroup QtLocation-positioning + \since QtLocation 5.0 - \ingroup location + \brief The QGeoPositionInfoSource class is an abstract base class for the distribution of positional updates. The static function QGeoPositionInfoSource::createDefaultSource() creates a default position source that is appropriate for the platform, if one is available. diff --git a/src/location/qgeopositioninfosourcefactory.cpp b/src/location/qgeopositioninfosourcefactory.cpp index 90181c2f..6ccc4fe2 100644 --- a/src/location/qgeopositioninfosourcefactory.cpp +++ b/src/location/qgeopositioninfosourcefactory.cpp @@ -45,14 +45,13 @@ QT_BEGIN_NAMESPACE /*! \class QGeoPositionInfoSourceFactory + \inmodule QtLocation + \ingroup QtLocation-impl + \since QtLocation 5.0 \brief The QGeoPositionInfoSourceFactory class is a factory class used as the plugin interface for external providers of positioning data. - \inmodule QtLocation - - \ingroup location - Implementers must provide a unique combination of sourceName() and sourceVersion() per plugin. diff --git a/src/location/qgeosatelliteinfo.cpp b/src/location/qgeosatelliteinfo.cpp index 4e2cb2ee..bacf53a4 100644 --- a/src/location/qgeosatelliteinfo.cpp +++ b/src/location/qgeosatelliteinfo.cpp @@ -57,11 +57,11 @@ public: /*! \class QGeoSatelliteInfo - \brief The QGeoSatelliteInfo class contains basic information about a satellite. - \inmodule QtLocation + \ingroup QtLocation-positioning + \since QtLocation 5.0 - \ingroup location + \brief The QGeoSatelliteInfo class contains basic information about a satellite. \sa QGeoSatelliteInfoSource */ diff --git a/src/location/qgeosatelliteinfosource.cpp b/src/location/qgeosatelliteinfosource.cpp index d537fa4d..0d9b209f 100644 --- a/src/location/qgeosatelliteinfosource.cpp +++ b/src/location/qgeosatelliteinfosource.cpp @@ -216,11 +216,11 @@ void QGeoSatelliteInfoSourcePrivate::loadStaticPlugins(QHash<QString, QGeoPositi /*! \class QGeoSatelliteInfoSource - \brief The QGeoSatelliteInfoSource class is an abstract base class for the distribution of satellite information updates. - \inmodule QtLocation + \ingroup QtLocation-positioning + \since QtLocation 5.0 - \ingroup location + \brief The QGeoSatelliteInfoSource class is an abstract base class for the distribution of satellite information updates. The static function QGeoSatelliteInfoSource::createDefaultSource() creates a default satellite data source that is appropriate for the platform, if one is diff --git a/src/location/qnmeapositioninfosource.cpp b/src/location/qnmeapositioninfosource.cpp index 779d6b30..9e819963 100644 --- a/src/location/qnmeapositioninfosource.cpp +++ b/src/location/qnmeapositioninfosource.cpp @@ -426,11 +426,11 @@ void QNmeaPositionInfoSourcePrivate::emitUpdated(const QGeoPositionInfo &update) /*! \class QNmeaPositionInfoSource - \brief The QNmeaPositionInfoSource class provides positional information using a NMEA data source. - \inmodule QtLocation + \ingroup QtLocation-positioning + \since QtLocation 5.0 - \ingroup location + \brief The QNmeaPositionInfoSource class provides positional information using a NMEA data source. NMEA is a commonly used protocol for the specification of one's global position at a certain point in time. The QNmeaPositionInfoSource class reads NMEA diff --git a/src/location/qplace.cpp b/src/location/qplace.cpp index 02050d1c..b8ae333f 100644 --- a/src/location/qplace.cpp +++ b/src/location/qplace.cpp @@ -50,12 +50,11 @@ QT_BEGIN_NAMESPACE /*! \class QPlace - \brief The QPlace class represents basic information about a place. - \inmodule QtLocation + \ingroup QtLocation-places + \since QtLocation 5.0 - \ingroup location - \ingroup places-main + \brief The QPlace class represents basic information about a place. */ /*! diff --git a/src/location/qtlocation.cpp b/src/location/qtlocation.cpp index 0d510039..3e039c74 100644 --- a/src/location/qtlocation.cpp +++ b/src/location/qtlocation.cpp @@ -44,6 +44,16 @@ QT_BEGIN_NAMESPACE namespace QtLocation { + +/*! + \namespace QtLocation + \inmodule QtLocation + \target QtLocation Namespace + + \brief The QtLocation namespace contains miscellaneous identifiers used throughout the + QtLocation module. +*/ + /*! \enum QtLocation::Visibility |