summaryrefslogtreecommitdiff
path: root/src/location/maps
diff options
context:
space:
mode:
authorAaron McCarthy <aaron.mccarthy@nokia.com>2011-10-25 12:59:22 +1000
committerQt by Nokia <qt-info@nokia.com>2011-10-25 05:01:07 +0200
commit06f46c6b69a4234b3449eac5ab44989546cb52c9 (patch)
tree709cd99b8ef43309f17dc95d13aab8882b39ec4c /src/location/maps
parent53909f3cb2a02aca9f87b298b935845d9301d0d0 (diff)
downloadqtlocation-06f46c6b69a4234b3449eac5ab44989546cb52c9.tar.gz
Update structure of QtLocation documentation.
Separate out into sections for C++ and QML. Mark all classes as "since QtLocation 5.0" as there has been many API changes since Qt Mobility. Change-Id: Ie71c5f7cb8341e76d41b9fefce4781979f3e898c Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
Diffstat (limited to 'src/location/maps')
-rw-r--r--src/location/maps/qgeocodereply.cpp8
-rw-r--r--src/location/maps/qgeocodingmanager.cpp8
-rw-r--r--src/location/maps/qgeocodingmanagerengine.cpp7
-rw-r--r--src/location/maps/qgeomaneuver.cpp8
-rw-r--r--src/location/maps/qgeomappingmanager.cpp8
-rw-r--r--src/location/maps/qgeomappingmanagerengine.cpp8
-rw-r--r--src/location/maps/qgeoroute.cpp6
-rw-r--r--src/location/maps/qgeoroutereply.cpp7
-rw-r--r--src/location/maps/qgeorouterequest.cpp8
-rw-r--r--src/location/maps/qgeoroutesegment.cpp6
-rw-r--r--src/location/maps/qgeoroutingmanager.cpp8
-rw-r--r--src/location/maps/qgeoroutingmanagerengine.cpp8
-rw-r--r--src/location/maps/qgeoserviceprovider.cpp8
-rw-r--r--src/location/maps/qgeoserviceproviderfactory.cpp8
-rw-r--r--src/location/maps/qgeotiledmapreply.cpp8
15 files changed, 50 insertions, 64 deletions
diff --git a/src/location/maps/qgeocodereply.cpp b/src/location/maps/qgeocodereply.cpp
index 5182f430..50b9133a 100644
--- a/src/location/maps/qgeocodereply.cpp
+++ b/src/location/maps/qgeocodereply.cpp
@@ -45,15 +45,13 @@
QT_BEGIN_NAMESPACE
/*!
\class QGeocodeReply
+ \inmodule QtLocation
+ \ingroup QtLocation-geocoding
+ \since QtLocation 5.0
\brief The QGeocodeReply class manages an operation started by an
instance of QGeocodingManager.
-
- \inmodule QtLocation
-
- \ingroup maps-places
-
Instances of QGeocodeReply manage the state and results of these
operations.
diff --git a/src/location/maps/qgeocodingmanager.cpp b/src/location/maps/qgeocodingmanager.cpp
index fa3d30d1..5b37f61d 100644
--- a/src/location/maps/qgeocodingmanager.cpp
+++ b/src/location/maps/qgeocodingmanager.cpp
@@ -52,15 +52,13 @@ QT_BEGIN_NAMESPACE
/*!
\class QGeocodingManager
+ \inmodule QtLocation
+ \ingroup QtLocation-geocoding
+ \since QtLocation 5.0
\brief The QGeocodingManager class provides support for geocoding
operations.
-
- \inmodule QtLocation
-
- \ingroup maps-places
-
The geocode(), reverseGeocode() and search() functions return
QGeocodeReply objects, which manage these operations and report on the
result of the operations and any errors which may have occurred.
diff --git a/src/location/maps/qgeocodingmanagerengine.cpp b/src/location/maps/qgeocodingmanagerengine.cpp
index 5eaea3ff..81dd6421 100644
--- a/src/location/maps/qgeocodingmanagerengine.cpp
+++ b/src/location/maps/qgeocodingmanagerengine.cpp
@@ -49,15 +49,14 @@ QT_BEGIN_NAMESPACE
/*!
\class QGeocodingManagerEngine
+ \inmodule QtLocation
+ \ingroup QtLocation-impl
+ \since QtLocation 5.0
\brief The QGeocodingManagerEngine class provides an interface and
convenience methods to implementers of QGeoServiceProvider plugins who want
to provide support for geocoding operations.
- \inmodule QtLocation
-
- \ingroup maps-impl
-
In the default implementation, supportsGeocoding() and supportsReverseGeocoding() returns false while
geocode() and reverseGeocode()
cause QGeocodeReply::UnsupportedOptionError to occur.
diff --git a/src/location/maps/qgeomaneuver.cpp b/src/location/maps/qgeomaneuver.cpp
index c244e038..1660becd 100644
--- a/src/location/maps/qgeomaneuver.cpp
+++ b/src/location/maps/qgeomaneuver.cpp
@@ -48,12 +48,12 @@ QT_BEGIN_NAMESPACE
/*!
\class QGeoManeuver
- \brief The QGeoManeuver class represents the information relevant to the
- point at which two QGeoRouteSegments meet.
-
\inmodule QtLocation
+ \ingroup QtLocation-routing
+ \since QtLocation 5.0
- \ingroup maps-routing
+ \brief The QGeoManeuver class represents the information relevant to the
+ point at which two QGeoRouteSegments meet.
QGeoRouteSegment instances can be thought of as edges on a routing
graph, with QGeoManeuver instances as optional labels attached to the
diff --git a/src/location/maps/qgeomappingmanager.cpp b/src/location/maps/qgeomappingmanager.cpp
index b1196fb9..b9caf94f 100644
--- a/src/location/maps/qgeomappingmanager.cpp
+++ b/src/location/maps/qgeomappingmanager.cpp
@@ -53,12 +53,12 @@ QT_BEGIN_NAMESPACE
/*!
\class QGeoMappingManager
- \brief The QGeoMappingManager class provides support for displaying
- and interacting with maps.
-
\inmodule QtLocation
+ \ingroup QtLocation-maps
+ \since QtLocation 5.0
- \ingroup maps-mapping
+ \brief The QGeoMappingManager class provides support for displaying
+ and interacting with maps.
A QGeoMappingManager instance can create QGeoMapData instances with
createMapData(). The QGeoMapData instances can be used to contain and
diff --git a/src/location/maps/qgeomappingmanagerengine.cpp b/src/location/maps/qgeomappingmanagerengine.cpp
index 44b7b2c5..b6a36b9e 100644
--- a/src/location/maps/qgeomappingmanagerengine.cpp
+++ b/src/location/maps/qgeomappingmanagerengine.cpp
@@ -50,14 +50,14 @@ QT_BEGIN_NAMESPACE
/*!
\class QGeoMappingManagerEngine
+ \inmodule QtLocation
+ \ingroup QtLocation-impl
+ \since QtLocation 5.0
+
\brief The QGeoMappingManagerEngine class provides an interface and convenience methods
to implementors of QGeoServiceProvider plugins who want to provides support for displaying
and interacting with maps.
- \inmodule QtLocation
-
- \ingroup maps-impl
-
Subclasses of QGeoMappingManagerEngine need to provide an implementations
of createMapData(). The QGeoMapData instances returned by createMapData()
can be used to contain and manage information concerning what a particular
diff --git a/src/location/maps/qgeoroute.cpp b/src/location/maps/qgeoroute.cpp
index e61525d3..250c03f7 100644
--- a/src/location/maps/qgeoroute.cpp
+++ b/src/location/maps/qgeoroute.cpp
@@ -51,11 +51,11 @@ QT_BEGIN_NAMESPACE
/*!
\class QGeoRoute
- \brief The QGeoRoute class represents a route between two points.
-
\inmodule QtLocation
+ \ingroup QtLocation-routing
+ \since QtLocation 5.0
- \ingroup maps-routing
+ \brief The QGeoRoute class represents a route between two points.
A QGeoRoute object contains high level information about a route, such
as the length the route, the estimated travel time for the route,
diff --git a/src/location/maps/qgeoroutereply.cpp b/src/location/maps/qgeoroutereply.cpp
index 50f0d97d..021a7dc5 100644
--- a/src/location/maps/qgeoroutereply.cpp
+++ b/src/location/maps/qgeoroutereply.cpp
@@ -46,14 +46,13 @@ QT_BEGIN_NAMESPACE
/*!
\class QGeoRouteReply
+ \inmodule QtLocation
+ \ingroup QtLocation-routing
+ \since QtLocation 5.0
\brief The QGeoRouteReply class manages an operation started by an instance
of QGeoRoutingManager.
- \inmodule QtLocation
-
- \ingroup maps-routing
-
Instances of QGeoRouteReply manage the state and results of these
operations.
diff --git a/src/location/maps/qgeorouterequest.cpp b/src/location/maps/qgeorouterequest.cpp
index 674b68f0..bde5fd15 100644
--- a/src/location/maps/qgeorouterequest.cpp
+++ b/src/location/maps/qgeorouterequest.cpp
@@ -49,12 +49,12 @@ QT_BEGIN_NAMESPACE
/*!
\class QGeoRouteRequest
- \brief The QGeoRouteRequest class represents the parameters and restrictions
- which define a request for routing information.
-
\inmodule QtLocation
+ \ingroup QtLocation-routing
+ \since QtLocation 5.0
- \ingroup maps-routing
+ \brief The QGeoRouteRequest class represents the parameters and restrictions
+ which define a request for routing information.
The default state of a QGeoRouteRequest instance will result in a request
for basic route segment and navigation maneuvers describing the fastest
diff --git a/src/location/maps/qgeoroutesegment.cpp b/src/location/maps/qgeoroutesegment.cpp
index 9d373269..2f050487 100644
--- a/src/location/maps/qgeoroutesegment.cpp
+++ b/src/location/maps/qgeoroutesegment.cpp
@@ -49,11 +49,11 @@ QT_BEGIN_NAMESPACE
/*!
\class QGeoRouteSegment
- \brief The QGeoRouteSegment class represents a segment of a route.
-
\inmodule QtLocation
+ \ingroup QtLocation-routing
+ \since QtLocation 5.0
- \ingroup maps-routing
+ \brief The QGeoRouteSegment class represents a segment of a route.
A QGeoRouteSegment instance has information about the physcial layout
of the route segment, the length of the route and estimated time required
diff --git a/src/location/maps/qgeoroutingmanager.cpp b/src/location/maps/qgeoroutingmanager.cpp
index 36a3a12d..91261cc1 100644
--- a/src/location/maps/qgeoroutingmanager.cpp
+++ b/src/location/maps/qgeoroutingmanager.cpp
@@ -49,15 +49,13 @@ QT_BEGIN_NAMESPACE
/*!
\class QGeoRoutingManager
+ \inmodule QtLocation
+ \ingroup QtLocation-routing
+ \since QtLocation 5.0
\brief The QGeoRoutingManager class provides support for geographic routing
operations.
-
- \inmodule QtLocation
-
- \ingroup maps-routing
-
The calculateRoute() and updateRoute() methods function QGeoRouteReply
objects, which manage these operations and report on the result of the
operations and any errors which may have occurred.
diff --git a/src/location/maps/qgeoroutingmanagerengine.cpp b/src/location/maps/qgeoroutingmanagerengine.cpp
index 2c91924d..7b7abba2 100644
--- a/src/location/maps/qgeoroutingmanagerengine.cpp
+++ b/src/location/maps/qgeoroutingmanagerengine.cpp
@@ -46,16 +46,14 @@ QT_BEGIN_NAMESPACE
/*!
\class QGeoRoutingManagerEngine
+ \inmodule QtLocation
+ \ingroup QtLocation-impl
+ \since QtLocation 5.0
\brief The QGeoRoutingManagerEngine class provides an interface and
convenience methods to implementers of QGeoServiceProvider plugins who want
to provide access to geographic routing information.
-
- \inmodule QtLocation
-
- \ingroup maps-impl
-
Subclasses of QGeoRoutingManagerEngine need to provide an implementation of
calculateRoute().
diff --git a/src/location/maps/qgeoserviceprovider.cpp b/src/location/maps/qgeoserviceprovider.cpp
index e00a6edc..062e7d9b 100644
--- a/src/location/maps/qgeoserviceprovider.cpp
+++ b/src/location/maps/qgeoserviceprovider.cpp
@@ -71,12 +71,12 @@ QT_BEGIN_NAMESPACE
/*!
\class QGeoServiceProvider
- \brief The QGeoServiceProvider class aggregates access to services which provide
- geographical information.
-
\inmodule QtLocation
+ \ingroup QtLocation-common
+ \since QtLocation 5.0
- \ingroup maps
+ \brief The QGeoServiceProvider class aggregates access to services which provide
+ geographical information.
The Maps and Navigation API allows people to access various kinds of
geographical information, including functionality to perform geocoding,
diff --git a/src/location/maps/qgeoserviceproviderfactory.cpp b/src/location/maps/qgeoserviceproviderfactory.cpp
index a113de53..e9a7891a 100644
--- a/src/location/maps/qgeoserviceproviderfactory.cpp
+++ b/src/location/maps/qgeoserviceproviderfactory.cpp
@@ -45,15 +45,13 @@ QT_BEGIN_NAMESPACE
/*!
\class QGeoServiceProviderFactory
+ \inmodule QtLocation
+ \ingroup QtLocation-impl
+ \since QtLocation 5.0
\brief The QGeoServiceProviderFactory class is a factory class used as the
plugin interface for services related to geographical information.
-
- \inmodule QtLocation
-
- \ingroup maps-impl
-
Implementers must provide a unique combination of providerName() and
providerVersion() per plugin.
diff --git a/src/location/maps/qgeotiledmapreply.cpp b/src/location/maps/qgeotiledmapreply.cpp
index 282cfea0..400a0713 100644
--- a/src/location/maps/qgeotiledmapreply.cpp
+++ b/src/location/maps/qgeotiledmapreply.cpp
@@ -47,15 +47,13 @@
QT_BEGIN_NAMESPACE
/*!
\class QGeoTiledMapReply
+ \inmodule QtLocation
+ \ingroup QtLocation-impl
+ \since QtLocation 5.0
\brief The QGeoTiledMapReply class manages a tile fetch operation started
by an instance of QGeoTiledManagerEngine.
- \inmodule QtLocation
-
- \ingroup maps-impl-tiled
-
-
Instances of QGeoTiledMapReply manage the state and results of these
operations.