diff options
author | Aaron McCarthy <aaron.mccarthy@nokia.com> | 2012-06-21 12:37:10 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-06-22 04:41:09 +0200 |
commit | 5f08b680a512a3a54ef5c9a49f7c39eab25d17c8 (patch) | |
tree | 15f3e0fe5e51bb1b0124a546dc95ee9e2b443dab /doc/src/examples/declarative-places.qdoc | |
parent | f7745328cccad0141ca3f43009ccd26c7d4af5ff (diff) | |
download | qtlocation-5f08b680a512a3a54ef5c9a49f7c39eab25d17c8.tar.gz |
Documentation fixes.
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>
Diffstat (limited to 'doc/src/examples/declarative-places.qdoc')
-rw-r--r-- | doc/src/examples/declarative-places.qdoc | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/doc/src/examples/declarative-places.qdoc b/doc/src/examples/declarative-places.qdoc index 2aea92ea..6ee12e00 100644 --- a/doc/src/examples/declarative-places.qdoc +++ b/doc/src/examples/declarative-places.qdoc @@ -27,7 +27,7 @@ /*! \example declarative/places - \title Places (QML) Example + \title Places (QML) \ingroup qtlocation-examples \brief The Places example demonstrates how to search for Places and access @@ -168,7 +168,7 @@ Finally, we define two helper functions \b searchForCategory() and \b {searchForText()}, which set either the \l {PlaceSearchModel::categories}{categories} or \l {PlaceSearchModel::searchTerm}{searchTerm} properties and invokes the - \l {PlaceSearchModel::execute()}{execute()} method to start the place search. The search + \l {PlaceSearchModel::update()}{update()} method to start the place search. The search results are displayed in a \l ListView. \snippet declarative/places/content/places/SearchResultView.qml PlaceSearchModel place list @@ -193,8 +193,7 @@ \section1 Place and Category Creation Some backends may support creation and saving of new places and categories. Plugin support can - be checked an run-time by testing the \l Plugin::supportedPlacesFeatures property for the - \e Plugin::SavePlaceFeature and \e Plugin::SaveCategoryFeature flags. + be checked an run-time with the \l Plugin::supportsPlaces() method. To save a new place, first create a new \l Place object, using the \l {Qt::createQmlObject()}{Qt.createQmlObject()} method. Assign the appropriate plugin and @@ -219,9 +218,9 @@ The example detects which plugins are available and has an option to show them in the via the Provider button. - The \l {Qt Location JsonDb plugin} {JsonDb plugin} in particular acts as a data store for - user defined favorites which can be saved and removed. In order to use the JsonDb plugin however - the JsonDb daemon must be running in the background. + The \l {Qt Location JsonDb plugin (technical preview only)}{JsonDb plugin} in particular acts + as a data store for user defined favorites which can be saved and removed. In order to use the + JsonDb plugin however the JsonDb daemon must be running in the background. \code jsondb & //run jsondb daemon in the background |