summaryrefslogtreecommitdiffstats
path: root/src/location
diff options
context:
space:
mode:
authorWolfgang Beck <wolfgang.beck@nokia.com>2012-03-27 13:49:25 +1000
committerQt by Nokia <qt-info@nokia.com>2012-03-29 06:53:38 +0200
commit04921a0ff8c3a6878a77eb6e119ba6a870b2798a (patch)
tree0c1f262499bb90374cfff1d1bc0e7233d490bcee /src/location
parent2106a31b66afc25917935046d2e3be14488d4dc5 (diff)
General documentation issues
Change-Id: I021ab70e1cbb973817aecbf53b7af0760c5e36c4 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
Diffstat (limited to 'src/location')
-rw-r--r--src/location/maps/qgeocameracapabilities.cpp2
-rw-r--r--src/location/maps/qgeocodereply.cpp2
-rw-r--r--src/location/maps/qgeocodingmanager.cpp2
-rw-r--r--src/location/maps/qgeocodingmanagerengine.cpp2
-rw-r--r--src/location/maps/qgeomaneuver.cpp2
-rw-r--r--src/location/maps/qgeomappingmanager.cpp2
-rw-r--r--src/location/maps/qgeomappingmanagerengine.cpp2
-rw-r--r--src/location/maps/qgeoroute.cpp12
-rw-r--r--src/location/maps/qgeoroutereply.cpp2
-rw-r--r--src/location/maps/qgeorouterequest.cpp2
-rw-r--r--src/location/maps/qgeoroutesegment.cpp2
-rw-r--r--src/location/maps/qgeoroutingmanager.cpp2
-rw-r--r--src/location/maps/qgeoroutingmanagerengine.cpp2
-rw-r--r--src/location/maps/qgeoserviceprovider.cpp2
-rw-r--r--src/location/maps/qgeoserviceproviderfactory.cpp2
-rw-r--r--src/location/maps/qgeotiledmapreply.cpp2
-rw-r--r--src/location/places/qplace.cpp14
-rw-r--r--src/location/places/qplace.h2
-rw-r--r--src/location/places/qplaceattribute.cpp8
-rw-r--r--src/location/places/qplacecategory.cpp12
-rw-r--r--src/location/places/qplacecategory.h2
-rw-r--r--src/location/places/qplacecontent.cpp4
-rw-r--r--src/location/places/qplacecontentreply.cpp2
-rw-r--r--src/location/places/qplacecontentrequest.cpp4
-rw-r--r--src/location/places/qplacedetailsreply.cpp2
-rw-r--r--src/location/places/qplaceeditorial.cpp2
-rw-r--r--src/location/places/qplaceicon.cpp2
-rw-r--r--src/location/places/qplaceidreply.cpp26
-rw-r--r--src/location/places/qplaceidreply.h2
-rw-r--r--src/location/places/qplaceimage.cpp12
-rw-r--r--src/location/places/qplaceimage.h2
-rw-r--r--src/location/places/qplacemanager.cpp16
-rw-r--r--src/location/places/qplacemanagerengine.cpp8
-rw-r--r--src/location/places/qplacematchreply.cpp2
-rw-r--r--src/location/places/qplacematchrequest.cpp8
-rw-r--r--src/location/places/qplaceratings.cpp2
-rw-r--r--src/location/places/qplacereply.cpp6
-rw-r--r--src/location/places/qplacereview.cpp10
-rw-r--r--src/location/places/qplacereview.h2
-rw-r--r--src/location/places/qplacesearchreply.cpp2
-rw-r--r--src/location/places/qplacesearchrequest.cpp10
-rw-r--r--src/location/places/qplacesearchresult.cpp2
-rw-r--r--src/location/places/qplacesearchsuggestionreply.cpp2
-rw-r--r--src/location/places/qplacesupplier.cpp10
-rw-r--r--src/location/places/qplacesupplier.h2
-rw-r--r--src/location/places/qplaceuser.cpp10
-rw-r--r--src/location/places/qplaceuser.h2
-rw-r--r--src/location/qgeoaddress.cpp18
-rw-r--r--src/location/qgeoareamonitor.cpp2
-rw-r--r--src/location/qgeoboundingarea.cpp2
-rw-r--r--src/location/qgeoboundingbox.cpp2
-rw-r--r--src/location/qgeoboundingcircle.cpp2
-rw-r--r--src/location/qgeocoordinate.cpp2
-rw-r--r--src/location/qgeolocation.cpp2
-rw-r--r--src/location/qgeopositioninfo.cpp2
-rw-r--r--src/location/qgeopositioninfosource.cpp6
-rw-r--r--src/location/qgeopositioninfosourcefactory.cpp2
-rw-r--r--src/location/qgeosatelliteinfo.cpp18
-rw-r--r--src/location/qgeosatelliteinfosource.cpp4
-rw-r--r--src/location/qlocationutils_p.h2
-rw-r--r--src/location/qnmeapositioninfosource.cpp2
61 files changed, 149 insertions, 149 deletions
diff --git a/src/location/maps/qgeocameracapabilities.cpp b/src/location/maps/qgeocameracapabilities.cpp
index 4cafb418..da82f864 100644
--- a/src/location/maps/qgeocameracapabilities.cpp
+++ b/src/location/maps/qgeocameracapabilities.cpp
@@ -109,7 +109,7 @@ QGeoCameraCapabilitiesPrivate& QGeoCameraCapabilitiesPrivate::operator = (const
\class QGeoCameraCapabilities
\inmodule QtLocation
\ingroup QtLocation-impl
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoCameraCapabilities class describes the limitations on camera settings imposed by a mapping plugin.
diff --git a/src/location/maps/qgeocodereply.cpp b/src/location/maps/qgeocodereply.cpp
index 75ad6809..9fa6dfea 100644
--- a/src/location/maps/qgeocodereply.cpp
+++ b/src/location/maps/qgeocodereply.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
\class QGeocodeReply
\inmodule QtLocation
\ingroup QtLocation-geocoding
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeocodeReply class manages an operation started by an
instance of QGeocodingManager.
diff --git a/src/location/maps/qgeocodingmanager.cpp b/src/location/maps/qgeocodingmanager.cpp
index cb4bc3f7..8f68db72 100644
--- a/src/location/maps/qgeocodingmanager.cpp
+++ b/src/location/maps/qgeocodingmanager.cpp
@@ -54,7 +54,7 @@ QT_BEGIN_NAMESPACE
\class QGeocodingManager
\inmodule QtLocation
\ingroup QtLocation-geocoding
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeocodingManager class provides support for geocoding
operations.
diff --git a/src/location/maps/qgeocodingmanagerengine.cpp b/src/location/maps/qgeocodingmanagerengine.cpp
index b4478e29..2dc5f316 100644
--- a/src/location/maps/qgeocodingmanagerengine.cpp
+++ b/src/location/maps/qgeocodingmanagerengine.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
\class QGeocodingManagerEngine
\inmodule QtLocation
\ingroup QtLocation-impl
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeocodingManagerEngine class provides an interface and
convenience methods to implementers of QGeoServiceProvider plugins who want
diff --git a/src/location/maps/qgeomaneuver.cpp b/src/location/maps/qgeomaneuver.cpp
index ec188e6f..50b5e56c 100644
--- a/src/location/maps/qgeomaneuver.cpp
+++ b/src/location/maps/qgeomaneuver.cpp
@@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE
\class QGeoManeuver
\inmodule QtLocation
\ingroup QtLocation-routing
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoManeuver class represents the information relevant to the
point at which two QGeoRouteSegments meet.
diff --git a/src/location/maps/qgeomappingmanager.cpp b/src/location/maps/qgeomappingmanager.cpp
index d142fa37..abfc47ea 100644
--- a/src/location/maps/qgeomappingmanager.cpp
+++ b/src/location/maps/qgeomappingmanager.cpp
@@ -58,7 +58,7 @@ QT_BEGIN_NAMESPACE
\class QGeoMappingManager
\inmodule QtLocation
\ingroup QtLocation-maps
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoMappingManager class provides support for displaying
and interacting with maps.
diff --git a/src/location/maps/qgeomappingmanagerengine.cpp b/src/location/maps/qgeomappingmanagerengine.cpp
index a91cdd64..d476c835 100644
--- a/src/location/maps/qgeomappingmanagerengine.cpp
+++ b/src/location/maps/qgeomappingmanagerengine.cpp
@@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE
\class QGeoMappingManagerEngine
\inmodule QtLocation
\ingroup QtLocation-impl
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoMappingManagerEngine class provides an interface and convenience methods
to implementors of QGeoServiceProvider plugins who want to provide support for displaying
diff --git a/src/location/maps/qgeoroute.cpp b/src/location/maps/qgeoroute.cpp
index bc8a38a1..a641a1de 100644
--- a/src/location/maps/qgeoroute.cpp
+++ b/src/location/maps/qgeoroute.cpp
@@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE
\class QGeoRoute
\inmodule QtLocation
\ingroup QtLocation-routing
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoRoute class represents a route between two points.
@@ -118,11 +118,11 @@ bool QGeoRoute::operator !=(const QGeoRoute &other) const
}
/*!
- Sets the ID of this route to \a id.
+ Sets the identifier of this route to \a id.
Service providers which support the updating of routes commonly assign
- IDs to routes. If this route came from such a service provider changing
- the ID will probably cause route updates to stop working.
+ identifiers to routes. If this route came from such a service provider changing
+ the identifier will probably cause route updates to stop working.
*/
void QGeoRoute::setRouteId(const QString &id)
{
@@ -130,10 +130,10 @@ void QGeoRoute::setRouteId(const QString &id)
}
/*!
- Returns the ID of this route.
+ Returns the identifier of this route.
Service providers which support the updating of routes commonly assign
- IDs to routes. If this route did not come from such a service provider
+ identifiers to routes. If this route did not come from such a service provider
the function will return an empty string.
*/
QString QGeoRoute::routeId() const
diff --git a/src/location/maps/qgeoroutereply.cpp b/src/location/maps/qgeoroutereply.cpp
index f5264384..730100cd 100644
--- a/src/location/maps/qgeoroutereply.cpp
+++ b/src/location/maps/qgeoroutereply.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
\class QGeoRouteReply
\inmodule QtLocation
\ingroup QtLocation-routing
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoRouteReply class manages an operation started by an instance
of QGeoRoutingManager.
diff --git a/src/location/maps/qgeorouterequest.cpp b/src/location/maps/qgeorouterequest.cpp
index 7e0eacee..2f9f3d39 100644
--- a/src/location/maps/qgeorouterequest.cpp
+++ b/src/location/maps/qgeorouterequest.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
\class QGeoRouteRequest
\inmodule QtLocation
\ingroup QtLocation-routing
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoRouteRequest class represents the parameters and restrictions
which define a request for routing information.
diff --git a/src/location/maps/qgeoroutesegment.cpp b/src/location/maps/qgeoroutesegment.cpp
index 73a893ec..653dccd1 100644
--- a/src/location/maps/qgeoroutesegment.cpp
+++ b/src/location/maps/qgeoroutesegment.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
\class QGeoRouteSegment
\inmodule QtLocation
\ingroup QtLocation-routing
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoRouteSegment class represents a segment of a route.
diff --git a/src/location/maps/qgeoroutingmanager.cpp b/src/location/maps/qgeoroutingmanager.cpp
index 6d5e5acc..e74bdbab 100644
--- a/src/location/maps/qgeoroutingmanager.cpp
+++ b/src/location/maps/qgeoroutingmanager.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
\class QGeoRoutingManager
\inmodule QtLocation
\ingroup QtLocation-routing
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoRoutingManager class provides support for geographic routing
operations.
diff --git a/src/location/maps/qgeoroutingmanagerengine.cpp b/src/location/maps/qgeoroutingmanagerengine.cpp
index d6f64e2c..416de09d 100644
--- a/src/location/maps/qgeoroutingmanagerengine.cpp
+++ b/src/location/maps/qgeoroutingmanagerengine.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
\class QGeoRoutingManagerEngine
\inmodule QtLocation
\ingroup QtLocation-impl
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoRoutingManagerEngine class provides an interface and
convenience methods to implementers of QGeoServiceProvider plugins who want
diff --git a/src/location/maps/qgeoserviceprovider.cpp b/src/location/maps/qgeoserviceprovider.cpp
index d4ef4582..fa337aed 100644
--- a/src/location/maps/qgeoserviceprovider.cpp
+++ b/src/location/maps/qgeoserviceprovider.cpp
@@ -81,7 +81,7 @@ Q_GLOBAL_STATIC_WITH_ARGS(QFactoryLoader, loader,
\class QGeoServiceProvider
\inmodule QtLocation
\ingroup QtLocation-common
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoServiceProvider class aggregates access to services which provide
geographical information.
diff --git a/src/location/maps/qgeoserviceproviderfactory.cpp b/src/location/maps/qgeoserviceproviderfactory.cpp
index 6761d762..30e072af 100644
--- a/src/location/maps/qgeoserviceproviderfactory.cpp
+++ b/src/location/maps/qgeoserviceproviderfactory.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
\class QGeoServiceProviderFactory
\inmodule QtLocation
\ingroup QtLocation-impl
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoServiceProviderFactory class is a factory class used as the
plugin interface for services related to geographical information.
diff --git a/src/location/maps/qgeotiledmapreply.cpp b/src/location/maps/qgeotiledmapreply.cpp
index af7c5f81..736648dd 100644
--- a/src/location/maps/qgeotiledmapreply.cpp
+++ b/src/location/maps/qgeotiledmapreply.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
\class QGeoTiledMapReply
\inmodule QtLocation
\ingroup QtLocation-impl
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoTiledMapReply class manages a tile fetch operation started
by an instance of QGeoTiledManagerEngine.
diff --git a/src/location/places/qplace.cpp b/src/location/places/qplace.cpp
index e7cfbcce..9ce10e3d 100644
--- a/src/location/places/qplace.cpp
+++ b/src/location/places/qplace.cpp
@@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-data
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlace class represents a set of data about a place.
@@ -340,8 +340,8 @@ void QPlace::setName(const QString &name)
}
/*!
- Returns the id of the place. The place id is only meaningful to the QPlaceManager that
- generated it and is not transferable between managers. The place id is not guaranteed
+ Returns the identifier of the place. The place identifier is only meaningful to the QPlaceManager that
+ generated it and is not transferable between managers. The place identifier is not guaranteed
to be universally unique, but unique for the manager that generated it.
*/
QString QPlace::placeId() const
@@ -351,12 +351,12 @@ QString QPlace::placeId() const
}
/*!
- Sets the \a id of the place.
+ Sets the \a identifier of the place.
*/
-void QPlace::setPlaceId(const QString &id)
+void QPlace::setPlaceId(const QString &identifier)
{
Q_D(QPlace);
- d->placeId = id;
+ d->placeId = identifier;
}
/*!
@@ -497,7 +497,7 @@ QPlaceAttribute QPlace::extendedAttribute(const QString &attributeType) const
already exists in the place, then it is overwritten.
If \a attribute is a default constructed QPlaceAttribute, then the \a attributeType
- is removed from the place i.e it will not be listed by QPlace::extendedAttributeTypes().
+ is removed from the place which means it will not be listed by QPlace::extendedAttributeTypes().
*/
void QPlace::setExtendedAttribute(const QString &attributeType,
const QPlaceAttribute &attribute)
diff --git a/src/location/places/qplace.h b/src/location/places/qplace.h
index 2de45693..c3bfc34d 100644
--- a/src/location/places/qplace.h
+++ b/src/location/places/qplace.h
@@ -104,7 +104,7 @@ public:
QString name() const;
void setName(const QString &name);
QString placeId() const;
- void setPlaceId(const QString &placeId);
+ void setPlaceId(const QString &identifier);
QString primaryPhone() const;
QString primaryFax() const;
diff --git a/src/location/places/qplaceattribute.cpp b/src/location/places/qplaceattribute.cpp
index caa09f69..c210697f 100644
--- a/src/location/places/qplaceattribute.cpp
+++ b/src/location/places/qplaceattribute.cpp
@@ -77,7 +77,7 @@ bool QPlaceAttributePrivate::isEmpty() const
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-data
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceAttribute class represents generic attribute information about a place.
@@ -94,8 +94,8 @@ bool QPlaceAttributePrivate::isEmpty() const
\li QPlaceAttribute::Provider
\endlist
- There is a class of attribute types of the format x_id_<provider> e.g. x_id_nokia.
- This class of attributes is a set of alternative ids of the place, from the specified provider's
+ There is a class of attribute types of the format x_id_<provider> for example x_id_nokia.
+ This class of attributes is a set of alternative identifiers of the place, from the specified provider's
perspective.
The above types are used to access and modify attributes in QPlace via:
@@ -110,7 +110,7 @@ bool QPlaceAttributePrivate::isEmpty() const
new attributes as necessary. Custom attribute types should always be prefixed
by a qualifier in order to avoid conflicts.
- \section3 User readable vs non-user readable attributes
+ \section3 User Readable vs Non-User Readable Attributes
Some attributes may not be intended to be readable by end users, the label field
of such attributes are empty to indicate this fact.
*/
diff --git a/src/location/places/qplacecategory.cpp b/src/location/places/qplacecategory.cpp
index a33d5d68..fb7c8b67 100644
--- a/src/location/places/qplacecategory.cpp
+++ b/src/location/places/qplacecategory.cpp
@@ -80,7 +80,7 @@ bool QPlaceCategoryPrivate::isEmpty() const
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-data
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceCategory class represents a category that a \l QPlace can be associated with.
@@ -143,8 +143,8 @@ bool QPlaceCategory::operator==(const QPlaceCategory &other) const
}
/*!
- Returns the id of the category. The category id is a string which uniquely identifies this category
- within a particular \l QPlaceManager. The id is only meaningful to the QPlaceManager
+ Returns the identifier of the category. The category identifier is a string which uniquely identifies this category
+ within a particular \l QPlaceManager. The identifier is only meaningful to the QPlaceManager
that generated it and is not transferable between managers.
*/
QString QPlaceCategory::categoryId() const
@@ -153,11 +153,11 @@ QString QPlaceCategory::categoryId() const
}
/*!
- Sets the \a id of the category.
+ Sets the \a identifier of the category.
*/
-void QPlaceCategory::setCategoryId(const QString &id)
+void QPlaceCategory::setCategoryId(const QString &identifier)
{
- d->categoryId = id;
+ d->categoryId = identifier;
}
/*!
diff --git a/src/location/places/qplacecategory.h b/src/location/places/qplacecategory.h
index b0da859a..e661e6c3 100644
--- a/src/location/places/qplacecategory.h
+++ b/src/location/places/qplacecategory.h
@@ -74,7 +74,7 @@ public:
}
QString categoryId() const;
- void setCategoryId(const QString &id);
+ void setCategoryId(const QString &identifier);
QString name() const;
void setName(const QString &name);
diff --git a/src/location/places/qplacecontent.cpp b/src/location/places/qplacecontent.cpp
index 9d839386..0916ca12 100644
--- a/src/location/places/qplacecontent.cpp
+++ b/src/location/places/qplacecontent.cpp
@@ -75,7 +75,7 @@ bool QPlaceContentPrivate::compare(const QPlaceContentPrivate *other) const
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-data
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceContent class serves as the base class for rich content types.
@@ -112,7 +112,7 @@ bool QPlaceContentPrivate::compare(const QPlaceContentPrivate *other) const
index of the content. The value is the content object itself.
The \c {Collection} is intended to be a container where content items, that have been retrieved
- as pages, can be stored. This enables a developer to skip pages, e.g. indexes 0-9 may be
+ as pages, can be stored. This enables a developer to skip pages, for example indexes 0-9 may be
stored in the collection, if the user skips to indexes 80-99, these can be stored in the
collection as well.
*/
diff --git a/src/location/places/qplacecontentreply.cpp b/src/location/places/qplacecontentreply.cpp
index 4a17fd22..b74dc236 100644
--- a/src/location/places/qplacecontentreply.cpp
+++ b/src/location/places/qplacecontentreply.cpp
@@ -64,7 +64,7 @@ QT_USE_NAMESPACE
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-replies
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceContentReply class manages a content retrieval operation started by an
instance of QPlaceManager.
diff --git a/src/location/places/qplacecontentrequest.cpp b/src/location/places/qplacecontentrequest.cpp
index c6ca3a5e..00ca77f0 100644
--- a/src/location/places/qplacecontentrequest.cpp
+++ b/src/location/places/qplacecontentrequest.cpp
@@ -80,7 +80,7 @@ void QPlaceContentRequestPrivate::clear()
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-requests
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceContentRequest class represents the parameters of a content request.
@@ -150,7 +150,7 @@ bool QPlaceContentRequest::operator!= (const QPlaceContentRequest &other) const
}
/*!
- Returns the type of content to be requested, e.g. reviews or images
+ Returns the type of content to be requested, for example reviews or images
*/
QPlaceContent::Type QPlaceContentRequest::contentType() const
{
diff --git a/src/location/places/qplacedetailsreply.cpp b/src/location/places/qplacedetailsreply.cpp
index 2ac69ec6..a1984fdd 100644
--- a/src/location/places/qplacedetailsreply.cpp
+++ b/src/location/places/qplacedetailsreply.cpp
@@ -60,7 +60,7 @@ QT_USE_NAMESPACE
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-replies
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceDetailsReply class manages a place details fetch operation started by an
instance of QPlaceManager.
diff --git a/src/location/places/qplaceeditorial.cpp b/src/location/places/qplaceeditorial.cpp
index a88e715c..dcf53752 100644
--- a/src/location/places/qplaceeditorial.cpp
+++ b/src/location/places/qplaceeditorial.cpp
@@ -73,7 +73,7 @@ bool QPlaceEditorialPrivate::compare(const QPlaceContentPrivate *other) const
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-data
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceEditorial class represents a publisher's article describing a place.
diff --git a/src/location/places/qplaceicon.cpp b/src/location/places/qplaceicon.cpp
index 45e0f12b..21064a1b 100644
--- a/src/location/places/qplaceicon.cpp
+++ b/src/location/places/qplaceicon.cpp
@@ -80,7 +80,7 @@ bool QPlaceIconPrivate::operator == (const QPlaceIconPrivate &other) const
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-data
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceIcon class represents an icon.
diff --git a/src/location/places/qplaceidreply.cpp b/src/location/places/qplaceidreply.cpp
index 72c7c6cd..e8d728c5 100644
--- a/src/location/places/qplaceidreply.cpp
+++ b/src/location/places/qplaceidreply.cpp
@@ -62,16 +62,16 @@ QT_USE_NAMESPACE
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-replies
- \since QtLocation 5.0
+ \since Qt Location 5.0
- \brief The QPlaceIdReply class manages operations which return an id such as
+ \brief The QPlaceIdReply class manages operations which return an identifier such as
saving and removal operations of places and categories.
The QPlaceIdReply can be considered a multipurpose reply in that it can
be used to save places, save categories, remove places and remove categories.
- In each case it returns an id of the place or category that was added/modified/removed.
+ In each case it returns an identifier of the place or category that was added, modified or removed.
- See \l {Saving a place cpp}{Saving a place} for an example of how to use an id reply.
+ See \l {Saving a place cpp}{Saving a place} for an example of how to use an identifier reply.
\sa QPlaceManager
*/
@@ -85,7 +85,7 @@ QT_USE_NAMESPACE
*/
/*!
- Constructs an id reply with a given \a operationType and \a parent.
+ Constructs a reply which contains the identifier of the object operated upon. The reply is for the given \a operationType and with \a parent.
*/
QPlaceIdReply::QPlaceIdReply(QPlaceIdReply::OperationType operationType, QObject *parent)
: QPlaceReply(new QPlaceIdReplyPrivate(operationType), parent) {}
@@ -106,8 +106,8 @@ QPlaceReply::Type QPlaceIdReply::type() const
}
/*!
- Returns the operation type of the reply. i.e whether this
- id reply was for a save place operation,
+ Returns the operation type of the reply. This means whether this
+ identifier reply was for a save place operation,
remove category operation and so on.
*/
QPlaceIdReply::OperationType QPlaceIdReply::operationType() const
@@ -117,9 +117,9 @@ QPlaceIdReply::OperationType QPlaceIdReply::operationType() const
}
/*!
- Returns the relevant id for the operation. Eg for a save place operation,
- the id is that of the saved place. For a category removal operation,
- it is the id of the category that was removed.
+ Returns the relevant identifier for the operation. For example for a save place operation,
+ the identifier is that of the saved place. For a category removal operation,
+ it is the identifier of the category that was removed.
*/
QString QPlaceIdReply::id() const
{
@@ -128,10 +128,10 @@ QString QPlaceIdReply::id() const
}
/*!
- Sets the \a id of the reply.
+ Sets the \a identifier of the reply.
*/
-void QPlaceIdReply::setId(const QString &id)
+void QPlaceIdReply::setId(const QString &identifier)
{
Q_D(QPlaceIdReply);
- d->id = id;
+ d->id = identifier;
}
diff --git a/src/location/places/qplaceidreply.h b/src/location/places/qplaceidreply.h
index 9a1fd154..f9846525 100644
--- a/src/location/places/qplaceidreply.h
+++ b/src/location/places/qplaceidreply.h
@@ -73,7 +73,7 @@ public:
QString id() const;
protected:
- void setId(const QString &id);
+ void setId(const QString &identifier);
private:
Q_DISABLE_COPY(QPlaceIdReply)
Q_DECLARE_PRIVATE(QPlaceIdReply)
diff --git a/src/location/places/qplaceimage.cpp b/src/location/places/qplaceimage.cpp
index 4daeb2cb..79ff1156 100644
--- a/src/location/places/qplaceimage.cpp
+++ b/src/location/places/qplaceimage.cpp
@@ -72,12 +72,12 @@ bool QPlaceImagePrivate::compare(const QPlaceContentPrivate *other) const
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-data
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceImage class represents a reference to an image.
Each QPlaceImage represents a set of metadata about an image such as it's
- url, id and MIME type. These are properties in addition to those provided
+ url, identifier and MIME type. These are properties in addition to those provided
by QPlaceContent.
Note: The Places API only supports images as 'retrieve-only' objects. Submitting
@@ -128,7 +128,7 @@ void QPlaceImage::setUrl(const QUrl &url)
}
/*!
- Returns the image's id.
+ Returns the image's identifier.
*/
QString QPlaceImage::imageId() const
{
@@ -137,12 +137,12 @@ QString QPlaceImage::imageId() const
}
/*!
- Sets image's \a id.
+ Sets image's \a identifier.
*/
-void QPlaceImage::setImageId(const QString &id)
+void QPlaceImage::setImageId(const QString &identifier)
{
Q_D(QPlaceImage);
- d->id = id;
+ d->id = identifier;
}
/*!
diff --git a/src/location/places/qplaceimage.h b/src/location/places/qplaceimage.h
index 0c5e0e5a..a8b2fcfc 100644
--- a/src/location/places/qplaceimage.h
+++ b/src/location/places/qplaceimage.h
@@ -72,7 +72,7 @@ public:
void setUrl(const QUrl &url);
QString imageId() const;
- void setImageId(const QString &id);
+ void setImageId(const QString &identifier);
QString mimeType() const;
void setMimeType(const QString &data);
diff --git a/src/location/places/qplacemanager.cpp b/src/location/places/qplacemanager.cpp
index 8767db2d..68ba0df5 100644
--- a/src/location/places/qplacemanager.cpp
+++ b/src/location/places/qplacemanager.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-manager
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceManager class provides the interface which allows clients to access
places stored in a particular backend.
@@ -82,7 +82,7 @@ QT_BEGIN_NAMESPACE
\li Rich content such as images, reviews etc can be retrieved in a paged
fashion.
\row
- \li Place/Category management
+ \li Place or Category management
\li Places and categories may be saved and removed. It is possible
for notifications to be given when this happens.
\row
@@ -91,12 +91,12 @@ QT_BEGIN_NAMESPACE
data in different languages.
\endtable
- \section1 Obtaining a QPlaceManager instance
+ \section1 Obtaining a QPlaceManager Instance
Creation of a QPlaceManager is facilitated by the QGeoServiceProvider.
See \l {Initializing a manager} for an example on how to create a manager.
- \section1 Asynchronous interface.
+ \section1 Asynchronous Interface.
The QPlaceManager class provides an abstraction of the datastore which contains place information.
The functions provided by the QPlaceManager and primarily asynchronous and follow
a request-reply model. Typically a request is given to the manager, consisting
@@ -144,7 +144,7 @@ QT_BEGIN_NAMESPACE
\value LocaleFeature The manager can be used to provide place data localized
according to locale
\value NotificationsFeature The manager has signal notifications for when
- places/categories are added/modified/removed.
+ places or categories are added, modified or removed.
\value MatchingFeature The manager support matching places from other managers.
*/
@@ -317,7 +317,7 @@ QPlaceReply *QPlaceManager::initializeCategories()
}
/*!
- Returns the parent category id of the category corresponding to \a categoryId.
+ Returns the parent category identifier of the category corresponding to \a categoryId.
*/
QString QPlaceManager::parentCategoryId(const QString &categoryId) const
{
@@ -325,8 +325,8 @@ QString QPlaceManager::parentCategoryId(const QString &categoryId) const
}
/*!
- Returns the child category ids of the category corresponding to \a parentId.
- If \a parentId is empty then all top level category ids are returned.
+ Returns the child category identifiers of the category corresponding to \a parentId.
+ If \a parentId is empty then all top level category identifiers are returned.
*/
QStringList QPlaceManager::childCategoryIds(const QString &parentId) const
{
diff --git a/src/location/places/qplacemanagerengine.cpp b/src/location/places/qplacemanagerengine.cpp
index 0c076a37..66f7410e 100644
--- a/src/location/places/qplacemanagerengine.cpp
+++ b/src/location/places/qplacemanagerengine.cpp
@@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE
\ingroup QtLocation-impl
\ingroup QtLocation-places
\ingroup QtLocation-places-manager
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceManagerEngine class provides an interface for
implementers of QGeoServiceProvider plugins who want to provide access to place
@@ -256,7 +256,7 @@ QPlaceReply *QPlaceManagerEngine::initializeCategories()
}
/*!
- Returns the parent category id of the category corresponding to \a categoryId.
+ Returns the parent category identifier of the category corresponding to \a categoryId.
*/
QString QPlaceManagerEngine::parentCategoryId(const QString &categoryId) const
{
@@ -266,8 +266,8 @@ QString QPlaceManagerEngine::parentCategoryId(const QString &categoryId) const
}
/*!
- Returns the child category ids of the category corresponding to \a parentId. If \a parentId is
- empty then all top level category ids are returned.
+ Returns the child category identifiers of the category corresponding to \a parentId. If \a parentId is
+ empty then all top level category identifiers are returned.
*/
QStringList QPlaceManagerEngine::childCategoryIds(const QString &categoryId) const
{
diff --git a/src/location/places/qplacematchreply.cpp b/src/location/places/qplacematchreply.cpp
index 8f8b8726..42c54834 100644
--- a/src/location/places/qplacematchreply.cpp
+++ b/src/location/places/qplacematchreply.cpp
@@ -61,7 +61,7 @@ QT_USE_NAMESPACE
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-replies
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceMatchReply class manages a place matching operation started by an
instance of QPlaceManager.
diff --git a/src/location/places/qplacematchrequest.cpp b/src/location/places/qplacematchrequest.cpp
index 128a5323..65568986 100644
--- a/src/location/places/qplacematchrequest.cpp
+++ b/src/location/places/qplacematchrequest.cpp
@@ -105,7 +105,7 @@ void QPlaceMatchRequestPrivate::clear()
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-requests
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceMatchRequest class is used to find places from one manager that match those from another. It represents
a set of request parameters.
@@ -113,8 +113,8 @@ void QPlaceMatchRequestPrivate::clear()
Places from another manager that may have corresponding/matching places in the current manager are assigned using setPlaces() or setResults().
A set of further parameters are specified which determines the criteria for matching.
- The typical key for matching is the QPlaceMatchRequest::AlternativeId, the value is an alternative id attribute type of the format
- x_id_<provider name> eg x_id_nokia. The provider name is name supplied to the QGeoServiceProvider instance.
+ The typical key for matching is the QPlaceMatchRequest::AlternativeId, the value is an alternative identifier attribute type of the format
+ x_id_<provider name> for example x_id_nokia. The provider name is name supplied to the QGeoServiceProvider instance.
See \l {Matching places between managers} for an example on how to use a match request.
@@ -123,7 +123,7 @@ void QPlaceMatchRequestPrivate::clear()
/*!
\variable QPlaceMatchRequest::AlternativeId
- The key to specify that matching is to be accomplished via an alternative place id.
+ The key to specify that matching is to be accomplished via an alternative place identifier.
*/
const QString QPlaceMatchRequest::AlternativeId(QLatin1String("alternativeId"));
diff --git a/src/location/places/qplaceratings.cpp b/src/location/places/qplaceratings.cpp
index 9fc791ac..145b709f 100644
--- a/src/location/places/qplaceratings.cpp
+++ b/src/location/places/qplaceratings.cpp
@@ -73,7 +73,7 @@ bool QPlaceRatingsPrivate::isEmpty() const
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-data
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceRatings class holds rating information about a place.
diff --git a/src/location/places/qplacereply.cpp b/src/location/places/qplacereply.cpp
index 7658a673..270752e3 100644
--- a/src/location/places/qplacereply.cpp
+++ b/src/location/places/qplacereply.cpp
@@ -49,7 +49,7 @@ QT_USE_NAMESPACE
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-replies
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceReply class manages an operation started by an instance of QPlaceManager and
serves as a base class for more specialized replies.
@@ -109,8 +109,8 @@ QT_USE_NAMESPACE
\value ContentReply
This is a reply for content associated with a place.
\value IdReply
- This is a reply that returns an id of a place/category.
- Typically used for place/category save and remove operations.
+ This is a reply that returns an identifier of a place or category.
+ Typically used for place or category save and remove operations.
\value MatchReply
This is a reply that returns places that match
those from another provider.
diff --git a/src/location/places/qplacereview.cpp b/src/location/places/qplacereview.cpp
index 09c21072..8395796a 100644
--- a/src/location/places/qplacereview.cpp
+++ b/src/location/places/qplacereview.cpp
@@ -81,7 +81,7 @@ bool QPlaceReviewPrivate::compare(const QPlaceContentPrivate *other) const
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-data
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceReview class represents a review of a place.
@@ -196,7 +196,7 @@ void QPlaceReview::setRating(qreal rating)
}
/*!
- Returns the review's id.
+ Returns the review's identifier.
*/
QString QPlaceReview::reviewId() const
{
@@ -205,12 +205,12 @@ QString QPlaceReview::reviewId() const
}
/*!
- Sets the \a id of the review.
+ Sets the \a identifier of the review.
*/
-void QPlaceReview::setReviewId(const QString &id)
+void QPlaceReview::setReviewId(const QString &identifier)
{
Q_D(QPlaceReview);
- d->reviewId = id;
+ d->reviewId = identifier;
}
/*!
diff --git a/src/location/places/qplacereview.h b/src/location/places/qplacereview.h
index 10546b36..bc2d5b59 100644
--- a/src/location/places/qplacereview.h
+++ b/src/location/places/qplacereview.h
@@ -74,7 +74,7 @@ public:
qreal rating() const;
void setRating(qreal data);
QString reviewId() const;
- void setReviewId(const QString &data);
+ void setReviewId(const QString &identifier);
QString title() const;
void setTitle(const QString &data);
diff --git a/src/location/places/qplacesearchreply.cpp b/src/location/places/qplacesearchreply.cpp
index 936531ed..63c9fbe7 100644
--- a/src/location/places/qplacesearchreply.cpp
+++ b/src/location/places/qplacesearchreply.cpp
@@ -61,7 +61,7 @@ QT_USE_NAMESPACE
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-replies
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceSearchReply class manages a place search operation started by an
instance of QPlaceManager.
diff --git a/src/location/places/qplacesearchrequest.cpp b/src/location/places/qplacesearchrequest.cpp
index 64596f1d..a4c97ec1 100644
--- a/src/location/places/qplacesearchrequest.cpp
+++ b/src/location/places/qplacesearchrequest.cpp
@@ -139,7 +139,7 @@ void QPlaceSearchRequestPrivate::clear()
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-requests
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceSearchRequest class represents the set of parameters for a search request.
@@ -157,11 +157,11 @@ void QPlaceSearchRequestPrivate::clear()
\l {QPlaceManager::search()} {search for places}, however it is also
used to provide parameters for \l {QPlaceManager::searchSuggestions()}{generating search term suggestions}
and \l {QPlaceManager::recommendations()} {retreiving recommendations}. Note that depending on usage,
- some parameters may not be relevant, e.g. the relevance hint is not important for search term suggestions. However
- in general, most of the parameters are useful for each of these operations, eg for a recommendation, a search area
+ some parameters may not be relevant, for example the relevance hint is not important for search term suggestions. However
+ in general, most of the parameters are useful for each of these operations, for example for a recommendation, a search area
and categories can be useful in narrowing down recommendation candidates.
- Also be aware that providers may vary by which parameters they support e.g. some providers may not support
+ Also be aware that providers may vary by which parameters they support for example some providers may not support
paging while others do, some providers may honor relevance hints while others may completely ignore them,
see \l {Information about plugins}.
@@ -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. e.g. providing a distance hint
+ to help but not dictate the ranking of results. For example 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 4e6d1d4c..7f3204c1 100644
--- a/src/location/places/qplacesearchresult.cpp
+++ b/src/location/places/qplacesearchresult.cpp
@@ -79,7 +79,7 @@ bool QPlaceSearchResultPrivate::operator==(const QPlaceSearchResultPrivate &othe
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-data
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceSearchResult class represents a search result.
diff --git a/src/location/places/qplacesearchsuggestionreply.cpp b/src/location/places/qplacesearchsuggestionreply.cpp
index bd1d56e7..e635f1e4 100644
--- a/src/location/places/qplacesearchsuggestionreply.cpp
+++ b/src/location/places/qplacesearchsuggestionreply.cpp
@@ -60,7 +60,7 @@ QT_USE_NAMESPACE
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-replies
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceSearchSuggestionReply class manages a search suggestion operation started by an
instance of QPlaceManager.
diff --git a/src/location/places/qplacesupplier.cpp b/src/location/places/qplacesupplier.cpp
index 01b73dff..3d86f35e 100644
--- a/src/location/places/qplacesupplier.cpp
+++ b/src/location/places/qplacesupplier.cpp
@@ -85,7 +85,7 @@ bool QPlaceSupplierPrivate::isEmpty() const
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-data
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceSupplier class represents a supplier of a place or content associated
with a place.
@@ -166,7 +166,7 @@ void QPlaceSupplier::setName(const QString &name)
}
/*!
- Returns the id of the supplier. The id is unique
+ Returns the identifier of the supplier. The identifier is unique
to the manager backend which provided the supplier and is generally
not suitable for displaying to the user.
*/
@@ -176,11 +176,11 @@ QString QPlaceSupplier::supplierId() const
}
/*!
- Sets the \a id of the supplier.
+ Sets the \a identifier of the supplier.
*/
-void QPlaceSupplier::setSupplierId(const QString &id)
+void QPlaceSupplier::setSupplierId(const QString &identifier)
{
- d->supplierId = id;
+ d->supplierId = identifier;
}
/*!
diff --git a/src/location/places/qplacesupplier.h b/src/location/places/qplacesupplier.h
index bffed1b0..8d685115 100644
--- a/src/location/places/qplacesupplier.h
+++ b/src/location/places/qplacesupplier.h
@@ -71,7 +71,7 @@ public:
void setName(const QString &data);
QString supplierId() const;
- void setSupplierId(const QString &data);
+ void setSupplierId(const QString &identifier);
QUrl url() const;
void setUrl(const QUrl &data);
diff --git a/src/location/places/qplaceuser.cpp b/src/location/places/qplaceuser.cpp
index 1b4f6f47..75c77ba1 100644
--- a/src/location/places/qplaceuser.cpp
+++ b/src/location/places/qplaceuser.cpp
@@ -68,7 +68,7 @@ bool QPlaceUserPrivate::operator==(const QPlaceUserPrivate &other) const
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-data
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QPlaceUser class represents an individual user.
*/
@@ -122,7 +122,7 @@ bool QPlaceUser::operator==(const QPlaceUser &other) const
}
/*!
- Returns the id of the user.
+ Returns the identifier of the user.
*/
QString QPlaceUser::userId() const
{
@@ -130,11 +130,11 @@ QString QPlaceUser::userId() const
}
/*!
- Sets the \a id of the user.
+ Sets the \a identifier of the user.
*/
-void QPlaceUser::setUserId(const QString &id)
+void QPlaceUser::setUserId(const QString &identifier)
{
- d->userId = id;
+ d->userId = identifier;
}
/*!
diff --git a/src/location/places/qplaceuser.h b/src/location/places/qplaceuser.h
index 02b13fa7..3edec796 100644
--- a/src/location/places/qplaceuser.h
+++ b/src/location/places/qplaceuser.h
@@ -67,7 +67,7 @@ public:
}
QString userId() const;
- void setUserId(const QString &);
+ void setUserId(const QString &identifier);
QString name() const;
void setName(const QString &name);
diff --git a/src/location/qgeoaddress.cpp b/src/location/qgeoaddress.cpp
index 3c4840ad..c2fb0614 100644
--- a/src/location/qgeoaddress.cpp
+++ b/src/location/qgeoaddress.cpp
@@ -77,24 +77,24 @@ QGeoAddressPrivate::~QGeoAddressPrivate()
\ingroup QtLocation-positioning
\ingroup QtLocation-places-data
\ingroup QtLocation-places
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoAddress class represents an address of a \l QGeoLocation.
The address' attributes are normalized to US feature names and can be mapped
- to the local feature levels (e.g. State matches "Bundesland" in Germany).
+ to the local feature levels (for example State matches "Bundesland" in Germany).
The address contains a \l text() for displaying purposes and additional
properties to access the components of an address:
\list
- \o QGeoAddress::country()
- \o QGeoAddress::countryCode()
- \o QGeoAddress::state()
- \o QGeoAddress::city()
- \o QGeoAddress::district()
- \o QGeoAddress::street()
- \o QGeoAddress::postalCode()
+ \li QGeoAddress::country()
+ \li QGeoAddress::countryCode()
+ \li QGeoAddress::state()
+ \li QGeoAddress::city()
+ \li QGeoAddress::district()
+ \li QGeoAddress::street()
+ \li QGeoAddress::postalCode()
\endlist
*/
diff --git a/src/location/qgeoareamonitor.cpp b/src/location/qgeoareamonitor.cpp
index 94c12c77..6b992dcf 100644
--- a/src/location/qgeoareamonitor.cpp
+++ b/src/location/qgeoareamonitor.cpp
@@ -46,7 +46,7 @@
\class QGeoAreaMonitor
\inmodule QtLocation
\ingroup QtLocation-positioning
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoAreaMonitor class enables the detection of proximity
changes for a specified set of coordinates.
diff --git a/src/location/qgeoboundingarea.cpp b/src/location/qgeoboundingarea.cpp
index 31bd407f..dbad8fec 100644
--- a/src/location/qgeoboundingarea.cpp
+++ b/src/location/qgeoboundingarea.cpp
@@ -62,7 +62,7 @@ bool QGeoBoundingAreaPrivate::operator==(const QGeoBoundingAreaPrivate &other) c
\class QGeoBoundingArea
\inmodule QtLocation
\ingroup QtLocation-positioning
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoBoundingArea class defines a geographic area.
diff --git a/src/location/qgeoboundingbox.cpp b/src/location/qgeoboundingbox.cpp
index 2aea005e..357ef07c 100644
--- a/src/location/qgeoboundingbox.cpp
+++ b/src/location/qgeoboundingbox.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
\class QGeoBoundingBox
\inmodule QtLocation
\ingroup QtLocation-positioning
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoBoundingBox class defines a rectangular geographic area.
diff --git a/src/location/qgeoboundingcircle.cpp b/src/location/qgeoboundingcircle.cpp
index f37ce64d..3356e6c3 100644
--- a/src/location/qgeoboundingcircle.cpp
+++ b/src/location/qgeoboundingcircle.cpp
@@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE
\class QGeoBoundingCircle
\inmodule QtLocation
\ingroup QtLocation-positioning
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoBoundingCircle class defines a circular geographic area.
diff --git a/src/location/qgeocoordinate.cpp b/src/location/qgeocoordinate.cpp
index 4902a493..fe08be0f 100644
--- a/src/location/qgeocoordinate.cpp
+++ b/src/location/qgeocoordinate.cpp
@@ -81,7 +81,7 @@ QGeoCoordinatePrivate::QGeoCoordinatePrivate() {
\class QGeoCoordinate
\inmodule QtLocation
\ingroup QtLocation-positioning
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoCoordinate class defines a geographical position on the surface of the Earth.
diff --git a/src/location/qgeolocation.cpp b/src/location/qgeolocation.cpp
index d0689c71..6a2b5f43 100644
--- a/src/location/qgeolocation.cpp
+++ b/src/location/qgeolocation.cpp
@@ -83,7 +83,7 @@ bool QGeoLocationPrivate::isEmpty() const
\ingroup QtLocation-positioning
\ingroup QtLocation-places
\ingroup QtLocation-places-data
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoLocation class represents basic information about a location.
diff --git a/src/location/qgeopositioninfo.cpp b/src/location/qgeopositioninfo.cpp
index 9931594a..f3c454a1 100644
--- a/src/location/qgeopositioninfo.cpp
+++ b/src/location/qgeopositioninfo.cpp
@@ -58,7 +58,7 @@ public:
\class QGeoPositionInfo
\inmodule QtLocation
\ingroup QtLocation-positioning
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoPositionInfo class contains information gathered on a global position, direction and velocity at a particular point in time.
diff --git a/src/location/qgeopositioninfosource.cpp b/src/location/qgeopositioninfosource.cpp
index 86360952..54ae2538 100644
--- a/src/location/qgeopositioninfosource.cpp
+++ b/src/location/qgeopositioninfosource.cpp
@@ -62,7 +62,7 @@ Q_GLOBAL_STATIC_WITH_ARGS(QFactoryLoader, loader,
\class QGeoPositionInfoSource
\inmodule QtLocation
\ingroup QtLocation-positioning
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoPositionInfoSource class is an abstract base class for the distribution of positional updates.
@@ -104,7 +104,7 @@ Q_GLOBAL_STATIC_WITH_ARGS(QFactoryLoader, loader,
Defines the types of positioning methods.
\value SatellitePositioningMethods Satellite-based positioning methods such as GPS or GLONASS.
- \value NonSatellitePositioningMethods Other positioning methods such as 3GPP cell ID or WiFi based positioning.
+ \value NonSatellitePositioningMethods Other positioning methods such as 3GPP cell identifier or WiFi based positioning.
\value AllPositioningMethods Satellite-based positioning methods as soon as available. Otherwise non-satellite based methods.
*/
@@ -427,7 +427,7 @@ QStringList QGeoPositionInfoSource::availableSources()
\value AccessError The connection setup to the remote positioning backend failed because the
application lacked the required privileges.
- \value ClosedError The remote positioning backend closed the connection, which happens e.g. in case
+ \value ClosedError The remote positioning backend closed the connection, which happens for example in case
the user is switching location services to off. This object becomes invalid and should be deleted.
A call to createDefaultSource() can be used to create a new source later on.
\value UnknownSourceError An unidentified error occurred.
diff --git a/src/location/qgeopositioninfosourcefactory.cpp b/src/location/qgeopositioninfosourcefactory.cpp
index 8dc552f6..80f9fafe 100644
--- a/src/location/qgeopositioninfosourcefactory.cpp
+++ b/src/location/qgeopositioninfosourcefactory.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
\class QGeoPositionInfoSourceFactory
\inmodule QtLocation
\ingroup QtLocation-impl
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoPositionInfoSourceFactory class is a factory class used
as the plugin interface for external providers of positioning data.
diff --git a/src/location/qgeosatelliteinfo.cpp b/src/location/qgeosatelliteinfo.cpp
index 69805452..80769fb5 100644
--- a/src/location/qgeosatelliteinfo.cpp
+++ b/src/location/qgeosatelliteinfo.cpp
@@ -60,7 +60,7 @@ public:
\class QGeoSatelliteInfo
\inmodule QtLocation
\ingroup QtLocation-positioning
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoSatelliteInfo class contains basic information about a satellite.
@@ -165,11 +165,11 @@ QGeoSatelliteInfo::SatelliteSystem QGeoSatelliteInfo::satelliteSystem() const
}
/*!
- Sets the satellite ID number to \a satId.
+ Sets the satellite identifier number to \a satId.
- The satellite ID number can be used to identify a satellite inside the satellite system.
- For satellite system GPS the satellite ID number represents the PRN (Pseudo-random noise) number.
- For satellite system GLONASS the satellite ID number represents the slot number.
+ The satellite identifier number can be used to identify a satellite inside the satellite system.
+ For satellite system GPS the satellite identifier number represents the PRN (Pseudo-random noise) number.
+ For satellite system GLONASS the satellite identifier number represents the slot number.
*/
void QGeoSatelliteInfo::setSatelliteIdentifier(int satId)
{
@@ -177,11 +177,11 @@ void QGeoSatelliteInfo::setSatelliteIdentifier(int satId)
}
/*!
- Returns the satellite ID number.
+ Returns the satellite identifier number.
- The satellite ID number can be used to identify a satellite inside the satellite system.
- For satellite system GPS the satellite ID number represents the PRN (Pseudo-random noise) number.
- For satellite system GLONASS the satellite ID number represents the slot number.
+ The satellite identifier number can be used to identify a satellite inside the satellite system.
+ For satellite system GPS the satellite identifier number represents the PRN (Pseudo-random noise) number.
+ For satellite system GLONASS the satellite identifier number represents the slot number.
*/
int QGeoSatelliteInfo::satelliteIdentifier() const
{
diff --git a/src/location/qgeosatelliteinfosource.cpp b/src/location/qgeosatelliteinfosource.cpp
index eaa9268a..3c1d5d32 100644
--- a/src/location/qgeosatelliteinfosource.cpp
+++ b/src/location/qgeosatelliteinfosource.cpp
@@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE
\class QGeoSatelliteInfoSource
\inmodule QtLocation
\ingroup QtLocation-positioning
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QGeoSatelliteInfoSource class is an abstract base class for the distribution of satellite information updates.
@@ -297,7 +297,7 @@ QStringList QGeoSatelliteInfoSource::availableSources()
\value AccessError The connection setup to the remote positioning backend failed because the
application lacked the required privileges.
- \value ClosedError The remote satellite backend closed the connection, which happens e.g. in case
+ \value ClosedError The remote satellite backend closed the connection, which happens for example in case
the user is switching location services to off. This object becomes invalid and should be deleted.
A new satellite source can be created by calling createDefaultSource() later on.
\value UnknownSourceError An unidentified error occurred.
diff --git a/src/location/qlocationutils_p.h b/src/location/qlocationutils_p.h
index ae43e514..54710e42 100644
--- a/src/location/qlocationutils_p.h
+++ b/src/location/qlocationutils_p.h
@@ -91,7 +91,7 @@ public:
Q_AUTOTEST_EXPORT static bool getNmeaTime(const QByteArray &bytes, QTime *time);
/*
- Accepts e.g. ("2734.7964", 'S', "15306.0124", 'E') and returns the
+ Accepts for example ("2734.7964", 'S', "15306.0124", 'E') and returns the
lat-long values. Fails if lat or long fail isValidLat() or isValidLong().
*/
Q_AUTOTEST_EXPORT static bool getNmeaLatLong(const QByteArray &latString, char latDirection, const QByteArray &lngString, char lngDirection, double *lat, double *lon);
diff --git a/src/location/qnmeapositioninfosource.cpp b/src/location/qnmeapositioninfosource.cpp
index a0cc1871..0fab0e59 100644
--- a/src/location/qnmeapositioninfosource.cpp
+++ b/src/location/qnmeapositioninfosource.cpp
@@ -431,7 +431,7 @@ void QNmeaPositionInfoSourcePrivate::emitUpdated(const QGeoPositionInfo &update)
\class QNmeaPositionInfoSource
\inmodule QtLocation
\ingroup QtLocation-positioning
- \since QtLocation 5.0
+ \since Qt Location 5.0
\brief The QNmeaPositionInfoSource class provides positional information using a NMEA data source.