summaryrefslogtreecommitdiff
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
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>
-rw-r--r--examples/location/mapviewer/doc/images/mapviewer.png (renamed from src/location/doc/images/example-mapviewer.png)bin359712 -> 359712 bytes
-rw-r--r--examples/location/mapviewer/doc/src/mapviewer.qdoc (renamed from src/location/doc/src/examples/declarative-mapviewer.qdoc)2
-rw-r--r--examples/location/places/doc/images/places.png (renamed from src/location/doc/images/example-places.png)bin151611 -> 151611 bytes
-rw-r--r--examples/location/places/doc/src/places.qdoc (renamed from src/location/doc/src/examples/declarative-places.qdoc)2
-rw-r--r--examples/location/places_list/doc/images/places_list.png (renamed from src/location/doc/images/places-list.png)bin18195 -> 18195 bytes
-rw-r--r--examples/location/places_list/doc/src/places_list.qdoc (renamed from src/location/doc/src/examples/places-list.qdoc)2
-rw-r--r--examples/location/places_map/doc/images/places_map.png (renamed from src/location/doc/images/places-map.png)bin167995 -> 167995 bytes
-rw-r--r--examples/location/places_map/doc/src/places_map.qdoc (renamed from src/location/doc/src/examples/places-map.qdoc)2
-rw-r--r--examples/location/planespotter/doc/images/planespotter.pngbin0 -> 139390 bytes
-rw-r--r--examples/location/planespotter/doc/src/planespotter.qdoc (renamed from src/location/doc/src/examples/planespotter.qdoc)2
-rw-r--r--examples/positioning/geoflickr/doc/images/qml-flickr-1.jpg (renamed from src/positioning/doc/images/qml-flickr-1.jpg)bin66794 -> 66794 bytes
-rw-r--r--examples/positioning/geoflickr/doc/src/geoflickr.qdoc (renamed from src/positioning/doc/src/examples/geoflickr.qdoc)0
-rw-r--r--examples/positioning/logfilepositionsource/doc/src/logfilepositionsource.qdoc (renamed from src/positioning/doc/src/examples/logfilepositionsource.qdoc)0
-rw-r--r--examples/positioning/satelliteinfo/doc/images/example-satelliteinfo.png (renamed from src/positioning/doc/images/example-satelliteinfo.png)bin27371 -> 27371 bytes
-rw-r--r--examples/positioning/satelliteinfo/doc/src/satelliteinfo.qdoc (renamed from src/positioning/doc/src/examples/satelliteinfo.qdoc)0
-rw-r--r--examples/positioning/weatherinfo/doc/images/example-weatherinfo.png (renamed from src/positioning/doc/images/example-weatherinfo.png)bin82081 -> 82081 bytes
-rw-r--r--examples/positioning/weatherinfo/doc/src/weatherinfo.qdoc (renamed from src/positioning/doc/src/examples/weatherinfo.qdoc)0
-rw-r--r--src/location/doc/images/places-map.jpgbin48984 -> 0 bytes
-rw-r--r--src/location/doc/images/planespotter.jpgbin116116 -> 0 bytes
-rw-r--r--src/location/doc/src/example-parameters.qdocinc (renamed from src/location/doc/src/examples/example-parameters.qdocinc)0
-rw-r--r--src/location/doc/src/places.qdoc4
-rw-r--r--src/location/doc/src/qtlocation-examples.qdoc (renamed from src/location/doc/src/examples/qtlocation-examples.qdoc)0
-rw-r--r--src/positioning/doc/src/qtpositioning-examples.qdoc (renamed from src/positioning/doc/src/examples/qtpositioning-examples.qdoc)0
23 files changed, 7 insertions, 7 deletions
diff --git a/src/location/doc/images/example-mapviewer.png b/examples/location/mapviewer/doc/images/mapviewer.png
index 4dc13f72..4dc13f72 100644
--- a/src/location/doc/images/example-mapviewer.png
+++ b/examples/location/mapviewer/doc/images/mapviewer.png
Binary files differ
diff --git a/src/location/doc/src/examples/declarative-mapviewer.qdoc b/examples/location/mapviewer/doc/src/mapviewer.qdoc
index 8ba48112..e0c320c8 100644
--- a/src/location/doc/src/examples/declarative-mapviewer.qdoc
+++ b/examples/location/mapviewer/doc/src/mapviewer.qdoc
@@ -33,7 +33,7 @@
\brief The Map Viewer example shows how to display and interact with a map,
search for an address, and find driving directions.
- \image example-mapviewer.png
+ \image mapviewer.png
This is a large example covering many basic uses of maps, positioning, and
navigation services in Qt Location. This page is divided into sections
diff --git a/src/location/doc/images/example-places.png b/examples/location/places/doc/images/places.png
index 0b1ac8b7..0b1ac8b7 100644
--- a/src/location/doc/images/example-places.png
+++ b/examples/location/places/doc/images/places.png
Binary files differ
diff --git a/src/location/doc/src/examples/declarative-places.qdoc b/examples/location/places/doc/src/places.qdoc
index 414ccfca..bc93bcaf 100644
--- a/src/location/doc/src/examples/declarative-places.qdoc
+++ b/examples/location/places/doc/src/places.qdoc
@@ -33,7 +33,7 @@
\brief The Places example demonstrates how to search for Places and access
related content.
- \image example-places.png
+ \image places.png
The Places example demonstrates how to search for Places. In particular it shows
how further information such as reviews, images and related content can be retrieved.
diff --git a/src/location/doc/images/places-list.png b/examples/location/places_list/doc/images/places_list.png
index bf09a031..bf09a031 100644
--- a/src/location/doc/images/places-list.png
+++ b/examples/location/places_list/doc/images/places_list.png
Binary files differ
diff --git a/src/location/doc/src/examples/places-list.qdoc b/examples/location/places_list/doc/src/places_list.qdoc
index 7ef02b99..ee9925a1 100644
--- a/src/location/doc/src/examples/places-list.qdoc
+++ b/examples/location/places_list/doc/src/places_list.qdoc
@@ -31,7 +31,7 @@
\ingroup qtlocation-examples
\brief The Places List example demonstrates how to search for and display a list of places using a \l ListView.
- \image places-list.png
+ \image places_list.png
\include examples-run.qdocinc
diff --git a/src/location/doc/images/places-map.png b/examples/location/places_map/doc/images/places_map.png
index 4982df23..4982df23 100644
--- a/src/location/doc/images/places-map.png
+++ b/examples/location/places_map/doc/images/places_map.png
Binary files differ
diff --git a/src/location/doc/src/examples/places-map.qdoc b/examples/location/places_map/doc/src/places_map.qdoc
index 6e58bfb8..61a4be17 100644
--- a/src/location/doc/src/examples/places-map.qdoc
+++ b/examples/location/places_map/doc/src/places_map.qdoc
@@ -32,7 +32,7 @@
\brief The Places Map example demonstrates how to search for and display a list of places
on a map using a MapItemView
- \image places-map.png
+ \image places_map.png
The example displays a map of the current location or, if no position is
available, it uses Brisbane/Australia. Subsequently a search for places
diff --git a/examples/location/planespotter/doc/images/planespotter.png b/examples/location/planespotter/doc/images/planespotter.png
new file mode 100644
index 00000000..dcfd55fe
--- /dev/null
+++ b/examples/location/planespotter/doc/images/planespotter.png
Binary files differ
diff --git a/src/location/doc/src/examples/planespotter.qdoc b/examples/location/planespotter/doc/src/planespotter.qdoc
index a07eb96a..ed3a2b21 100644
--- a/src/location/doc/src/examples/planespotter.qdoc
+++ b/examples/location/planespotter/doc/src/planespotter.qdoc
@@ -33,7 +33,7 @@
\brief The \c {Plane Spotter} example demonstrates the tight integration of
location and positioning data types into QML
- \image planespotter.jpg
+ \image planespotter.png
The \c {Plane Spotter} example demonstrates how to integrate location and positioning
related C++ data types into QML and vice versa. This is useful when it is desirable to
diff --git a/src/positioning/doc/images/qml-flickr-1.jpg b/examples/positioning/geoflickr/doc/images/qml-flickr-1.jpg
index 42514ff0..42514ff0 100644
--- a/src/positioning/doc/images/qml-flickr-1.jpg
+++ b/examples/positioning/geoflickr/doc/images/qml-flickr-1.jpg
Binary files differ
diff --git a/src/positioning/doc/src/examples/geoflickr.qdoc b/examples/positioning/geoflickr/doc/src/geoflickr.qdoc
index 6d043d4d..6d043d4d 100644
--- a/src/positioning/doc/src/examples/geoflickr.qdoc
+++ b/examples/positioning/geoflickr/doc/src/geoflickr.qdoc
diff --git a/src/positioning/doc/src/examples/logfilepositionsource.qdoc b/examples/positioning/logfilepositionsource/doc/src/logfilepositionsource.qdoc
index 6b008af6..6b008af6 100644
--- a/src/positioning/doc/src/examples/logfilepositionsource.qdoc
+++ b/examples/positioning/logfilepositionsource/doc/src/logfilepositionsource.qdoc
diff --git a/src/positioning/doc/images/example-satelliteinfo.png b/examples/positioning/satelliteinfo/doc/images/example-satelliteinfo.png
index aa9a217c..aa9a217c 100644
--- a/src/positioning/doc/images/example-satelliteinfo.png
+++ b/examples/positioning/satelliteinfo/doc/images/example-satelliteinfo.png
Binary files differ
diff --git a/src/positioning/doc/src/examples/satelliteinfo.qdoc b/examples/positioning/satelliteinfo/doc/src/satelliteinfo.qdoc
index 51e40867..51e40867 100644
--- a/src/positioning/doc/src/examples/satelliteinfo.qdoc
+++ b/examples/positioning/satelliteinfo/doc/src/satelliteinfo.qdoc
diff --git a/src/positioning/doc/images/example-weatherinfo.png b/examples/positioning/weatherinfo/doc/images/example-weatherinfo.png
index 6557b57b..6557b57b 100644
--- a/src/positioning/doc/images/example-weatherinfo.png
+++ b/examples/positioning/weatherinfo/doc/images/example-weatherinfo.png
Binary files differ
diff --git a/src/positioning/doc/src/examples/weatherinfo.qdoc b/examples/positioning/weatherinfo/doc/src/weatherinfo.qdoc
index 3db6fcbf..3db6fcbf 100644
--- a/src/positioning/doc/src/examples/weatherinfo.qdoc
+++ b/examples/positioning/weatherinfo/doc/src/weatherinfo.qdoc
diff --git a/src/location/doc/images/places-map.jpg b/src/location/doc/images/places-map.jpg
deleted file mode 100644
index b5f2e35b..00000000
--- a/src/location/doc/images/places-map.jpg
+++ /dev/null
Binary files differ
diff --git a/src/location/doc/images/planespotter.jpg b/src/location/doc/images/planespotter.jpg
deleted file mode 100644
index d65a0328..00000000
--- a/src/location/doc/images/planespotter.jpg
+++ /dev/null
Binary files differ
diff --git a/src/location/doc/src/examples/example-parameters.qdocinc b/src/location/doc/src/example-parameters.qdocinc
index 2ae351ba..2ae351ba 100644
--- a/src/location/doc/src/examples/example-parameters.qdocinc
+++ b/src/location/doc/src/example-parameters.qdocinc
diff --git a/src/location/doc/src/places.qdoc b/src/location/doc/src/places.qdoc
index 291af614..72e31c9c 100644
--- a/src/location/doc/src/places.qdoc
+++ b/src/location/doc/src/places.qdoc
@@ -125,7 +125,7 @@
\li
\snippet places_list/places_list.qml Places ListView
\li
- \inlineimage places-list.png
+ \inlineimage places_list.png
\endtable
\note For simplicty's sake we have assumed that every search result is of
@@ -155,7 +155,7 @@
\li
\snippet places_map/places_map.qml Places MapItemView
\li
- \inlineimage places-map.png
+ \inlineimage places_map.png
\endtable
\note For simplicty's sake we have assumed that every search result is of
diff --git a/src/location/doc/src/examples/qtlocation-examples.qdoc b/src/location/doc/src/qtlocation-examples.qdoc
index ce4047cb..ce4047cb 100644
--- a/src/location/doc/src/examples/qtlocation-examples.qdoc
+++ b/src/location/doc/src/qtlocation-examples.qdoc
diff --git a/src/positioning/doc/src/examples/qtpositioning-examples.qdoc b/src/positioning/doc/src/qtpositioning-examples.qdoc
index 57d129a0..57d129a0 100644
--- a/src/positioning/doc/src/examples/qtpositioning-examples.qdoc
+++ b/src/positioning/doc/src/qtpositioning-examples.qdoc