summaryrefslogtreecommitdiff
path: root/src/location/doc/src/plugins/osm.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/plugins/osm.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/plugins/osm.qdoc')
-rw-r--r--src/location/doc/src/plugins/osm.qdoc55
1 files changed, 55 insertions, 0 deletions
diff --git a/src/location/doc/src/plugins/osm.qdoc b/src/location/doc/src/plugins/osm.qdoc
new file mode 100644
index 00000000..752454d4
--- /dev/null
+++ b/src/location/doc/src/plugins/osm.qdoc
@@ -0,0 +1,55 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Aaron McCarthy <mccarthy.aaron@gmail.com>
+** 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 location-plugin-osm.html
+\title Qt Location Open Street Map Plugin
+\ingroup QtLocation-plugins
+
+\brief Uses Open Street Map and related services.
+
+\section1 Overview
+
+This geo services plugin allows applications to access
+\l {http://openstreetmap.org}{Open Street Map} location based services using the Qt Location API.
+
+The Open Street Map geo services plugin can be loaded by using the plugin key "osm".
+
+\section1 Parameters
+
+\section2 Optional parameters
+The following table lists optional parameters that can be passed to the Open Street Map plugin.
+\table
+\header
+ \li Parameter
+ \li Description
+\row
+ \li useragent
+ \li User agent string set when making network requests. This parameter should be set to a
+ value that uniquely identifies the application.
+\endtable
+*/