summaryrefslogtreecommitdiff
path: root/src/location/doc/src/qtlocation-cpp.qdoc
diff options
context:
space:
mode:
authorAlex Blasche <alexander.blasche@digia.com>2013-07-01 15:14:32 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-07-12 15:00:17 +0200
commit7197e14116c4e214efc5e8c6a0a6ab6a7990a634 (patch)
tree4d62acc4500124042e8fd7978c5e601d42d775dd /src/location/doc/src/qtlocation-cpp.qdoc
parentc955dcea2df9378a45d53d5556a1f726bcf05306 (diff)
downloadqtlocation-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-cpp.qdoc')
-rw-r--r--src/location/doc/src/qtlocation-cpp.qdoc96
1 files changed, 96 insertions, 0 deletions
diff --git a/src/location/doc/src/qtlocation-cpp.qdoc b/src/location/doc/src/qtlocation-cpp.qdoc
new file mode 100644
index 00000000..c13360b5
--- /dev/null
+++ b/src/location/doc/src/qtlocation-cpp.qdoc
@@ -0,0 +1,96 @@
+/****************************************************************************
+**
+** 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-cpp.html
+\title Qt Location C++ API
+\brief Information about the Qt Location C++ API
+
+The Location API provides a library for location positioning, mapping and navigation.
+
+\tableofcontents
+
+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
+NMEA formatted text. Once a position is acquired we can monitor the updated
+position to see if it moves into or out of a given region. With the Maps API
+we can associate the position with a map in various formats supplied by a backend.
+Then the Places API could be used to populate places on the Map or even
+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
+Qt Location C++ API.
+
+\table
+ \row
+ \li \l {Positioning (C++)}{Location Positioning}
+ \li Retrieving information about the current position.
+ \row
+ \li \l {Maps and Navigation (C++)}{Maps and Navigation}
+ \li Displaying maps and finding routes.
+ \row
+ \li \l {Places (C++)} {Places}
+ \li Searching for and managing points of interest.
+ \row
+ \li \l {Qt Location GeoServices}{Geoservices and Positioning Plugin Implementation}
+ \li Implement new geoservices and positioning plugins.
+\endtable
+
+
+\section1 Positioning Classes
+
+ \annotatedlist QtLocation-positioning
+
+
+\section1 Geoservice Provider Classes
+
+ \annotatedlist QtLocation-common
+
+
+\section1 Maps and Navigation Classes
+
+ \annotatedlist QtLocation-maps
+
+ \annotatedlist QtLocation-routing
+
+ \annotatedlist QtLocation-geocoding
+
+
+\section1 Places Classes
+
+ \annotatedlist QtLocation-places
+
+
+\section1 Geoservices and Positioning Plugin Classes
+
+ \annotatedlist QtLocation-impl
+
+*/
+