summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPeter Yard <peter.yard@nokia.com>2012-03-14 11:27:00 +1000
committerQt by Nokia <qt-info@nokia.com>2012-03-15 12:38:17 +0100
commitb827cee44697b3766543870be7c5bcbb89f0c692 (patch)
tree45e7a5c49de5e41977bd6494ba68bb9529e28f7d /doc
parentb36948312d237924f268f5c1308abea3911e0d92 (diff)
downloadqtlocation-b827cee44697b3766543870be7c5bcbb89f0c692.tar.gz
Docs: Bug-6677 fix for items 001-003.
Change-Id: I8da3e2e445782eccec379a54823d39df7ed8d9f8 Reviewed-by: Alex <alex.blasche@nokia.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/config/qtlocation.qdocconf2
-rw-r--r--doc/src/examples/declarative-flickr.qdoc4
-rw-r--r--doc/src/examples/declarative-mapviewer.qdoc12
-rw-r--r--doc/src/examples/qtlocation-examples.qdoc6
-rw-r--r--doc/src/examples/weatherinfo.qdoc2
-rw-r--r--doc/src/imports/qtlocation5.qdoc2
-rw-r--r--doc/src/maps.qdoc16
-rw-r--r--doc/src/places.qdoc30
-rw-r--r--doc/src/plugins/jsondb.qdoc16
-rw-r--r--doc/src/plugins/nokia.qdoc10
-rw-r--r--doc/src/plugins/places-backend.qdoc16
-rw-r--r--doc/src/plugins/qml-location.qdoc2
-rw-r--r--doc/src/position.qdoc12
-rw-r--r--doc/src/qml-maps.qdoc9
-rw-r--r--doc/src/qml-position.qdoc8
-rw-r--r--doc/src/qtlocation-cpp.qdoc10
-rw-r--r--doc/src/qtlocation-geoservices.qdoc10
-rw-r--r--doc/src/qtlocation.qdoc42
18 files changed, 104 insertions, 105 deletions
diff --git a/doc/config/qtlocation.qdocconf b/doc/config/qtlocation.qdocconf
index e4fa1649..ef7d1557 100644
--- a/doc/config/qtlocation.qdocconf
+++ b/doc/config/qtlocation.qdocconf
@@ -56,7 +56,7 @@ qhp.qtlocation.namespace = qtlocation.500
# Title for the package, will be the main title for the package in
# Assistant/Creator.
-qhp.qtlocation.indexTitle = Qt Sensors Documentation
+qhp.qtlocation.indexTitle = Qt Location Documentation
# Extra files to add to the output which are not linked to from anywhere
# using a qdoc \l command.
diff --git a/doc/src/examples/declarative-flickr.qdoc b/doc/src/examples/declarative-flickr.qdoc
index 9ed4c365..9d500148 100644
--- a/doc/src/examples/declarative-flickr.qdoc
+++ b/doc/src/examples/declarative-flickr.qdoc
@@ -34,7 +34,7 @@
fetch local content from a web service.
This is a small example, illustrating one of the very core parts of the
- QtLocation API: the ability to retrieve and use the user's current
+ Qt Location API: the ability to retrieve and use the user's current
geographic location.
Key QML elements shown in this example:
@@ -45,7 +45,7 @@
\image qml-flickr-1.jpg
- \section2 Retrieving the current location
+ \section2 Retrieving the Current Location
Retrieving the user's current location is achieved using the PositionSource
element. In this example, we instantiate the PositionSource as part of the
diff --git a/doc/src/examples/declarative-mapviewer.qdoc b/doc/src/examples/declarative-mapviewer.qdoc
index cc34043e..351f8ff2 100644
--- a/doc/src/examples/declarative-mapviewer.qdoc
+++ b/doc/src/examples/declarative-mapviewer.qdoc
@@ -34,7 +34,7 @@
search for an address, and find driving directions.
This is a large example covering many basic uses of maps, positioning, and
- navigation services in QtLocation. This page is divided into sections
+ navigation services in Qt Location. This page is divided into sections
covering each of these areas of functionality with snippets from the code.
QML elements shown in this example:
@@ -62,7 +62,7 @@
\image ../images/example-mapviewer.png
- \section2 Displaying a map
+ \section2 Displaying a Map
Drawing a map on-screen is accomplished using the Map element, as shown
below.
@@ -85,7 +85,7 @@
Ovi Maps. Additional licensing conditions do apply to the use of this data,
please see the documentation for further details.
- \section2 Finding an address (geocoding)
+ \section2 Finding an Address (Geocoding)
To locate a certain address or place on the map uses a process called
geocoding. In order to perform a geocode operation, we first need to adjust
@@ -125,10 +125,10 @@
\snippet examples/declarative/mapviewer/mapviewer.qml geocode1
\snippet examples/declarative/mapviewer/mapviewer.qml geocode2
- \section2 Directions and travel routes
+ \section2 Directions and Travel Routes
- Similar to the GeocodeModel, QtLocation also features the RouteModel element,
- which allows information about routes (e.g. driving directions) between two
+ Similar to the GeocodeModel, Qt Location also features the RouteModel element,
+ which allows information about routes (for example driving directions) between two
or more points, to be received and used with a Map.
Here again, we instantiate the RouteModel as a property of our Map:
diff --git a/doc/src/examples/qtlocation-examples.qdoc b/doc/src/examples/qtlocation-examples.qdoc
index be4f77d5..c282ef45 100644
--- a/doc/src/examples/qtlocation-examples.qdoc
+++ b/doc/src/examples/qtlocation-examples.qdoc
@@ -27,12 +27,12 @@
/*!
\group qtlocation-examples
- \title QtLocation Examples
- \brief Examples for the QtLocation module
+ \title Qt Location Examples
+ \brief Examples for the Qt Location module
\ingroup all-examples
\ingroup qtlocation
- These are the QtLocation examples.
+ These are the Qt Location examples.
\generatelist related
*/
diff --git a/doc/src/examples/weatherinfo.qdoc b/doc/src/examples/weatherinfo.qdoc
index d6ce5e42..39d50e8d 100644
--- a/doc/src/examples/weatherinfo.qdoc
+++ b/doc/src/examples/weatherinfo.qdoc
@@ -34,7 +34,7 @@
\ingroup qtlocation-examples
- Key QtLocation classes used in this example:
+ Key Qt Location classes used in this example:
\list
\li \l{QGeoPositionInfo}
diff --git a/doc/src/imports/qtlocation5.qdoc b/doc/src/imports/qtlocation5.qdoc
index 2b1a5791..678ad1f8 100644
--- a/doc/src/imports/qtlocation5.qdoc
+++ b/doc/src/imports/qtlocation5.qdoc
@@ -32,7 +32,7 @@
\section1 Overview
-The identifying string for this component is \e QtLocation. Use this in the QML \e import statement.
+The identifying string for this component is \e {QtLocation}. Use this in the QML \e import statement.
\section1 Common QML Elements
diff --git a/doc/src/maps.qdoc b/doc/src/maps.qdoc
index 11a1ff85..75f09ea8 100644
--- a/doc/src/maps.qdoc
+++ b/doc/src/maps.qdoc
@@ -29,7 +29,7 @@
/*!
\page location-maps-qml.html
\title Maps & Navigation (QML)
-\previouspage {qtlocation-module.html}{QtLocation}
+\previouspage {Qt Location Module}{Qt Location}
\brief Provides QtQuick user interfaces for displaying, navigating and
interacting with maps, as well as geocoding and navigation.
@@ -45,7 +45,7 @@ It builds upon the API concepts and elements in the
\section1 Maps
-\section2 Displaying maps
+\section2 Displaying Maps
Displaying a map is done using the \l{QtLocation5::Map}{Map} QML element,
which comes provided with many basic interaction utilities including the
@@ -70,7 +70,7 @@ available.
\li Interaction helper for the "pinch to zoom" gesture on a Map.
\endtable
-\section2 Putting objects on a Map
+\section2 Putting Objects on a Map
Maps can also contain map objects, which are used to display information on
its surface. There is a set of basic pre-defined map objects, as well as the
@@ -99,7 +99,7 @@ standard QtQuick item.
\li Turns any arbitrary QtQuick Item into a map object.
\endtable
-\section2 Model-view design with Map objects
+\section2 Model-View Design with Map Objects
To automatically generate Map objects based on the contents of a QtQuick
model (eg a ListModel item), the \l{QtLocation5::MapItemView}{MapItemView}
@@ -113,7 +113,7 @@ only be created within a \l{QtLocation5::Map}{Map}.
\li Populates a Map with Map objects based on a model.
\endtable
-\section2 Interaction with Map objects
+\section2 Interaction with Map Objects
Interaction with the pre-defined Map objects is done using the
\l{QtLocation5::MapMouseArea}{MapMouseArea} element, which behaves much like a
@@ -135,7 +135,7 @@ available.
\li Provides additional information unique to mouse events on a Map.
\endtable
-\section1 Geocoding -- address to coordinate and vice versa
+\section1 Geocoding -- Address to Coordinate and Vice Versa
A geocoding query in QML is performed using the
\l{QtLocation5::GeocodeModel}{GeocodeModel} element. For an address-to-coordinate
@@ -158,7 +158,7 @@ of the model.
\li Structured address for use in queries and results of geocoding
\endtable
-\section1 Routing and navigation
+\section1 Routing and Navigation
*/
@@ -166,7 +166,7 @@ of the model.
/*!
\page location-maps-cpp.html
\title Maps & Navigation (C++)
-\previouspage {qtlocation-module.html}{QtLocation}
+\previouspage {Qt Location Module}{Qt Location}
\brief Provides C++ classes for Geocoding and Navigation.
diff --git a/doc/src/places.qdoc b/doc/src/places.qdoc
index c1126098..71d23438 100644
--- a/doc/src/places.qdoc
+++ b/doc/src/places.qdoc
@@ -28,7 +28,7 @@
/*!
\page location-places-qml.html
\title QML Places API
- \previouspage {qtlocation-qml.html}{QtLocation}
+ \previouspage {qtlocation-qml.html}{Qt Location}
\section1 Overview
@@ -67,7 +67,7 @@
The search model may also be used to specify whether corrections are returned.
See the documentation for \l PlaceSearchModel for details.
- \section2 Fetching details
+ \section2 Fetching Details
In order to save bandwidth, sometimes a backend will only return places which
are partially populated with details. This can be checked with the
Place::detailsFetched property which indicates whether all availalable details
@@ -75,7 +75,7 @@
\snippet snippets/declarative/places.qml Place fetchDetails
- \section2 Saving/Removing a place.
+ \section2 Saving/Removing a Place.
Some backends may support saving/removing of places, this can be done by
calling the Place::save() or Place::remove() function. Note that in order
to save a \l Place, a \l Plugin must be assigned to specify which backend we
@@ -104,7 +104,7 @@
/*!
\page location-places-cpp.html
\title Places (C++)
- \previouspage {qtlocation-module.html}{QtLocation}
+ \previouspage {Qt Location Module}{Qt Location}
\section1 Overview
@@ -119,7 +119,7 @@
\section1 Common Operations
- \section2 Initializing a manager
+ \section2 Initializing a Manager
All places functionality is facilitated by a QPlaceManager instance. One must specify
a QGeoServiceProvider in order to create the QPlaceManager
@@ -205,7 +205,7 @@
\snippet snippets/places/requesthandler.h Recommendation handler
\target Saving a place cpp
- \section2 Saving a place
+ \section2 Saving a Place
The saving of a new place is performed as follows, we create a QPlace instance
and populate it with information such as a name, address and coordinate. Once
done we can invoke QPlaceManager::savePlace() to begin a save operation.
@@ -227,10 +227,10 @@
\section3 Caveats
\input place-caveats.qdocinc
- \section3 Saving between managers
+ \section3 Saving Between Managers
When saving places between managers, there are a few things to be aware of.
Some fields of a place such as the id, categories and icons are manager specific entities
- e.g. the categories in one manager may not be recognized in another.
+ for example the categories in one manager may not be recognized in another.
Therefore trying to save a place directly from one manager to another is not possible.
The typical approach is to use the QPlaceManager::compatiblePlace() function,
@@ -242,7 +242,7 @@
\snippet snippets/places/requesthandler.h Save to different manager
\target Removing a place cpp
- \section2 Removing a place
+ \section2 Removing a Place
The removal of a place is performed as follows:
\snippet snippets/places/requesthandler.h Remove place
\dots
@@ -278,7 +278,7 @@
\snippet snippets/places/requesthandler.h Child categories
- \section2 Saving a category
+ \section2 Saving a Category
The following shows how to save a category
\snippet snippets/places/requesthandler.h Save category
\dots
@@ -290,7 +290,7 @@
from a web service will typically not emit these signals while managers accessing places locally stored generally will.
- \section2 Removing a category
+ \section2 Removing a Category
Category removal is very similar to removing a place
\snippet snippets/places/requesthandler.h Remove category
\dots
@@ -301,7 +301,7 @@
manager does so is provider specific. Managers accessing places from a web service will typically not emit
these signals, while managers accessing places stored locally generally will.
- \section2 Matching places between managers
+ \section2 Matching Places Between Managers
Sometimes you may want to cross reference whether places from one manager match those from another manager.
Such a situation may arise where one manager provides read-only access to places (origin manager) while another second r/w
manager (destination manager) is used to save selected favorites from the first. During a search
@@ -329,17 +329,17 @@
\section1 Classes in Places
- \section2 Data classes
+ \section2 Data Classes
\annotatedlist QtLocation-places-data
- \section2 Request classes
+ \section2 Request Classes
\annotatedlist QtLocation-places-requests
\target Places Reply Classes
\section2 Reply classes
\annotatedlist QtLocation-places-replies
- \section2 Manager classes
+ \section2 Manager Classes
\annotatedlist QtLocation-places-manager
*/
diff --git a/doc/src/plugins/jsondb.qdoc b/doc/src/plugins/jsondb.qdoc
index 8b7611c9..a61a05e9 100644
--- a/doc/src/plugins/jsondb.qdoc
+++ b/doc/src/plugins/jsondb.qdoc
@@ -27,8 +27,8 @@
/*!
\page location-plugin-jsondb.html
-\title QtLocation JsonDb plugin
-\previouspage {QtLocation Module}
+\title Qt Location JsonDb plugin
+\previouspage {Qt Location Module}
\ingroup QtLocation-plugins
@@ -36,7 +36,7 @@
\section1 Overview
-Included with QtLocation is a plugin which stores places in a Json database (aka JsonDb)
+Included with Qt Location is a plugin which stores places in a Json database (aka JsonDb)
The JsonDb GeoServices plugin can be loaded by using the plugin key "nokia_places_jsondb".
@@ -107,7 +107,7 @@ capabilities are outlined below:
\li yes
\endtable
-\section2 Plugin specific behaviours
+\section2 Plugin Specific Behaviors
\section3 Search
The following list shows what core place data is returned during a place search:
\list
@@ -192,11 +192,11 @@ largeUrl: file:///opt/icons/new_icon_large.png
\endcode
All we need to do is set the URLs to where the new icon image is. The size typically does not need to be specified
-since it is generally automatically calculated. In some cases where the size cannot be calculated, e.g. if the
+since it is generally automatically calculated. In some cases where the size cannot be calculated, for example if the
specified URL cannot currently be accessed, it is necessary to specify a recommended size.
If the size of the image can be calculated and a size is also specified, then the specified size is ignored.
-\section4 Copying/Downloading icons to a specified destination
+\section4 Copying/Downloading Icons to a Specified Destination
When saving icons, we use the source parameters to hold the URL of the source image we are copying from
\code
smallSourceUrl: http://www.example.com/icon_s.png
@@ -206,11 +206,11 @@ smallUrl: file:///bar/icon_small.png
Using the parameters above will copy the icon from \c smallSourceUrl to the \c smallUrl. The smallSourceUrl can be a remote or local URL,
but the smallUrl must be local. If the smallUrl already exists, it is overwritten, otherwise it is created.
-\c smallSize typically does not need to be set since an attempt will be made to calculate the icon's size. In some cases where the size cannot be calculated, e.g. if the
+\c smallSize typically does not need to be set since an attempt will be made to calculate the icon's size. In some cases where the size cannot be calculated, for example if the
specified URL cannot currently be accessed, it is necessary to specify a recommended size.
If the size of the image can be calculated and a size is also specified, then the specified size is ignored.
-\section4 Copying/Downloading icons without a specified destination
+\section4 Copying/Downloading Icons Without a Specified Destination
It is possible to copy icons, when a place/category is saved and not have to
specify a destination. In this case, a data URL will be created for the icon
in the underlying database. A data URL contains the icon image embedded
diff --git a/doc/src/plugins/nokia.qdoc b/doc/src/plugins/nokia.qdoc
index 98ed1f40..98fb88a9 100644
--- a/doc/src/plugins/nokia.qdoc
+++ b/doc/src/plugins/nokia.qdoc
@@ -27,15 +27,15 @@
/*!
\page location-plugin-nokia.html
-\title QtLocation Nokia plugin
-\previouspage {QtLocation Module}
+\title Qt Location Nokia plugin
+\previouspage {Qt Location Module}
\ingroup QtLocation-plugins
\brief Uses the relevant Nokia services provided by Nokia.
\section1 Overview
-Included with the QtLocation is a Maps and Navigation API plugin which accesses the relevant Ovi
+Included with the Qt Location is a Maps and Navigation API plugin which accesses the relevant Ovi
services provided by Nokia. The use of these services is governed by the terms and conditions
available in the file plugins/geoservices/nokia/OVI_SERVICES_TERMS_AND_CONDITIONS.txt.
@@ -195,7 +195,7 @@ and behaviours are outlined below:
\li no
\endtable
-\section2 Plugin specific behaviours
+\section2 Plugin Specific Behaviors
\section3 Search
The following list shows what core place data is returned during a place search:
\list
@@ -222,7 +222,7 @@ that has matched the user's search query. An 'address' only has location and na
If a Place has a placeId, then it is a specific 'point of interest', which may have some
or all Place properties available.
-\section3 Search term suggestions.
+\section3 Search Term suggestions
Only a partial search term and search center is supported when retrieving suggestions.
\section3 Recommendation
diff --git a/doc/src/plugins/places-backend.qdoc b/doc/src/plugins/places-backend.qdoc
index 805d8355..40eec5bf 100644
--- a/doc/src/plugins/places-backend.qdoc
+++ b/doc/src/plugins/places-backend.qdoc
@@ -28,7 +28,7 @@
/*!
\page location-places-backend.html
\title Places Backend
-\previouspage {QtLocation Module}
+\previouspage {Qt Location Module}
\brief The Places backend is responsible for managing a places datastore whether
it is located remotely or locally
@@ -48,7 +48,7 @@ default implementation for all virtual functions. The default implementations f
functions return a reply that will emit the error() and finished() signals at the next iteration
through the event loop.
-\section1 Implementing/Inheriting reply objects
+\section1 Implementing/Inheriting Reply Objects
A reply object would be inherited as follows:
\snippet snippets/places/requesthandler.h Implement reply pt1
\dots
@@ -62,7 +62,7 @@ with a \l {Qt::QueuedConnection} to emit the signals.
\snippet snippets/places/requesthandler.h Trigger done
Note that the \c finished signals should always be emitted when a reply is complete, even if
-an error has been encountered, i.e. if there is an error, both the \c error and \c finished signals
+an error has been encountered, that is, if there is an error, both the \c error and \c finished signals
should be emitted while if there is no error, only the \c finished signals are emitted.
The protected functions of QPlaceSearchReply::setResults() and QPlaceSearchReply::setRequest()
@@ -101,12 +101,12 @@ the QPlaceManagerEngine::compatiblePlace() function. This function returns a co
with properties pruned or modified as necessary such that the copy can be saved into manager.
Construction of a compatible place may involve ignoring certain properties from the
-original place, e.g. if contact details are not supported, these are left out of the
-compatible place. Other times it may involve modifying certain properties, e.g.
+original place, for example if contact details are not supported, these are left out of the
+compatible place. Other times it may involve modifying certain properties, for example
modifying the icon parameters to facilitate copying or downloading of the original
place's icon to a location that the backend can access.
-\section1 Cross-referencing Places Between Managers.
+\section1 Cross-Referencing Places Between Managers.
Sometimes a situation may arise where we wish to cross-reference and match places between managers.
Such a situation may arise where one manager provides read-only access to places (origin manager), while another second r/w
manager (destination manager) is used to save selected favorites from the first. During a search of the origin manager, we may want to
@@ -141,12 +141,12 @@ If an origin manager does not supply a place id, it may be necessary to provide
One approach might be to do so via the place coordinates, if the coordinate of a place in the origin manager is identical or close
to a place in the destination manager, there is a high likelihood that they are the same place.
In this case, the manager might implement QPlaceManager::matchingPlaces() to accept a QPlaceMatchRequest with a parameter key of 'proximity'
-and a parameter value of the distance two places must be in order to detect a match. e.g. if an origin place and destination place are within 50m
+and a parameter value of the distance two places must be in order to detect a match. for example if an origin place and destination place are within 50m
of each other, they can be considered the same place.
Generally however it is recommended that cross referencing be implemented via alternative ids as mentioned above.
-\section3 User readable vs non-user readable extended attributes
+\section3 User Readable vs Non-User Readable Extended Attributes
If an attribute is not intended to be readable by end users, the label field should be kept
empty as an indicator of this fact.
*/
diff --git a/doc/src/plugins/qml-location.qdoc b/doc/src/plugins/qml-location.qdoc
index 48f9bcc9..66743c43 100644
--- a/doc/src/plugins/qml-location.qdoc
+++ b/doc/src/plugins/qml-location.qdoc
@@ -35,7 +35,7 @@
\page qml-location-plugin.html
\title Location QML Plugin
- \previouspage {qtlocation-module.html}{QtLocation Module}
+ \previouspage {index-qtlocation-module.html}{Qt Location Module}
\brief A QML plugin for the Qt Location API.
diff --git a/doc/src/position.qdoc b/doc/src/position.qdoc
index 9df79422..0a462a12 100644
--- a/doc/src/position.qdoc
+++ b/doc/src/position.qdoc
@@ -29,7 +29,7 @@
\page location-positioning-cpp.html
\title Positioning (C++)
-\previouspage {qtlocation-module.html}{QtLocation}
+\previouspage {index-qtlocation-module.html}{Qt Location}
\brief The Location Positioning API enables location positioning by means of
GPS or an NMEA data source.
@@ -87,7 +87,7 @@ if one is available. Alternatively, clients can subclass it to provide a
custom satellite data source.
-\section2 Requesting location data from data sources
+\section2 Requesting Location Data from Data Sources
To receive data from a source, connect to its
\l{QGeoPositionInfoSource::positionUpdated()}{positionUpdated()} signal,
@@ -122,7 +122,7 @@ private slots:
\endcode
-\section2 Controlling aspects of data sources
+\section2 Controlling Aspects of Data Sources
The QGeoPositionInfoSource::setUpdateInterval() method can be used to
control the rate at which position updates are received. For example, if
@@ -143,7 +143,7 @@ cases, the default positioning methods should not be changed, as a source
may internally use a variety of positioning methods that can be useful to
the application.
-\section2 Reading NMEA data
+\section2 Reading NMEA Data
\l {http://en.wikipedia.org/wiki/NMEA_0183}{NMEA} is a common text-based
protocol for specifying navigational data. For convenience, the
@@ -155,7 +155,7 @@ according to the time stamp of each NMEA sentence to produce a "replay"
of the recorded data.
-\section2 Example: Creating a custom location data source
+\section2 Example: Creating a Custom Location Data Source
Generally, the capabilities provided by the default position source as
returned by QGeoPositionInfoSource::createDefaultSource(), along with the
@@ -232,7 +232,7 @@ images from Flickr relevant to the current location.
-\section1 Location Position classes
+\section1 Location Position Classes
\annotatedlist QtLocation-positioning
diff --git a/doc/src/qml-maps.qdoc b/doc/src/qml-maps.qdoc
index 7edd4c85..327f4d1b 100644
--- a/doc/src/qml-maps.qdoc
+++ b/doc/src/qml-maps.qdoc
@@ -35,10 +35,9 @@
/*!
\page qml-location5-maps.html
\title QML Maps
-\previouspage {qtlocation-module.html}{QtLocation Module}
+\previouspage {index-qtlocation-module.html}{Qt Location Module}
-\brief Maps is the section QtQuick Location that deals with maps,
-their contents and navigation through the maps. ???
+\brief Maps deals with maps, their contents and navigation.
\section1 Overview
@@ -146,7 +145,7 @@ route will be divided up into a series of segments. At the end of each segment
is a vertex called a \e maneuver. The \e segments contain information about
the time and distance to the end of the segment. The \e maneuvers contain information
about what to do next, how to get onto the next segment, if there is one. So
-a \e maneuver contains navigational information, e.g. "turn right now".
+a \e maneuver contains navigational information, for example "turn right now".
To find a suitable route we will need to use a \l RouteQuery to define the
selection criteria and adding any required waypoints.
@@ -181,7 +180,7 @@ The \l RouteQuery properties can include
\li A list of excluded areas that the route must not cross
\row
\li \l {RouteQuery::}{featureTypes}
- \li Relevant map features, e.g. highway, ferry
+ \li Relevant map features, for example highway, ferry
\endtable
diff --git a/doc/src/qml-position.qdoc b/doc/src/qml-position.qdoc
index 6cb3e089..87938c81 100644
--- a/doc/src/qml-position.qdoc
+++ b/doc/src/qml-position.qdoc
@@ -29,7 +29,7 @@
\page location-positioning-qml.html
\title Positioning (QML)
-\previouspage {qtlocation-module.html}{QtLocation}
+\previouspage {index-qtlocation-module.html}{Qt Location}
\brief The Location Positioning API enables location positioning by means of
GPS or an NMEA data source.
@@ -59,7 +59,7 @@ location data source within the API is that it provides a
latitude-longitude coordinate with a date/time value, with the option of
providing the other attributes listed above.
-\section2 Example: Centering the map on the current position
+\section2 Example: Centering the Map on the Current Position
Here is an example of a client that uses a \l{PositionSource}{position source}
to center a \l{Map}{map} on the current position:
@@ -87,7 +87,7 @@ The \l{Flickr (QML)}{Flickr Example} uses the Location to download thumbnail
images from Flickr relevant to the current location.
-\section1 Location Position classes
+\section1 Location Position Classes
\annotatedlist qml-QtLocation5-positioning
-*/
+*/ \ No newline at end of file
diff --git a/doc/src/qtlocation-cpp.qdoc b/doc/src/qtlocation-cpp.qdoc
index 614f28f4..95c06461 100644
--- a/doc/src/qtlocation-cpp.qdoc
+++ b/doc/src/qtlocation-cpp.qdoc
@@ -27,15 +27,15 @@
/*!
\page qtlocation-cpp.html
-\title QtLocation C++ API
-\brief Information about the QtLocation C++ API
-\previouspage {QtLocation Module}
+\title Qt Location C++ API
+\brief Information about the Qt Location C++ API
+\previouspage {Qt Location Module}
The Location API provides a library for location positioning, mapping and navigation.
\tableofcontents
-The QtLocation API provides the developer with a set of functions for determining
+The Qt Location API provides the developer with a set of functions for determining
the current location and using that information with maps and places of interest.
Positioning information can be sourced from GPS satellites or a stream of data using
@@ -47,7 +47,7 @@ specify the current position as a place of interest and associate it with
an icon, contact details and other information.
The following table provides links to more detailed information on sections of the
-QtLocation C++ API.
+Qt Location C++ API.
\table
\row
diff --git a/doc/src/qtlocation-geoservices.qdoc b/doc/src/qtlocation-geoservices.qdoc
index 9cd9ed3e..5d86f177 100644
--- a/doc/src/qtlocation-geoservices.qdoc
+++ b/doc/src/qtlocation-geoservices.qdoc
@@ -27,13 +27,13 @@
/*!
\page qtlocation-geoservices.html
-\title QtLocation GeoServices
-\brief Implementing QtLocation GeoService plugins
+\title Qt Location GeoServices
+\brief Implementing Qt Location GeoService plugins
-The QtLocation provides the majority of its functionality through GeoService plugins. This
+The Qt Location provides the majority of its functionality through GeoService plugins. This
document outlines how to develop a new GeoService plugin.
-\section1 Implementing plugins
+\section1 Implementing Plugins
A plugin implementer needs to subclass QGeoServiceProviderFactory and as
many of the ManagerEngine classes as they want to provide implementations for.
@@ -45,7 +45,7 @@ QGeoServiceProviderFactory::createSearchManagerEngine(),
QGeoServiceProviderFactory::createMappingManagerEngine() and
QGeoServiceProviderFactory::createRoutingManagerEngine() as appropriate.
-\section3 Tile-based map convenience classes
+\section3 Tile-Based Map Convenience Classes
Most of the current tile based mapping APIs are very similar, and so we
provide a number of classes intended to make writing tile based mapping
diff --git a/doc/src/qtlocation.qdoc b/doc/src/qtlocation.qdoc
index 36b294f7..327b2a9e 100644
--- a/doc/src/qtlocation.qdoc
+++ b/doc/src/qtlocation.qdoc
@@ -26,18 +26,18 @@
****************************************************************************/
/*!
-\page qtlocation-module.html
-\title QtLocation Module
-\brief The QtLocation API provides location positioning, mapping, navigation and place search
+\page index-qtlocation-module.html
+\title Qt Location Module
+\brief The Qt Location API provides location positioning, mapping, navigation and place search
via QML and C++ interfaces.
\ingroup technology-apis
-The QtLocation API provides location positioning, mapping, navigation and place search via QML
+The Qt Location API provides location positioning, mapping, navigation and place search via QML
and C++ interfaces.
\section1 Overview
-QtLocation is split into three core sub-modules, which each have QML and C++
+Qt Location is split into three core sub-modules, which each have QML and C++
APIs.
\section3 Positioning
@@ -47,8 +47,8 @@ using GPS, GLONASS, or other available services.
\table
\row
\li Positioning introduction & overview:
- \li \l{location-positioning-qml.html}{for QML}
- \li \l{location-positioning-cpp.html}{for C++}
+ \li \l{Positioning (QML)}{for QML}
+ \li \l{Qt Location C++ API}{for C++}
\endtable
\section3 Places
@@ -61,8 +61,8 @@ a user's favorites.
\table
\row
\li Places introduction & overview:
- \li \l{location-places-qml.html}{for QML}
- \li \l{location-places-cpp.html}{for C++}
+ \li \l{QML Places API}{for QML}
+ \li \l{Places (C++)}{for C++}
\endtable
\section3 Maps & Navigation
@@ -75,12 +75,12 @@ directions).
\table
\row
\li Maps and Nav. introduction & overview:
- \li \l{location-maps-qml.html}{for QML}
- \li \l{location-maps-cpp.html}{for C++}
+ \li \l{Maps & Navigation (QML)}{for QML}
+ \li \l{Maps & Navigation (C++)}{for C++}
\endtable
-\section1 API references and examples
+\section1 API References and Examples
Alphabetized lists of all classes and elements in the API, as well as detailed
example applications to demonstrate their usage.
@@ -88,13 +88,13 @@ example applications to demonstrate their usage.
\table
\row
\li \l {QtLocation 5.x}{QML API Reference}
- \li Full list of QML elements in the QtLocation API
+ \li Full list of QML elements in the Qt Location API
\row
- \li \l {QtLocation C++ API}{C++ API Reference}
- \li Full list of C++ classes and methods in the QtLocation API
+ \li \l {Qt Location C++ API}{C++ API Reference}
+ \li Full list of C++ classes and methods in the Qt Location API
\row
- \li \l {QtLocation Examples}{Example Apps}
- \li Examples demonstrating use of the QtLocation APIs
+ \li \l {Qt Location Examples}{Example Apps}
+ \li Examples demonstrating use of the Qt Location APIs
\endtable
\section1 Plugin references and parameters
@@ -104,15 +104,15 @@ be provided to influence their behavior.
\annotatedlist QtLocation-plugins
-\section1 Porting and implementing new back-ends
+\section1 Porting and Implementing New Back-ends
For systems integrators and distributors, information relating to making
-QtLocation available for a new platform.
+Qt Location available for a new platform.
\table
\row
- \li \l {QtLocation GeoServices}{GeoServices}
- \li Information about the QtLocation GeoServices plugins
+ \li \l {Qt Location GeoServices}{GeoServices}
+ \li Information about the Qt Location GeoServices plugins
\row
\li \l {Places Backend} {Places}
\li Information for \l {Places Backend} Implementors