diff options
author | Jerome Pasion <jerome.pasion@digia.com> | 2014-04-09 11:44:19 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-04-14 06:47:15 +0200 |
commit | 8ff60b5f3b45457a180bd72e1b8ea84cd397d249 (patch) | |
tree | 5c13dcfec8b167db9325ad8128286da0af26b4f6 | |
parent | 3535f5f40c2e4e2cb3ddb8cbe9c1c95dba62150c (diff) | |
download | qtlocation-8ff60b5f3b45457a180bd72e1b8ea84cd397d249.tar.gz |
Doc: Edited Qt Positioning example pages
-added information on how to run the example
(using an included file in qtbase/doc/global)
-section changes and linked to module landing page.
-assigning default thumbnail to an example.
-updated copyright year in touched files.
Task-number: QTBUG-33597
Change-Id: I6e78c3016d3f51dd99466ee37eff9632eb050d84
Reviewed-by: Alex Blasche <alexander.blasche@digia.com>
Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
5 files changed, 17 insertions, 10 deletions
diff --git a/src/positioning/doc/qtpositioning.qdocconf b/src/positioning/doc/qtpositioning.qdocconf index 10e7b19f..e2c0cc4b 100644 --- a/src/positioning/doc/qtpositioning.qdocconf +++ b/src/positioning/doc/qtpositioning.qdocconf @@ -55,3 +55,5 @@ imagedirs += images navigation.landingpage = "Qt Positioning" navigation.cppclassespage = "Qt Positioning C++ Classes" navigation.qmltypespage = "Qt Positioning QML Types" + +manifestmeta.thumbnail.names += "QtPositioning/Log File*" diff --git a/src/positioning/doc/src/examples/declarative-flickr.qdoc b/src/positioning/doc/src/examples/declarative-flickr.qdoc index af8f4680..a1d0bb58 100644 --- a/src/positioning/doc/src/examples/declarative-flickr.qdoc +++ b/src/positioning/doc/src/examples/declarative-flickr.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2014 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. @@ -34,7 +34,7 @@ fetch local content from a web service. This is a small example, illustrating one of the very core parts of the - Qt Positioning API: the ability to retrieve and use the user's current + \l{Qt Positioning} API: the ability to retrieve and use the user's current geographic position. Key QML types shown in this example: @@ -45,7 +45,9 @@ \image qml-flickr-1.jpg - \section2 Retrieving the Current Position + \include examples-run.qdocinc + + \section1 Retrieving the Current Position Retrieving the user's current position is achieved using the PositionSource type. In this example, we instantiate the PositionSource as part of the @@ -67,7 +69,7 @@ \snippet flickr/flickrmobile/GeoTab.qml props - \section2 Using the Current Position + \section1 Using the Current Position The longitude and latitude values retrieved here are eventually set on in properties on the RestModel component. The RestModel is an XmlListModel, diff --git a/src/positioning/doc/src/examples/qtpositioning-examples.qdoc b/src/positioning/doc/src/examples/qtpositioning-examples.qdoc index ac1d79ec..331c5536 100644 --- a/src/positioning/doc/src/examples/qtpositioning-examples.qdoc +++ b/src/positioning/doc/src/examples/qtpositioning-examples.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2014 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. @@ -32,7 +32,6 @@ \ingroup all-examples \ingroup qtpositioning - These are the Qt Positioning examples. + These are the \l{Qt Positioning} examples. */ - diff --git a/src/positioning/doc/src/examples/satelliteinfo.qdoc b/src/positioning/doc/src/examples/satelliteinfo.qdoc index 1edb8f6c..6a3ee8cb 100644 --- a/src/positioning/doc/src/examples/satelliteinfo.qdoc +++ b/src/positioning/doc/src/examples/satelliteinfo.qdoc @@ -35,7 +35,7 @@ \ingroup qtpositioning-examples - Key Qt Positioning classes used in this example: + Key \l{Qt Positioning} classes used in this example: \list \li \l{QGeoSatelliteInfo} @@ -70,4 +70,6 @@ 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 */ diff --git a/src/positioning/doc/src/examples/weatherinfo.qdoc b/src/positioning/doc/src/examples/weatherinfo.qdoc index 0c98cc04..a836d028 100644 --- a/src/positioning/doc/src/examples/weatherinfo.qdoc +++ b/src/positioning/doc/src/examples/weatherinfo.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2014 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. @@ -34,7 +34,7 @@ \ingroup qtpositioning-examples - Key Qt Positioning classes used in this example: + Key \l{Qt Positioning} classes used in this example: \list \li \l{QGeoPositionInfo} @@ -43,6 +43,8 @@ \image ../images/example-weatherinfo.png + \include examples-run.qdocinc + The key part of this example is the application's data model, contained in the WeatherData and AppModel classes. WeatherData represents the weather information taken from the HTTP service. It is a simple data class, but we |