summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* Docs: Bug-6690 fixes. General doc fixes.Peter Yard2012-05-033-10/+46
| | | | | | Change-Id: I93680ae2da913b67e8a2c22826f43f84ecb4c863 Reviewed-by: abcd <amos.choy@nokia.com> Reviewed-by: Peter Yard <peter.yard@nokia.com>
* Use local icons if possible and enable choosing of themes.abcd2012-05-011-0/+36
| | | | | | | | | | If no theme is provided the platform theme is used. A developer can explicitly request to use the non-platform specific default theme by specifying a theme plugin parameter of "default" Change-Id: I92b9f6511cdce7aa95ea7e67c731c6d63c8783f3 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Docs: changes for Bug-6687Peter Yard2012-04-163-27/+36
| | | | | Change-Id: If8eb787149e66fdb14211043c49ee0a59bb1cb3c Reviewed-by: Peter Yard <peter.yard@nokia.com>
* Document requirements of the Nokia plugin.Aaron McCarthy2012-04-043-11/+52
| | | | | | | | | | | | | | The nokia plugin requires an app_id and token pair. Document how to obtain these. Create a new page which contains the Nokia services terms and conditions which must be agreed to before the Nokia plugin can be used. Having these terms and conditions only in the Qt Location source code means they are generally inaccessible to most developers. Include them in the documentation as well. Change-Id: I94b6bb1b9d511fe4c7ea5f831d3f9599dee37f5a Reviewed-by: Alex <alex.blasche@nokia.com>
* Documentation Fixesabcd2012-04-042-17/+39
| | | | | | | | | | | | | | | | | | | -More specific documentation about plugin behaviours capabilities -Remove mention of Places vs addresses since in v2 both places and addresses have place ids -better explanations for distance, paging and execute in recommendation model -better explanations for distance, paging and execute in search model [85]->done [86]->done [87]->done [88]->done [90]->done Change-Id: Ice352488d8c0d3e016e11fbdd8d596898ac4410e Reviewed-by: Alex <alex.blasche@nokia.com>
* Tile cache size control using plugin paramsCristian Adam2012-04-041-10/+11
| | | | | | | | Also separates handling of the minimum texture cache size (based on viewport dimensions) from the maximum allowed value. Change-Id: I3b4ff5f9e1d017d7137ff8d01d4977ae59de7181 Reviewed-by: Alex Wilson <alex.wilson@nokia.com>
* Docs: added discussion of basic concepts, getting started and new since Qt4.Peter Yard2012-04-021-3/+108
| | | | | Change-Id: I4f2b156d92d5838d3b2436ba1781380d26d35d2a Reviewed-by: Alex Wilson <alex.wilson@nokia.com>
* Document that examples may require addition plugin parameters.Aaron McCarthy2012-03-302-0/+25
| | | | | | | | Add a note in the overview section on how to add extra plugin parameters which may be required for some geo services plugins. Change-Id: I63097b9da9778a09f729a3ad60455ff3fc2a0449 Reviewed-by: abcd <amos.choy@nokia.com>
* General documentation issuesWolfgang Beck2012-03-2915-63/+242
| | | | | Change-Id: I021ab70e1cbb973817aecbf53b7af0760c5e36c4 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Added support for proxy autodetection.Cristian Adam2012-03-291-3/+5
| | | | | Change-Id: Icef793831e54f0333e9872293859b9009a7164cf Reviewed-by: Alex Wilson <alex.wilson@nokia.com>
* Use more canonical "UI components" terminology rather than "elements"Alex Wilson2012-03-261-2/+2
| | | | | | | 6687 / [019-content] Change-Id: I3e6f9174fe5a6eef322a466661a34764005c9dac Reviewed-by: Alex <alex.blasche@nokia.com>
* Documentation fixesAnonymous2012-03-261-36/+51
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Courtesy of the Caped Crusader. Maps.qdoc - NOT DONE: fill empty section on Routing/Navigation with appropriate documentation - fixed grammar in Displaying Maps subsection - ensured all table rows end with a full-stop - clarified what a QtLocation5::Plugin element is / does in relation to Map elements - clarified description of MapRectangle - moved MapQuickItem description into map objects table, and expanded description. - attempted to use the term "map overlay object" consistently throughout the documentation - expanded the Geocoding section with informative description. - clarified what a QtLocation5::Plugin element is / does in relation to GeocodeModel elements qdeclarativegeoserviceprovider.cpp - fixed description of locales (from set to ordered list) - clarified that the C locale is identical in behavior to English/UnitedStates as per QLocale documentation - clarified bitwise combination of the required plugin features enum flag values qdeclarativegeomap.cpp - fixed typo in zoom level descriptions - added brief description of pinch property - fixed typo in plugin property description - expanded documentation of removeMapItem method. 098 - language - done 099 - style - done 100 - content - done 101 - language - done 102 - style - done 103 - content - done 104 - content - done 105 - content - done 106 - content - NOT DONE - routing/navigation 107 - content - done 108 - content - done 109 - content - done 110 - content - NOT DONE - already fixed? 111 - content - NOT DONE - (snippets/img?) 112 - language - done 113 - content - done 114 - language - done 115 - language - done Change-Id: I5f17ee9a1c3f7e7dfefc0147fff7a133afa6b276 Reviewed-by: Alex <alex.blasche@nokia.com>
* Positioning overview (C++) documentation has broken linkJean Gressmann2012-03-261-22/+28
| | | | | | | | Moved log file example into its own page and updated NMEA section. Task-number: QTBUG-24440 Change-Id: Id7a608b7141b90213a6e8637154fd5e0f040d509 Reviewed-by: Alex <alex.blasche@nokia.com>
* Small doc fix: landing page Oxford commas and suggested rewordAlex Wilson2012-03-261-4/+4
| | | | | | | | 6687 / [014-language] Change-Id: I4cf69158c49bce464e20dd564928aac4a7f85c64 Reviewed-by: abcd <amos.choy@nokia.com> Reviewed-by: Alex <alex.blasche@nokia.com>
* Document application credential requirements for Nokia plugin.Aaron McCarthy2012-03-261-1/+5
| | | | | | | | | Document that it is required that an application developer using the Qt Location API needs to obtain an application id and token pair from Nokia to be able to use the "nokia" geoservices plugin. Change-Id: I4f2275a2f31cf93be6ffab8a666e2839f567e0f7 Reviewed-by: Alex Wilson <alex.wilson@nokia.com>
* Uniform usage of proxy, app_id, and, token for all managers.Cristian Adam2012-03-261-24/+12
| | | | | | | | There is no reason to have different <service>.proxy, <service.app_id <service>.token parameters, since they are the same for all services. Change-Id: Ie17c39ac5fd94027ce477267f9e957d4cc4a5e1b Reviewed-by: Alex Wilson <alex.wilson@nokia.com>
* Have jsondb places plugin use the user partitionabcd2012-03-262-0/+24
| | | | | | | Also allow specification of partition via the parameters. Change-Id: I4d311ae6c4bff437e556185a95b8c1fffcb5948f Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Many documentation improvementsAnonymous2012-03-231-9/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Courtesy of the Caped Crusader: QDeclarativeGeoAddress - fixed "brief" description of Address element - removed reference to "the plugin" from text property description QDeclarativeBoundingBox - added description of BoundingBox element - added example of usage QDeclarativeBoundingCircle - added description of BoundingCircle element - added example of usage - added note about change signal semantics from center coordinate QDeclarativeCoordinate -> NOT DONE: adding "general terminology" (azimuth etc etc) - added important note about change signal notification semantics (incl. Position-exception) - added documentation about what constitutes "validity" of lat/long - added units for the azimuth (degrees, not radians) - QGeoCoordinatePrivate::atDistanceAndAzimuth() does: double azimuthRad = qgeocoordinate_degToRad(azimuth); QDeclarativeGeoLocation - changed "coordinate" property documentation QDeclarativePosition - updated description to underline it's temporal nature - updated property descriptions to underline read-only nature of Position QDeclarativePositionSource -> NOT DONE: updating the "active" property documentation to clarify "is/should-be" semantics. - updated description to avoid implying that you must specify an updateInterval. - updated description to clarify onPositionChanged is a signal-handler. - added description of NMEA data - added note that the "position" property is read-only. - clarified scope and description of positioning method enum values - clarified scope of error enum values - added documentation for onPositionChanged signal handler. - added documentation for update() regarding timeout value and activation. Places.qdoc - shortened a long line, lengthened a short line. - clarified save/remove documentation Change-Id: I6793906b7f5ebf7ccc5432d85822506466341057 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Change default REST server to version 2.alex2012-03-211-1/+1
| | | | | | | | Version 1 was a development enabler and is likely to be removed before the final Qt 5.0 release. Change-Id: I8f8bbbf48e8486de794751b92f73770e36a58186 Reviewed-by: abcd <amos.choy@nokia.com>
* Added support for app_id and token authentication for geocoding.Cristian Adam2012-03-201-0/+3
| | | | | Change-Id: Ice20da89c235083b3c68e2f6627c32e2e4b37cc3 Reviewed-by: Alex <alex.blasche@nokia.com>
* Example to allow assignment of categories to placesabcd2012-03-191-10/+14
| | | | | Change-Id: I8a8cb8588d5ad9d640c684d8b924f7c059b3e941 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Improve docsabcd2012-03-161-2/+6
| | | | | | Change-Id: I96afeffa80db5e6104f5d4467b186a6c9086d07e Reviewed-by: Alex Wilson <alex.wilson@nokia.com> Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Fix some broken links and improve section overview for QML referencealex2012-03-152-4/+17
| | | | | | Change-Id: Id801ca7b164a41a03920344dfd578c46cb91bf9d Reviewed-by: Jean Gressmann <jean.gressmann@nokia.com> Reviewed-by: Alex <alex.blasche@nokia.com>
* Docs: Bug-6677 fix for items 001-003.Peter Yard2012-03-1518-105/+104
| | | | | Change-Id: I8da3e2e445782eccec379a54823d39df7ed8d9f8 Reviewed-by: Alex <alex.blasche@nokia.com>
* Fix syntax error warnings.Aaron McCarthy2012-03-141-34/+36
| | | | | | | | | Something in the build process parses qml files and generates warnings. Fix up so that they are valid. QML files must have only a single top level object. Change-Id: Icd3044c33f20e04b319b894e69f100fee4f7568d Reviewed-by: Alex <alex.blasche@nokia.com>
* Maps/navigation QML API documentation is incompleteJean Gressmann2012-03-122-0/+92
| | | | | | | | | | | Partial fix for QTBUG-24437 (maps) Addressed map related issues except * Map - item performance notes updates (is there anything to do?) * MapQuickItem - better diagrams, work on explanations Change-Id: If5865f22fe12825ee4422872b997b1c89b8db06a Reviewed-by: Alex <alex.blasche@nokia.com>
* Download icons for jsondb pluginabcd2012-03-091-15/+15
| | | | | | | | Also refactor so that icon processing is isolated to the IconHandler class Change-Id: I3c13ac17759b062fbbdf4ef5e8823913b2818c23 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* QtDeclarative renaming.Aaron McCarthy2012-03-091-1/+1
| | | | | | Change-Id: I0412d2e8e27cf3035712a3c413b5fa99e3a7ad36 Reviewed-by: David Laing <david.laing@nokia.com> Reviewed-by: Alex Wilson <alex.wilson@nokia.com>
* Change bugreports.qt.nokia.com -> bugreports.qt-project.orgSergio Ahumada2012-03-021-1/+1
| | | | | Change-Id: Id7d10c580a759d677db039bbd0672a976c4b6baf Reviewed-by: Jyri Tahtela <jyri.tahtela@nokia.com>
* Remove the usage of deprecated qdoc macros.Casper van Donderen2012-03-0217-303/+303
| | | | | | | | | | QDoc now has support for Doxygen style commands for italics, bold and list items. This change applies that change in QDoc to the actual documentation. Task-number: QTBUG-24578 Change-Id: If6af8e9303bdb7c255cce086b93073d927ac2907 Reviewed-by: Alex <alex.blasche@nokia.com>
* Places QML API documentation is incompleteJean Gressmann2012-03-021-1/+106
| | | | | | | | | | | | | | | Attempt at fixing QTBUG-24438 The QML documentation changes are: * ContactDetail, EditorialModel, ImageModel, Supplier, User now have an example * errorString method documented for CategoryModel, PlaceRecommendationModel, PlaceSearchSuggestionModel * Added documentation for PlaceSearchModel::SearchResultType. * Documented ExtendedAttributes::onValueChanged signal. Change-Id: I37dbee7107713996592a98abade26d32f7cc9b0e Reviewed-by: Alex <alex.blasche@nokia.com> Reviewed-by: abcd <amos.choy@nokia.com>
* Maps/navigation QML API documentation is incompleteJean Gressmann2012-03-022-2/+86
| | | | | | | | | Partial fix for QTBUG-24437 (routing) Added examples and improved documentation for routing related classes. Change-Id: Ib40ba78c3e7a50e056b586979f702c4d5e9a8c98 Reviewed-by: Alex <alex.blasche@nokia.com>
* Docs: all docs to be built for QtLocation only.Peter Yard2012-02-2744-0/+4171
| | | | | Change-Id: I154be7bb280811d1bcacb368a08cc81bbb293222 Reviewed-by: Alex <alex.blasche@nokia.com>
* Positioning QML API documentation is incompleteJean Gressmann2012-02-242-11/+94
| | | | | | | | | | First try at solving QTBUG-24434 Copied over the introduction from the C++ positioning API page and added a small QML example. Change-Id: I1e615347dbfed07fdbb5864263fa6a64b5fcfeb9 Reviewed-by: Alex <alex.blasche@nokia.com>
* Docs: QtLocation typos QTBUG-24066.Peter Yard2012-02-241-1/+1
| | | | | | Change-Id: If135730ef1cf775debfcf530ca960df718b76994 Reviewed-by: Alex <alex.blasche@nokia.com> Reviewed-by: Natalia Shubina <natalia.shubina@nokia.com>
* Provide default implementations for all QPlaceManagerEngine virtuals.Aaron McCarthy2012-02-231-26/+19
| | | | | | | | | | Provide a default implementation for all QPlaceManagerEngine virtual functions. Plugin authors no longer need to explicitly implement these functions to return errored replies. Task-number: QTBUG-23500 Change-Id: I2a14b6dedb90df78c8c13acd637d7e81619219a3 Reviewed-by: abcd <amos.choy@nokia.com>
* Remove left overs from QGraphicsGeoMap removalalex2012-02-231-2147/+0
| | | | | Change-Id: I9856d32c44f29409226b814ca5e699556cfea6d5 Reviewed-by: Alex Wilson <alex.wilson@nokia.com>
* Convert QGeoBoundingArea to use value type semantics.Aaron McCarthy2012-02-201-5/+5
| | | | | | | | | | | | | | This simplifies the API while keeping the same functionality. Objects of type QGeoBoundingCircle and QGeoBoundingBox can still be passed around as QGeoBoundingArea without losing their identity. QGeoBoundingArea::isValid(), ::isEmpty() and ::contains() function as one would expect. This change removes the necessity of the application developer to track and delete pointers. Change-Id: I1ee70af90319da4c77225c6a0a03601d5ff431f1 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Remove the historical referer from the mapping service.Chris Axiarlis2012-02-151-3/+3
| | | | | | | | | | | | | | The maptile service previously required a token, and optionally a referer to be set in the request. The new authentication system requires a token and app_id. Leaving the referer in the request causes confusion, especially now the the token has a new meaning and is also validated differently. This patch will remove the refererer from the mapping service only. Change-Id: I2aff52ea74692af05cf381a48376b13ec1ba4bb7 Reviewed-by: Cristian Adam <cristian.adam@nokia.com> Reviewed-by: Alex <alex.blasche@nokia.com>
* Docs: QTBUG-24066, Location doc typos.Peter Yard2012-02-135-24/+25
| | | | | Change-Id: I71d7ab7e074eef2000f10463f3bf75cdb9bf6048 Reviewed-by: David Laing <david.laing@nokia.com>
* Add support for the new Nokia REST API to nokia plugin.Aaron McCarthy2012-02-091-5/+3
| | | | | | | | | | | | | | | Support is added in such a way that both the v1 and v2 REST APIs are supported by the plugin. By default the v1 API is used. The application developer can explicitly select v2 by setting the places.api_version plugin parameter to 2. At some point the default will change to v2 and support for v1 and places.api_version may be dropped entirely. The new REST API is documented at http://api.places.lbs.maps.nokia.com/places/static/doc/index.html Change-Id: I643d10202ab387346fa4658f096a6ddbb5e80e34 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Places qml overviewabcd2012-02-072-2/+117
| | | | | Change-Id: Ie9d65c79fa643ef5412e838c262fd9c0cc2687e4 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* QtLocation: Fix compiler warnings.Friedemann Kleint2012-02-021-0/+1
| | | | | | | | | | - QString from ASCII-construction - Unused variables - Invalid export specification for QDebug-stream operators Change-Id: I630d10e1098cb32162a1760b94f2191b5de556cb Reviewed-by: abcd <amos.choy@nokia.com> Reviewed-by: Alex Wilson <alex.wilson@nokia.com>
* New docs landing page, part 1 of overview pagesAlex Wilson2012-02-024-111/+248
| | | | | | | | | | | Actual improved versions of the QML/C++ API overviews for each module will follow. This commit splits the responsibility up between the new pages and creates the new front page for the module. Change-Id: I50ec588f35002c84f0712c858227feb451938bee Reviewed-by: Peter Yard <peter.yard@nokia.com> Reviewed-by: abcd <amos.choy@nokia.com> Reviewed-by: David Laing <david.laing@nokia.com>
* Remove "All rights reserved" line from license headers.Jason McDonald2012-01-3029-29/+29
| | | | | | | | | | As in the past, to avoid rewriting various autotests that contain line-number information, an extra blank line has been inserted at the end of the license text to ensure that this commit does not change the total number of lines in the license header. Change-Id: I00c66363046e475e6924aafd221483c7fad5c0d9 Reviewed-by: Rohan McGovern <rohan.mcgovern@nokia.com>
* Fix inconsistency, use childCategoryIds over childrenCategoryIdsabcd2012-01-301-1/+1
| | | | | Change-Id: I37dfa12027bcc5424e65aa515f512b18a94692c4 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* Refactor Iconsabcd2012-01-305-63/+158
| | | | | Change-Id: I702e8a1b6f0e80cb990315165f1bf331a82e65a5 Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
* New example screenshot showing new look and feelabcd2012-01-251-0/+0
| | | | | Change-Id: I9f3978328c5cf12e317a571d1c68f993233407e6 Reviewed-by: Alex Wilson <alex.wilson@nokia.com>
* Add example of how to use parameters for the Nokia pluginAlex Wilson2012-01-251-0/+26
| | | | | Change-Id: Iceff682065668ffd27929c08110e5f0600cdfa9d Reviewed-by: David Laing <david.laing@nokia.com>
* Update obsolete contact address.Jason McDonald2012-01-2329-29/+29
| | | | | | | Replace Nokia contact email address with Qt Project website. Change-Id: I3850177e14291901e924f9c27ba09e75df00f96a Reviewed-by: Rohan McGovern <rohan.mcgovern@nokia.com>
View Lorry Controller Status