From af00ab8e9909b80c03550694d567679fe28b00ca Mon Sep 17 00:00:00 2001 From: Peter Yard Date: Wed, 22 Feb 2012 15:14:18 +1000 Subject: Docs: QtLocation typos QTBUG-24066. Change-Id: If135730ef1cf775debfcf530ca960df718b76994 Reviewed-by: Alex Reviewed-by: Natalia Shubina --- doc/src/qtlocation.qdoc | 2 +- src/imports/location/declarativeplaces/qdeclarativeplace.cpp | 12 ++++++------ .../declarativeplaces/qdeclarativerecommendationmodel.cpp | 2 +- .../declarativeplaces/qdeclarativesearchresultmodel.cpp | 2 +- src/imports/location/qdeclarativegeomaneuver.cpp | 4 ++-- src/imports/location/qdeclarativegeomap.cpp | 6 +++--- src/location/maps/qgeomappingmanagerengine.cpp | 2 +- src/location/maps/qgeotiledmapreply.cpp | 4 ++-- src/location/places/qplaceattribute.cpp | 2 +- src/location/places/qplacecontentrequest.cpp | 2 +- src/location/places/qplacemanager.cpp | 4 ++-- src/location/places/qplacematchrequest.cpp | 2 +- src/location/places/qplacesearchrequest.cpp | 4 ++-- src/location/places/qplacesearchresult.cpp | 2 +- src/location/qgeoboundingbox.cpp | 2 +- 15 files changed, 26 insertions(+), 26 deletions(-) diff --git a/doc/src/qtlocation.qdoc b/doc/src/qtlocation.qdoc index 1c4df86c..477bf398 100644 --- a/doc/src/qtlocation.qdoc +++ b/doc/src/qtlocation.qdoc @@ -57,7 +57,7 @@ the natural complement to Positioning, providing a source of geographic data about places of interest (POIs). As well as providing the location, size and other vitals about a POI, the Places API can also retrieve images, reviews and other rich content, and integrate with platform sources of -a user's favourites. +a user's favorites. \table \row \o Places introduction & overview: diff --git a/src/imports/location/declarativeplaces/qdeclarativeplace.cpp b/src/imports/location/declarativeplaces/qdeclarativeplace.cpp index b43fc41f..06ae6962 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplace.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplace.cpp @@ -149,7 +149,7 @@ QT_USE_NAMESPACE \section2 Favorites The Places API supports the concept of favorites. Favorites are generally implemented - by using two plugins, the first plugin is typically a r/o source of places(origin plugin) and a second + by using two plugins, the first plugin is typically a r/o source of places (origin plugin) and a second r/w plugin (destination plugin) is used to store places from the origin as favorites. Each Place has a favorite property which is intended to contain the corresponding place @@ -544,7 +544,7 @@ QString QDeclarativePlace::name() const This property holds the unique identifier of the place. The place id is only meaningful to the \l Plugin that generated it and is not transferable between \l {Plugin}{Plugins}. The place id - is not guarinteed to be universally unique, but unique within the \l Plugin that generated it. + is not guaranteed to be universally unique, but unique within the \l Plugin that generated it. If only the place id is known, all other place data can fetched from the \l Plugin. @@ -609,7 +609,7 @@ bool QDeclarativePlace::detailsFetched() const the place. \row \o Place.Saving - \o The place is currently being saved, no other operations may be perfomed until + \o The place is currently being saved, no other operation may be performed until complete. \row \o Place.Fetching @@ -718,9 +718,9 @@ void QDeclarativePlace::contactsModified(const QString &key, const QVariant &val /*! \qmlmethod void Place::getDetails() - This methods starts fetching place details. + This method starts fetching place details. - The \l status property will change to Place.Fetching while the fetch is in progress. On + The \l status property will change to Place. Fetching while the fetch is in progress. On success the element properties will be updated, \l status will be set to Place.Ready and \l detailsFetched will be set to true. On error \l status will be set to Place.Error. The \l errorString() method can be used to get the details of the error. @@ -1067,7 +1067,7 @@ void QDeclarativePlace::synchronizeContacts() /* Helper function to emit the signals for the primary___() fields. It is expected that the values of the primary___() - functions have alread been modified to new values. + functions have already been modified to new values. */ void QDeclarativePlace::primarySignalsEmission(const QString &type) { diff --git a/src/imports/location/declarativeplaces/qdeclarativerecommendationmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativerecommendationmodel.cpp index 9d6e025c..8c633aa6 100644 --- a/src/imports/location/declarativeplaces/qdeclarativerecommendationmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativerecommendationmodel.cpp @@ -232,7 +232,7 @@ void QDeclarativeRecommendationModel::setPlaceId(const QString &placeId) /*! \qmlproperty string PlaceRecommendationModel::count - This properties holds the number of results the model has. + This property holds the number of results the model has. */ /*! diff --git a/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp index 52a0bec5..13d744e3 100644 --- a/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativesearchresultmodel.cpp @@ -472,7 +472,7 @@ void QDeclarativeSearchResultModel::initializePlugin(QDeclarativeGeoServiceProvi /*! \qmlproperty string PlaceSearchModel::count - This properties holds the number of results the model has. + This property holds the number of results the model has. */ void QDeclarativeSearchResultModel::placeUpdated(const QString &placeId) diff --git a/src/imports/location/qdeclarativegeomaneuver.cpp b/src/imports/location/qdeclarativegeomaneuver.cpp index b64e9fce..d407346b 100644 --- a/src/imports/location/qdeclarativegeomaneuver.cpp +++ b/src/imports/location/qdeclarativegeomaneuver.cpp @@ -185,8 +185,8 @@ QDeclarativeCoordinate* QDeclarativeGeoManeuver::waypoint() const /*! \qmlproperty bool RouteManeuver::waypointValid - This read-only property holds whether this the \l waypoint associated with this - maneuver is valid. + This read-only property holds whether this \l waypoint, associated with this + maneuver, is valid or not. */ bool QDeclarativeGeoManeuver::waypointValid() const diff --git a/src/imports/location/qdeclarativegeomap.cpp b/src/imports/location/qdeclarativegeomap.cpp index ed31b148..9b1b8b6b 100644 --- a/src/imports/location/qdeclarativegeomap.cpp +++ b/src/imports/location/qdeclarativegeomap.cpp @@ -867,13 +867,13 @@ void QDeclarativeGeoMap::wheelEvent(QWheelEvent *event) Adds the given MapItem to the Map (e.g. MapQuickItem, MapCircle). If the object already is on the Map, it will not be added again. - As an example, consider you have a MapCircle presenting your current position: + As an example, consider the case where you have a MapCircle representing your current position: \snippet TODO You can add it to Map (alternatively it can be defined as a child element of the Map): \snippet TODO - Note: MapItemViews can not be added with this method. + Note: MapItemViews cannot be added with this method. */ void QDeclarativeGeoMap::addMapItem(QDeclarativeGeoMapItemBase *item) @@ -916,7 +916,7 @@ void QDeclarativeGeoMap::removeMapItem(QDeclarativeGeoMapItemBase *item) updateMutex_.lock(); item->setParentItem(0); item->setMap(0, 0); - // these can be optmized for perf, as we already check the 'contains' above + // these can be optimized for perf, as we already check the 'contains' above mapItems_.removeOne(item); emit mapItemsChanged(); updateMutex_.unlock(); diff --git a/src/location/maps/qgeomappingmanagerengine.cpp b/src/location/maps/qgeomappingmanagerengine.cpp index d424c8e2..3626e94c 100644 --- a/src/location/maps/qgeomappingmanagerengine.cpp +++ b/src/location/maps/qgeomappingmanagerengine.cpp @@ -377,7 +377,7 @@ QGeoCameraCapabilities QGeoMappingManagerEngine::cameraCapabilities() const } /*! - Sets the locale to be used by the this manager to \a locale. + Sets the locale to be used by this manager to \a locale. If this mapping manager supports returning map labels in different languages, they will be returned in the language of \a locale. diff --git a/src/location/maps/qgeotiledmapreply.cpp b/src/location/maps/qgeotiledmapreply.cpp index 5a069f66..af7c5f81 100644 --- a/src/location/maps/qgeotiledmapreply.cpp +++ b/src/location/maps/qgeotiledmapreply.cpp @@ -84,7 +84,7 @@ QT_BEGIN_NAMESPACE \value CommunicationError An error occurred while communicating with the service provider. \value ParseError - The response from the service provider was in an unrecognizable format. + The response from the service provider was in an unrecognizable format supported by the service provider. \value UnknownError An error occurred which does not fit into any of the other categories. @@ -146,7 +146,7 @@ bool QGeoTiledMapReply::isFinished() const Sets the error state of this reply to \a error and the textual representation of the error to \a errorString. - This wil also cause error() and finished() signals to be emitted, in that + This will also cause error() and finished() signals to be emitted, in that order. */ void QGeoTiledMapReply::setError(QGeoTiledMapReply::Error error, const QString &errorString) diff --git a/src/location/places/qplaceattribute.cpp b/src/location/places/qplaceattribute.cpp index 569a4176..b96a9428 100644 --- a/src/location/places/qplaceattribute.cpp +++ b/src/location/places/qplaceattribute.cpp @@ -88,7 +88,7 @@ bool QPlaceAttributePrivate::operator== (const QPlaceAttributePrivate &other) co \endlist There is a class of attribute types of the format x_id_ e.g. x_id_nokia. - This class of attributes are alternative ids of the place, from the specified provider's + This class of attributes is a set of alternative ids of the place, from the specified provider's perspective. The above types are used to access and modify attributes in QPlace via: diff --git a/src/location/places/qplacecontentrequest.cpp b/src/location/places/qplacecontentrequest.cpp index d8f5dbf7..c6ca3a5e 100644 --- a/src/location/places/qplacecontentrequest.cpp +++ b/src/location/places/qplacecontentrequest.cpp @@ -97,7 +97,7 @@ void QPlaceContentRequestPrivate::clear() */ /*! - Constructs an new request object. + Constructs a new request object. */ QPlaceContentRequest::QPlaceContentRequest() : d_ptr(new QPlaceContentRequestPrivate()) diff --git a/src/location/places/qplacemanager.cpp b/src/location/places/qplacemanager.cpp index 1c838a5b..158c8bae 100644 --- a/src/location/places/qplacemanager.cpp +++ b/src/location/places/qplacemanager.cpp @@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE \o Description \row \o Searching for places - \o Using set of parameters such as a seach term and search area, relevant places + \o Using set of parameters such as a search term and search area, relevant places can be returned to the user. \row \o Categories @@ -358,7 +358,7 @@ QList QPlaceManager::childCategories(const QString &parentId) co Support for locales may vary from provider to provider. For those that do support it, by default, the global default locale is set as the manager's only locale. If the manager - has no locales assigned to it, it impliclty uses the global default locale. + has no locales assigned to it, it implicitly uses the global default locale. For managers that do not support locales, the locale list is always empty. */ QList QPlaceManager::locales() const diff --git a/src/location/places/qplacematchrequest.cpp b/src/location/places/qplacematchrequest.cpp index 41bb9726..128a5323 100644 --- a/src/location/places/qplacematchrequest.cpp +++ b/src/location/places/qplacematchrequest.cpp @@ -128,7 +128,7 @@ void QPlaceMatchRequestPrivate::clear() const QString QPlaceMatchRequest::AlternativeId(QLatin1String("alternativeId")); /*! - Default constructor. Constructs an new request object. + Default constructor. Constructs a new request object. */ QPlaceMatchRequest::QPlaceMatchRequest() : d_ptr(new QPlaceMatchRequestPrivate()) diff --git a/src/location/places/qplacesearchrequest.cpp b/src/location/places/qplacesearchrequest.cpp index 2403bae8..64596f1d 100644 --- a/src/location/places/qplacesearchrequest.cpp +++ b/src/location/places/qplacesearchrequest.cpp @@ -339,7 +339,7 @@ QtLocation::VisibilityScope QPlaceSearchRequest::visibilityScope() const } /*! - Sets the visibiliy \a scope used when searching for places. + Sets the visibility \a scope used when searching for places. */ void QPlaceSearchRequest::setVisibilityScope(QtLocation::VisibilityScope scope) { @@ -349,7 +349,7 @@ void QPlaceSearchRequest::setVisibilityScope(QtLocation::VisibilityScope scope) /*! Returns the relevance hint of the request. The hint is given to the provider - to help but not dictate the ranking of results. eg providng a distance hint + to help but not dictate the ranking of results. e.g. providing a distance hint may give closer places a higher ranking but it doesn't necessarily mean that he results will be ordered strictly according to distance. */ diff --git a/src/location/places/qplacesearchresult.cpp b/src/location/places/qplacesearchresult.cpp index ecf9ab41..4e6d1d4c 100644 --- a/src/location/places/qplacesearchresult.cpp +++ b/src/location/places/qplacesearchresult.cpp @@ -104,7 +104,7 @@ bool QPlaceSearchResultPrivate::operator==(const QPlaceSearchResultPrivate &othe */ /*! - Constructs an new search result. + Constructs a new search result. */ QPlaceSearchResult::QPlaceSearchResult() : d(new QPlaceSearchResultPrivate) diff --git a/src/location/qgeoboundingbox.cpp b/src/location/qgeoboundingbox.cpp index b394aea9..2aea005e 100644 --- a/src/location/qgeoboundingbox.cpp +++ b/src/location/qgeoboundingbox.cpp @@ -452,7 +452,7 @@ double QGeoBoundingBox::width() const If the change in height would cause the bounding box to cross a pole the height is adjusted such that the bounding box only touches the pole. - This changes is done such that the center coordinate is still at the + This change is done such that the center coordinate is still at the center of the bounding box, which may result in a bounding box with a smaller height than might otherwise be expected. -- cgit v1.2.1