summaryrefslogtreecommitdiff
path: root/examples/positioning/satelliteinfo
diff options
context:
space:
mode:
authorMichal Klocek <michal.klocek@theqtcompany.com>2016-02-24 12:26:27 +0100
committerMichal Klocek <michal.klocek@theqtcompany.com>2016-02-26 12:08:19 +0000
commit3a9590241cf54eccb9d28957c3d58268e0d23b60 (patch)
tree58af4b96b308e22592845612e2ec251d807e54b1 /examples/positioning/satelliteinfo
parentd3b4d490599d9846cf5a43526493cb0072012913 (diff)
downloadqtlocation-3a9590241cf54eccb9d28957c3d58268e0d23b60.tar.gz
Update examples documentation location
The current way of documenting examples is to include qdoc and images source into example directory. Fix examples in location and positioning. Replace planespotter.jpg with png. Change-Id: I4eeacbfa575e7ae3ef747703348f2f201899e548 Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
Diffstat (limited to 'examples/positioning/satelliteinfo')
-rw-r--r--examples/positioning/satelliteinfo/doc/images/example-satelliteinfo.pngbin0 -> 27371 bytes
-rw-r--r--examples/positioning/satelliteinfo/doc/src/satelliteinfo.qdoc75
2 files changed, 75 insertions, 0 deletions
diff --git a/examples/positioning/satelliteinfo/doc/images/example-satelliteinfo.png b/examples/positioning/satelliteinfo/doc/images/example-satelliteinfo.png
new file mode 100644
index 00000000..aa9a217c
--- /dev/null
+++ b/examples/positioning/satelliteinfo/doc/images/example-satelliteinfo.png
Binary files differ
diff --git a/examples/positioning/satelliteinfo/doc/src/satelliteinfo.qdoc b/examples/positioning/satelliteinfo/doc/src/satelliteinfo.qdoc
new file mode 100644
index 00000000..51e40867
--- /dev/null
+++ b/examples/positioning/satelliteinfo/doc/src/satelliteinfo.qdoc
@@ -0,0 +1,75 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** 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 The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/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$
+**
+****************************************************************************/
+
+/*!
+ \example satelliteinfo
+ \title SatelliteInfo (C++/QML)
+
+ \brief The SatelliteInfo example shows how the available satellites
+ at the user's current position and marks the satellites
+ currently contributing to the GPS fix as pink.
+
+ \ingroup qtpositioning-examples
+
+ Key \l{Qt Positioning} classes used in this example:
+
+ \list
+ \li \l{QGeoSatelliteInfo}
+ \li \l{QGeoSatelliteInfoSource}
+ \endlist
+
+ \image ../images/example-satelliteinfo.png
+
+ The example displays the signal strength of all satellites in view. Any satellite
+ that is currently used to calculate the GPS fix has been marked pink. The number at
+ the bottom of each signal bar is the individual satellite identifier.
+
+ The application operates in three different modes:
+
+ \table
+ \header
+ \li Application mode
+ \li Description
+ \row
+ \li running
+ \li The application continuously queries the system for satellite updates. When new data
+ is available it will be displayed.
+ \row
+ \li stopped
+ \li The application stops updating the satellite information.
+ \row
+ \li single
+ \li The application makes a single update request with a timeout of 10s. The display
+ remains empty until the request was answered by the system.
+ \endtable
+
+ If the platform does not provide satellite information the application automatically
+ switches into a demo mode whereby it continuously switches between predefined
+ sets of satellite data.
+
+ \include examples-run.qdocinc
+*/