summaryrefslogtreecommitdiff
path: root/src/location/places
diff options
context:
space:
mode:
authorAaron McCarthy <aaron.mccarthy@nokia.com>2011-10-25 12:59:22 +1000
committerQt by Nokia <qt-info@nokia.com>2011-10-25 05:01:07 +0200
commit06f46c6b69a4234b3449eac5ab44989546cb52c9 (patch)
tree709cd99b8ef43309f17dc95d13aab8882b39ec4c /src/location/places
parent53909f3cb2a02aca9f87b298b935845d9301d0d0 (diff)
downloadqtlocation-06f46c6b69a4234b3449eac5ab44989546cb52c9.tar.gz
Update structure of QtLocation documentation.
Separate out into sections for C++ and QML. Mark all classes as "since QtLocation 5.0" as there has been many API changes since Qt Mobility. Change-Id: Ie71c5f7cb8341e76d41b9fefce4781979f3e898c Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
Diffstat (limited to 'src/location/places')
-rw-r--r--src/location/places/qplaceattribute.cpp10
-rw-r--r--src/location/places/qplacecategory.cpp8
-rw-r--r--src/location/places/qplacecontentreply.cpp7
-rw-r--r--src/location/places/qplacecontentrequest.cpp10
-rw-r--r--src/location/places/qplacedetailsreply.cpp7
-rw-r--r--src/location/places/qplaceeditorial.cpp7
-rw-r--r--src/location/places/qplaceidreply.cpp7
-rw-r--r--src/location/places/qplaceimage.cpp8
-rw-r--r--src/location/places/qplacemanager.cpp8
-rw-r--r--src/location/places/qplacemanagerengine.cpp8
-rw-r--r--src/location/places/qplacerating.cpp7
-rw-r--r--src/location/places/qplacereply.cpp10
-rw-r--r--src/location/places/qplacerequest.cpp8
-rw-r--r--src/location/places/qplacereview.cpp8
-rw-r--r--src/location/places/qplacesearchreply.cpp7
-rw-r--r--src/location/places/qplacesearchrequest.cpp10
-rw-r--r--src/location/places/qplacesearchresult.cpp7
-rw-r--r--src/location/places/qplacesupplier.cpp7
-rw-r--r--src/location/places/qplacetextpredictionreply.cpp7
-rw-r--r--src/location/places/qplaceuser.cpp5
20 files changed, 65 insertions, 91 deletions
diff --git a/src/location/places/qplaceattribute.cpp b/src/location/places/qplaceattribute.cpp
index ce9b850a..405cbba7 100644
--- a/src/location/places/qplaceattribute.cpp
+++ b/src/location/places/qplaceattribute.cpp
@@ -66,12 +66,12 @@ bool QPlaceAttributePrivate::operator== (const QPlaceAttributePrivate &other) co
}
/*!
-\class QPlaceAttribute
-\brief The QPlaceAttribute class represents generic attribute information about a place.
-\inmodule QtLocation
+ \class QPlaceAttribute
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
-\ingroup location
-\ingroup places-main
+ \brief The QPlaceAttribute class represents generic attribute information about a place.
*/
/*!
diff --git a/src/location/places/qplacecategory.cpp b/src/location/places/qplacecategory.cpp
index 9d927395..2b922136 100644
--- a/src/location/places/qplacecategory.cpp
+++ b/src/location/places/qplacecategory.cpp
@@ -76,8 +76,9 @@ bool QPlaceCategoryPrivate::operator==(const QPlaceCategoryPrivate &other) const
/*!
\class QPlaceCategory
-
- \inmodule QPlaces
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
\brief The QPlaceCategory class represents a category object.
@@ -89,9 +90,6 @@ bool QPlaceCategoryPrivate::operator==(const QPlaceCategoryPrivate &other) const
contact object and add it to place.
QPlaceCategory is an in memory representation of a contact object.
-
- \ingroup location
- \ingroup places-main
*/
diff --git a/src/location/places/qplacecontentreply.cpp b/src/location/places/qplacecontentreply.cpp
index 44217ec7..e1d7462b 100644
--- a/src/location/places/qplacecontentreply.cpp
+++ b/src/location/places/qplacecontentreply.cpp
@@ -60,13 +60,12 @@ QT_USE_NAMESPACE
/*!
\class QPlaceContentReply
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
\brief The QPlaceContentReply class manages a content retrieval operation started by an
instance of QPlaceManager.
-
- \inmodule QtLocation
-
- \ingroup places-main
*/
/*!
diff --git a/src/location/places/qplacecontentrequest.cpp b/src/location/places/qplacecontentrequest.cpp
index e439ecd7..fdca36ef 100644
--- a/src/location/places/qplacecontentrequest.cpp
+++ b/src/location/places/qplacecontentrequest.cpp
@@ -74,13 +74,11 @@ void QPlaceContentRequestPrivate::clear()
/*!
\class QPlaceContentRequest
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
- \inmodule Location
-
- \brief The QPlaceContentRequest class represents the query parameters
- of a content request.
-
- \ingroup places-main
+ \brief The QPlaceContentRequest class represents the query parameters of a content request.
The QPlaceContentRequest class represents a query parameters object, it currently
specifies the type of content to be retrived.
diff --git a/src/location/places/qplacedetailsreply.cpp b/src/location/places/qplacedetailsreply.cpp
index b45fde43..32dfa11d 100644
--- a/src/location/places/qplacedetailsreply.cpp
+++ b/src/location/places/qplacedetailsreply.cpp
@@ -57,13 +57,12 @@ QT_USE_NAMESPACE
/*!
\class QPlaceDetailsReply
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
\brief The QPlaceDetailsReply class manages a place datails operation started by an
instance of QPlaceManager.
-
- \inmodule QtPlaces
-
- \ingroup places-main
*/
/*!
diff --git a/src/location/places/qplaceeditorial.cpp b/src/location/places/qplaceeditorial.cpp
index 3343d569..08458e5a 100644
--- a/src/location/places/qplaceeditorial.cpp
+++ b/src/location/places/qplaceeditorial.cpp
@@ -71,8 +71,9 @@ bool QPlaceEditorialPrivate::compare(const QPlaceContentPrivate *other) const
/*!
\class QPlaceEditorial
-
- \inmodule QPlaces
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
\brief The QPlaceEditorial class represents a address object.
@@ -81,8 +82,6 @@ bool QPlaceEditorialPrivate::compare(const QPlaceContentPrivate *other) const
Editorial objects are read-only, e.g. user of API might get editorial objects associated to
specific place but can not edit its content. User might also create new editorial.
-
- \ingroup places-main
*/
/*!
diff --git a/src/location/places/qplaceidreply.cpp b/src/location/places/qplaceidreply.cpp
index f4972fb2..a80f4438 100644
--- a/src/location/places/qplaceidreply.cpp
+++ b/src/location/places/qplaceidreply.cpp
@@ -58,13 +58,12 @@ QT_USE_NAMESPACE
/*!
\class QPlaceIdReply
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
\brief The QPlaceIdReply class manages operations which return an id such as
saving and removal operations of places and categories.
-
- \inmodule QtLocation
-
- \ingroup places-main
*/
/*!
diff --git a/src/location/places/qplaceimage.cpp b/src/location/places/qplaceimage.cpp
index 8322936f..91dda7eb 100644
--- a/src/location/places/qplaceimage.cpp
+++ b/src/location/places/qplaceimage.cpp
@@ -69,14 +69,12 @@ bool QPlaceImagePrivate::compare(const QPlaceContentPrivate *other) const
/*!
\class QPlaceImage
-
- \inmodule QPlaces
-
- \ingroup places-main
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
\brief The QPlaceImage class represents an image.
-
Each QPlaceImage represents an image with a number of attributes
such as type, thumbnail, media provider etc.
diff --git a/src/location/places/qplacemanager.cpp b/src/location/places/qplacemanager.cpp
index 449f4766..2ebf3374 100644
--- a/src/location/places/qplacemanager.cpp
+++ b/src/location/places/qplacemanager.cpp
@@ -48,13 +48,11 @@ QT_BEGIN_NAMESPACE
/*!
\class QPlaceManager
-
- \brief The QPlaceManager class is responsible for the discovery and
- management of places.
-
\inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
- \ingroup places-main
+ \brief The QPlaceManager class is responsible for the discovery and management of places.
*/
/*!
diff --git a/src/location/places/qplacemanagerengine.cpp b/src/location/places/qplacemanagerengine.cpp
index 5574d283..f30f72f2 100644
--- a/src/location/places/qplacemanagerengine.cpp
+++ b/src/location/places/qplacemanagerengine.cpp
@@ -46,16 +46,14 @@ QT_USE_NAMESPACE
/*!
\class QPlaceManagerEngine
+ \inmodule QtLocation
+ \ingroup QtLocation-impl
+ \since QtLocation 5.0
\brief The QPlaceManagerEngine class provides an interface and convenience methods to
implementers of QGeoServiceProvider plugins who want to provide access to place search
functionality.
- \inmodule QtLocation
- \since 5.0
-
- \ingroup maps-impl
-
Subclasses of QPlaceManagerEngine need to provide an implementation of getPlaceDetails(),
getContent(), postRating(), getReviews(), searchForPlaces(), supportedSearchVisibilityScopes(),
recommendations(), textPredictions(), savePlace(), supportedSaveVisibilityScopes(), removePlace(),
diff --git a/src/location/places/qplacerating.cpp b/src/location/places/qplacerating.cpp
index 5f2386bf..ab11fcbb 100644
--- a/src/location/places/qplacerating.cpp
+++ b/src/location/places/qplacerating.cpp
@@ -65,16 +65,15 @@ bool QPlaceRatingPrivate::operator==(const QPlaceRatingPrivate &other) const
/*!
\class QPlaceRating
-
- \inmodule QPlaces
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
\brief The QPlaceRating class represents a rating object.
Each QPlaceRating represents a rating object with a count and value.
QPlaceRating is an in memory representation of a rating object.
-
- \ingroup places-main
*/
/*!
diff --git a/src/location/places/qplacereply.cpp b/src/location/places/qplacereply.cpp
index 7466ccab..2c56e145 100644
--- a/src/location/places/qplacereply.cpp
+++ b/src/location/places/qplacereply.cpp
@@ -46,13 +46,11 @@ QT_USE_NAMESPACE
/*!
\class QPlaceReply
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
- \inmodule Location
-
- \brief The QPlaceReply class manages an operation started by
- an instance of QPlaceManager.
-
- \ingroup places-main
+ \brief The QPlaceReply class manages an operation started by an instance of QPlaceManager.
*/
/*!
diff --git a/src/location/places/qplacerequest.cpp b/src/location/places/qplacerequest.cpp
index 82d9e802..6209f966 100644
--- a/src/location/places/qplacerequest.cpp
+++ b/src/location/places/qplacerequest.cpp
@@ -83,13 +83,11 @@ void QPlaceRequestPrivate::clear()
/*!
\class QPlaceQuery
-
- \inmodule Location
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
\brief The QPlaceQuery class is the base class used for various search queries.
-
- \ingroup places-main
-
*/
/*!
diff --git a/src/location/places/qplacereview.cpp b/src/location/places/qplacereview.cpp
index 0d66f810..71a514b4 100644
--- a/src/location/places/qplacereview.cpp
+++ b/src/location/places/qplacereview.cpp
@@ -78,12 +78,12 @@ bool QPlaceReviewPrivate::compare(const QPlaceContentPrivate *other) const
/*!
\class QPlaceReview
-
- \inmodule QPlaces
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
\brief The QPlaceReview class represents a review object.
-
Each QPlaceReview represents a review object with a number of attributes
such as rating, review id, connected media etc. Each QPlaceReview is associated
with place.
@@ -92,8 +92,6 @@ bool QPlaceReviewPrivate::compare(const QPlaceContentPrivate *other) const
associated to specific place but can not edit its content. User might also create new review.
QPlaceReview is an in memory representation of a review object.
-
- \ingroup places-main
*/
diff --git a/src/location/places/qplacesearchreply.cpp b/src/location/places/qplacesearchreply.cpp
index 5b47bfca..96d74a1e 100644
--- a/src/location/places/qplacesearchreply.cpp
+++ b/src/location/places/qplacesearchreply.cpp
@@ -58,13 +58,12 @@ QT_USE_NAMESPACE
/*!
\class QPlaceSearchReply
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
\brief The QPlaceSearchReply class manages a search operation started by an
instance of QPlaceManager.
-
- \inmodule QtLocation
-
- \ingroup places-main
*/
/*!
diff --git a/src/location/places/qplacesearchrequest.cpp b/src/location/places/qplacesearchrequest.cpp
index f10832f8..1e57f00e 100644
--- a/src/location/places/qplacesearchrequest.cpp
+++ b/src/location/places/qplacesearchrequest.cpp
@@ -129,13 +129,11 @@ void QPlaceSearchRequestPrivate::clear()
/*!
\class QPlaceSearchRequest
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
- \inmodule Location
-
- \brief The QPlaceSearchRequest class represents the query parameters
- of a search request.
-
- \ingroup places-main
+ \brief The QPlaceSearchRequest class represents the query parameters of a search request.
The QPlaceSearchRequest class represents a query parameters object. Each
QPlaceSearchRequest cointans search query parameters like search term.
diff --git a/src/location/places/qplacesearchresult.cpp b/src/location/places/qplacesearchresult.cpp
index f4eeec50..63fc1f72 100644
--- a/src/location/places/qplacesearchresult.cpp
+++ b/src/location/places/qplacesearchresult.cpp
@@ -72,13 +72,12 @@ bool QPlaceSearchResultPrivate::operator==(const QPlaceSearchResultPrivate &othe
/*!
\class QPlaceSearchResult
-
- \inmodule QPlaces
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
\brief The QPlaceSearchResult class represents a search result object.
- \ingroup places-main
-
Each QPlaceSearchResult represents a place with a number of attributes
such as distance, relevance, etc.
*/
diff --git a/src/location/places/qplacesupplier.cpp b/src/location/places/qplacesupplier.cpp
index eec44468..73596435 100644
--- a/src/location/places/qplacesupplier.cpp
+++ b/src/location/places/qplacesupplier.cpp
@@ -73,15 +73,14 @@ bool QPlaceSupplierPrivate::operator==(const QPlaceSupplierPrivate &other) const
/*!
\class QPlaceSupplier
-
- \inmodule QPlaces
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
\brief The QPlaceSupplier class represents a supplier object.
Each QPlaceSupplier represents a supplier object with a number of attributes
such as name, icon etc. Each QPlaceSupplier is associated with place, media, review or description.
-
- \ingroup places-main
*/
/*!
diff --git a/src/location/places/qplacetextpredictionreply.cpp b/src/location/places/qplacetextpredictionreply.cpp
index 5a810309..4fc26007 100644
--- a/src/location/places/qplacetextpredictionreply.cpp
+++ b/src/location/places/qplacetextpredictionreply.cpp
@@ -57,13 +57,12 @@ QT_USE_NAMESPACE
/*!
\class QPlaceTextPredictionReply
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
\brief The QPlaceTextPredictionReply class manages a text prediction operation started by an
instance of QPlaceManager.
-
- \inmodule QtLocation
-
- \ingroup places-main
*/
/*!
diff --git a/src/location/places/qplaceuser.cpp b/src/location/places/qplaceuser.cpp
index 9f7e6d83..6e80e87c 100644
--- a/src/location/places/qplaceuser.cpp
+++ b/src/location/places/qplaceuser.cpp
@@ -65,8 +65,9 @@ bool QPlaceUserPrivate::operator==(const QPlaceUserPrivate &other) const
/*!
\class QPlaceUser
-
- \inmodule QPlaces
+ \inmodule QtLocation
+ \ingroup QtLocation-places
+ \since QtLocation 5.0
\brief The QPlaceUser class represents a user.