summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Update copyright year to 2013Sergio Ahumada2013-06-1335-35/+35
| | | | | Change-Id: I5b0cb7d56997ad7b91c073b3e02b31d0368fdcfa Reviewed-by: Alex <alexander.blasche@digia.com>
* Doc: Replaced the HTTPS link with HTTPVenu2013-05-141-1/+1
| | | | | | | | | | | The HTTPS links fail in Qt Assistant on Windows as the qt installation package includes qt libraries that are built without SSL support for legal reasons. Task-number: QTBUG-31073 Change-Id: I86f13ad2e871bd1aee8ebe39ebc0d8fc26cf2f20 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Open Street Maps plugin.Aaron McCarthy2013-02-201-0/+56
| | | | | | | | A geo services plugin for Open Street Maps. Plugin currently only supports fetching online map tiles. Change-Id: I2a80633554d4049872fc58e48ff6b273dc1ea688 Reviewed-by: Alex <ablasche@gmail.com>
* Rename namespace QtLocation -> QLocationSze Howe Koh2013-02-051-3/+3
| | | | | | | | | | | | | | Main code, tests and docs updated. For consistency (with minimal disruption to the Qt 5.0.0 release), namespaces with a "Qt" prefix were renamed. Part of the Header Consistency Project (http://lists.qt-project.org/pipermail/development/2012-October/007570.html) Change-Id: Ic728cbbe39e0140dca1cdee24257dda095c9a478 Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Aaron McCarthy <mccarthy.aaron@gmail.com>
* Change copyright from 2012 to 2013Rainer Keller2013-01-171-1/+1
| | | | | Change-Id: I61ae1bd1a9f68d120d4e11635f306374b1f494d0 Reviewed-by: Aaron McCarthy <mccarthy.aaron@gmail.com>
* make use of qtHaveModule()Oswald Buddenhagen2013-01-081-1/+1
| | | | | | Change-Id: Ifd6b6040bd00357bf658f5b51215d4208823bab1 Reviewed-by: Tasuku Suzuki <stasuku@gmail.com> Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* Update docs after modularization of docsTor Arne Vestbø2012-10-114-752/+3
| | | | | | | | The global files now live in qtbase only, and are made available to the other modules via the $QT_INSTALL_DOCS variable. Change-Id: I4f50f27ded5e0d63e964770d78e92b71f39af680 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Added Qt Location to 'qmlmodules' group.Jerome Pasion2012-10-041-3/+4
| | | | | | | | -'qmlmodules' contains all QML API in Qt -modified the brief description to be consistent with other modules Change-Id: Ic1d73e0a23af927e51bf1ca99c86ce02788d0594 Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
* Doc: Adding documentation templates from qtbaseJerome Pasion2012-09-263-0/+751
| | | | | | Task-number: QTBUG-27293 Change-Id: Iac50ca403e2551c18e8031e5a98430f40f698f6a Reviewed-by: Martin Smith <martin.smith@digia.com>
* Change copyrights from Nokia to DigiaIikka Eklund2012-09-2439-407/+407
| | | | | | | | Change copyrights and license headers from Nokia to Digia Change-Id: Ic1390da64a219642fa1e1482a7677a4c2db15cbc Reviewed-by: Janne Anttila <janne.anttila@digia.com> Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Convert GeoShape, GeoRectangle and GeoCircle into QML value types.v5.0.0-beta1Aaron McCarthy2012-08-283-46/+2
| | | | | | | | | | | | | This replaces the GeoShape, GeoRectangle and GeoCircle QML elements with value types. A value type is a better fit for shape types. It is very similar to a rect with some utility functions. Declare QGeoShape, QGeoRectangle and QGeoCircle as movable types. Update documentation. Change-Id: Id6c48e1e841c68f2f0c5c6a9c4a6580a57e2dfb6 Reviewed-by: abcd <amos.choy@nokia.com>
* Document attributes provided by nokia pluginabcd2012-08-261-1/+11
| | | | | Change-Id: I5b48a8bd6e036b96b4b6fe8e745a4193c7521786 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Document how to assign and write a PlaceAttributeabcd2012-08-261-0/+13
| | | | | Change-Id: Iaa01b4a5a864c9fe6f15773edbf6f2c82d29f2e8 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Convert Coordinate into a QML coordinate value type.Aaron McCarthy2012-08-249-52/+49
| | | | | | | | | | | | | | This replaces the Coordinate QML element with a value type. A value type is a better fit for a coordinate. It is very similar to a vector3d except it has an explicit coordinate system and some utility functions. Declare QGeoCoordinate as a movable type. Update documentation. Change-Id: I758fa9dfd7154a4d60fb791fe553b9fee3164c2c Reviewed-by: abcd <amos.choy@nokia.com>
* Remove image place holders from documentationabcd2012-08-231-6/+0
| | | | | | | | | QTBUG-26950 has been created to keep track of the task of creating useful diagrams/images to represent the purpose of the sub-modules. Change-Id: I229eabf425d9b307a769d1adf387bfcf75e5709e Reviewed-by: Peter Yard <peter.yard@nokia.com> Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Docs: change inappropriate references to 'element'.Peter Yard2012-08-229-72/+72
| | | | | | | | | | | | | 'element' is no longer a correct term for Qt Quick/QML types. Sometimes the term was used instead of 'type' and other times when 'object' would be better. Conflicts: doc/src/places.qdoc Change-Id: I299e96fe628b43abeb3079c5d0dea483c02f7ee3 Reviewed-by: Peter Yard <peter.yard@nokia.com>
* Refactor quickstart documentation to reference simple examplesabcd2012-08-177-57/+252
| | | | | | | | | | | | | | | -Introduce places_list and places_map examples As long as app id and token parameters have been supplied to place-list.qml and places-map.qml, those examples are self-contained runnable scripts. -Refactor quickstart structure into an introduction of concepts and then common use cases. Reference snippets from the above examples, as opposed to a file containing unrelated unrunnable code snippets. -Add screenshots showing the results of the snippet code. Change-Id: I402995708a0040441ea079ba0fcfdee3ae61ac40 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Document how a Loader can be used to create delegatesabcd2012-08-172-1/+114
| | | | | | | | | A newcomer to the Places API will wonder how to to create a delegate that will customise itself for different result types. Show how a Loader can be used to achieve this. Change-Id: I2d8add3c44a7f914e9379c9a6e5602a13d604a22 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* General doc fixes.Peter Yard2012-08-141-38/+73
| | | | | Change-Id: I49a343372fdb0f579dd1849d9bb66bcc8f12db7c Reviewed-by: Peter Yard <peter.yard@nokia.com>
* Fix Docsabcd2012-08-101-1/+1
| | | | | | | The nokia plugin does support icons. Change-Id: Ie7c67023ec9138ca12d2da28d391cbbc2c43e173 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Fix docsabcd2012-08-061-2/+2
| | | | | | | | The location bounding box is a recommended viewing region not the physical region occupied by the location. Change-Id: I64a4bf953f0ee0011412fe8363f5cb38040b16fa Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Make comment of snippet more understandableabcd2012-08-061-1/+2
| | | | | Change-Id: I65748c1ae036756ff8c164d6b6ca47db93bf91a2 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Separate plugin implementation into its own section.Aaron McCarthy2012-08-061-4/+13
| | | | | Change-Id: I9a15e2bb46d35cdf616139818af7164e1965e553 Reviewed-by: Alex <alex.blasche@nokia.com>
* Document the usage of plugin parameters more explicitly.abcd2012-07-193-16/+33
| | | | | | | | This is especially important when writing about the nokia plugin since it requires an app id and token. Change-Id: I202a4df05d1d42cf6d3ca10da516b5d9e829c83f Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Rename nokia_places_jsondb to places_jsondbabcd2012-07-172-2/+2
| | | | | Change-Id: Id3d5a0dd04d399ccb5252c3820f76102144f2802 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Inter-module documentation link fixes.Aaron McCarthy2012-07-163-9/+12
| | | | | | | | | | | Set the depends variable in qtlocation.qdocconf to read index files from qtcore, qtnetwork, qtqml and qtquick so that links to documentation in those modules are correctly generated. Fix up remaining broken links even with the above. Change-Id: Ided2b04423088a05c5f2bdf148972e15148dc80a Reviewed-by: Alex <alex.blasche@nokia.com>
* Remove support for old compat qdoc commands.Aaron McCarthy2012-07-165-37/+5
| | | | | | | | | | | | The \i command is not used in any Qt Location documentation and the presence of the above macro definitions generates spurious qdoc warnings. Fix the last few remaining uses of these compat commands and remove the compat.qdocconf file. Change-Id: Icb1c9aa131cf93e19f32db5359c26c1338b26dfd Reviewed-by: Alex <alex.blasche@nokia.com>
* Remove uses of deprecated MapPinchArea and MapFlickable.Aaron McCarthy2012-07-062-13/+7
| | | | | | | | These elements/properties are deprecated use the MapGestureArea and gesture properties instead. Change-Id: I755e69f6394dda7a92c33aa1fe37efcfd84aa9ff Reviewed-by: Ian Chen <ian.1.chen@nokia.com>
* Remove unneeded directories from documentation sources.Aaron McCarthy2012-07-021-4/+2
| | | | | | | | Remove qtdeclarative from the list of source directories used to generate documentation. Change-Id: I21e68f10e7c264fb64fb2c14bd2129afdada1322 Reviewed-by: Alex <alex.blasche@nokia.com>
* Generate QtLocation docs the way all modules do italex2012-06-282-39/+1
| | | | | Change-Id: Id24f6db2a53d5fbd0a3fdf5f493096e0c4838d7d Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Add section about relevancy hints for nokia pluginabcd2012-06-261-0/+4
| | | | | | | | | Although there is a table entry that says relevancy hints are not supported, Provide an explicit paragraph in the docs mentioning this. Change-Id: Ie9c27b861d042dbc8b7427203cd3bf7697249c0a Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Update search result documentationabcd2012-06-251-0/+12
| | | | | Change-Id: Id97a35b747fe900e76796ca08e7dc874dbdfa0c1 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Documentation fixes.Aaron McCarthy2012-06-222-9/+9
| | | | | | | | | | - Fix broken links. - Add missing documentation for Plugin::supports*() methods. - Remove references to PlaceRecommendationModel Change-Id: Id60292d1409fccf24ceded6829ae808a8335a03c Reviewed-by: Alex Wilson <alex.wilson@nokia.com> Reviewed-by: Alex <alex.blasche@nokia.com>
* Documentation fixes.Aaron McCarthy2012-06-228-103/+83
| | | | | | | | | | | | | | | This commit fixes the following qdoc errors: - Linking to examles. - execute() -> update() function renaming (broken links). - supportedPlacesFeatures() -> supportsPlaces(). - Broken link to jsondb plugin. - Move log file position source doc into the example. - Various broken links. Change-Id: If45a9a2bfde8c8ef504df3568ec839f0532a28fd Reviewed-by: abcd <amos.choy@nokia.com> Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Fix broken links to plugin documentation.Aaron McCarthy2012-06-224-3/+6
| | | | | | | Fix broken links to the list of available geo services plugins. Change-Id: I852d37273abea62b9051cf4d2cb311b7512129ff Reviewed-by: abcd <amos.choy@nokia.com>
* Doc rephrasing for placesabcd2012-06-211-8/+8
| | | | | | | | De-emphasize landmarks since qt 5.0 doesn't provide a plugin to support saving of local places, which is what landmarks was for. Change-Id: Ifc72b1acaccbf5356831e5738e03959790a6e1d9 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Don't use deprecated qdoc3 anymore.alex2012-06-211-2/+2
| | | | | | | qdoc is part of qtbase now. Change-Id: Iffa21db8cbcc5f885a146e0e2c03ea450bbde57e Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Refactor recommendationsabcd2012-06-215-82/+6
| | | | | | | | Recommendations can be incorporated into ordinary searches. this is more convenient for the developer. Change-Id: Ifd3e040b6b7a964227981175b074ca4f52d7579c Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Document restrictions on extended attributes and contentabcd2012-06-211-1/+10
| | | | | | | | These restrictions only apply to the nokia plugin regarding places. Change-Id: Ibfbc199fd1344f76b54a727e04eb6a62646d5fda Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com> Reviewed-by: Alex <alex.blasche@nokia.com>
* Fix up documentation.Aaron McCarthy2012-06-217-176/+72
| | | | | | | | | | | | | | | | - Fix snippet inclusion, incorrect path. - Remove duplicate code from docs, use snippets from examples instead. - Fix broken links. - Missing C++ class in QML docs. - \bold -> \b - Fix qdoc warning about \qmlslot and \qmlmethod. - These slots don't need to be slots, change them to Q_INVOKABLES and document them as \qmlmethod. - Remove unneeded signal documentation, it is covered by the property documentation. Change-Id: I19aa35d7db999057f7e647bd61371332ab26170f Reviewed-by: Ian Chen <ian.1.chen@nokia.com>
* Rename QGeoBoundingArea and related classes to QGeoShape.Aaron McCarthy2012-06-215-38/+38
| | | | | | | | | | | | | | | | | | | | | QGeoBoundingArea is used for describing more than just a bounding area. Renaming it to a more appropriate name, QGeoShape. The same is done for subclasses and QML equivalents. In C++: QGeoBoundingArea -> QGeoShape QGeoBoundingCircle -> QGeoCircle QGeoBoundingBox -> QGeoRectangle In QML: BoundingArea -> GeoShape BoundingCircle -> GeoCircle BoundingBox -> GeoRectangle Change-Id: I93c6df8f1b6c5179ed52fd8354a05f709063b1cf Reviewed-by: abcd <amos.choy@nokia.com>
* Refactor Search Resultsabcd2012-06-201-9/+14
| | | | | | | | The different types of search results should be spearated into different classes. Change-Id: I21f43e7979f9f0ae1dfb51e0b619a7c855a469bb Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Document jsondb plugin as technical preview onlyabcd2012-06-192-5/+10
| | | | | Change-Id: I94b24066e3d0b0f7dd0408fa4208fd25535955f1 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Remove correctionsabcd2012-06-145-40/+1
| | | | | | | | | | | | The new REST server doesn't support did you mean corrections. This combined with the fact that a more generic solution to provide corrections is intended to be provided later on means that it is not worthwhile providing corrections as they are currently implemented, they will soon be deprecated anyway. Change-Id: I674aba99dc3cdc0eb0fc48d928a2146f5e792a2f Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* New triangulator for map polygonsAlex Wilson2012-05-242-2/+4
| | | | | | | | | | | | | | | Replacing the qTriangulate call with poly2tri. This is a BSD-licensed triangulation library that gives better performance for most of our shapes. See http://pastie.org/3893553 for a timing comparison on linux-x86 (timing is given for the whole screen transformation step) The BSD-licensed code is isolated into its own dir (in src/3rdparty) and compiled as a separate static library to be linked in. The files have been renamed (.cc => .cpp) and doubles changed to floats, but are otherwise identical to those found at http://code.google.com/p/poly2tri/ Change-Id: Ib07aadafdc5d4b8ac1024e1eecd70ab39f673197 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Docs: Bug-5818 fixes.Peter Yard2012-05-216-53/+85
| | | | | | Change-Id: I25e95e07ecaf1c368029741a81f7385eed801316 Reviewed-by: Peter Yard <peter.yard@nokia.com> Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Renamed terms and conditions as Nokia.Chris Axiarlis2012-05-161-2/+2
| | | | | | | | | The OVI name was discontinued last year. This change reflects this change. Also the product is no longer called mobility. Change-Id: Ib6653eef8ad117f8bfd527719994661223d6c6e9 Reviewed-by: abcd <amos.choy@nokia.com> Reviewed-by: Alex <alex.blasche@nokia.com>
* Coding style fixes, round #1Alex Wilson2012-05-151-0/+3
| | | | | | | | | | | In this patch: * Assignment operators that don't check for self-assignment * Using const references where possible in function arguments * Using const refs in the iterator var of a foreach() loop * Add 'explicit' to constructors taking one parameter Change-Id: I640fd85c3312851f0d8c10193333efec41232e05 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Rename Place*Model::execute() to update().Aaron McCarthy2012-05-101-3/+3
| | | | | Change-Id: I9d0c37bb4edd521d02db814964ea195420e03308 Reviewed-by: abcd <amos.choy@nokia.com>
* Updated cache sizes documentationCristian Adam2012-05-031-2/+2
| | | | | | | | The cache sizes were modified in #change,24321 but the documetation was updated. Change-Id: I1c9213bb29a374a9c7592133262d3fee28d8a7e3 Reviewed-by: Alex Wilson <alex.wilson@nokia.com>
View Lorry Controller Status