diff options
author | Alex Blasche <alexander.blasche@digia.com> | 2013-07-01 15:14:32 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-07-12 15:00:17 +0200 |
commit | 7197e14116c4e214efc5e8c6a0a6ab6a7990a634 (patch) | |
tree | 4d62acc4500124042e8fd7978c5e601d42d775dd /src/location/doc/src/qtlocation-geoservices.qdoc | |
parent | c955dcea2df9378a45d53d5556a1f726bcf05306 (diff) | |
download | qtlocation-7197e14116c4e214efc5e8c6a0a6ab6a7990a634.tar.gz |
Fix QtLocation documentation
This moves the docs to its proper place and fixes content as well as
broken links.
There are still some warnings left.
Change-Id: Ie83086f4feabab5f3b3d6c92eb6b401a5ff43e29
Reviewed-by: Alex <alexander.blasche@digia.com>
Diffstat (limited to 'src/location/doc/src/qtlocation-geoservices.qdoc')
-rw-r--r-- | src/location/doc/src/qtlocation-geoservices.qdoc | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/src/location/doc/src/qtlocation-geoservices.qdoc b/src/location/doc/src/qtlocation-geoservices.qdoc new file mode 100644 index 00000000..7adb9b18 --- /dev/null +++ b/src/location/doc/src/qtlocation-geoservices.qdoc @@ -0,0 +1,62 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\page qtlocation-geoservices.html +\title Qt Location GeoServices +\brief Implementing Qt Location GeoService plugins + +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 + +A plugin implementer needs to subclass QGeoServiceProviderFactory and as +many of the ManagerEngine classes as they want to provide implementations for. + +Subclassing QGeoServiceProviderFactory will only involve exposing a name and +a version by overriding QGeoServiceProviderFactory::providerName() and +QGeoServiceProviderFactory::providerVersion(), and overriding +QGeoServiceProviderFactory::createSearchManagerEngine(), +QGeoServiceProviderFactory::createMappingManagerEngine() and +QGeoServiceProviderFactory::createRoutingManagerEngine() as appropriate. + +\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 +plugins much simpler. + +If the Mercator projection and the most common tile addressing scheme is used this will mainly +involve subclassing QGeoTiledMappingManagerEngine and providing an implementation of +QGeoTiledMappingManagerEngine::getTileImage(). + +\section1 GeoService Classes + +\annotatedlist QtLocation-impl + +*/ |