diff options
author | Aaron McCarthy <aaron.mccarthy@nokia.com> | 2011-10-24 14:17:29 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2011-11-01 07:39:39 +0100 |
commit | a32f3234f788494fe77a6b2f8a4e3bbf83bdef33 (patch) | |
tree | 4945df02a4483d119cc3128db1359f47aa0f7c28 /src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp | |
parent | 4e7b04475583e1ffb692cbf6ae80cf61b22e085b (diff) |
Adds documentation for some places emements.
Add or improves element documentation for Category, CategoryModel
EditorialModel, ImageModel, ReviewModel, PlaceAttribute,
ExtendedAttributes, Icon, PlaceSearchModel, RecommendationModel,
TextPredictionModel, Rating, User and BoundingCircle.
Change-Id: Id067f207793aa1dfc11009ba4c29c165d54c8934
Reviewed-by: abcd <amos.choy@nokia.com>
Diffstat (limited to 'src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp')
-rw-r--r-- | src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp | 55 |
1 files changed, 22 insertions, 33 deletions
diff --git a/src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp index 96a2edda..3ecb3f52 100644 --- a/src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativereviewmodel.cpp @@ -53,25 +53,26 @@ QT_BEGIN_NAMESPACE \ingroup qml-QtLocation5-places \since QtLocation 5.0 - \brief The ReviewModel element provides access to reviews of a Place. + \brief The ReviewModel element provides access to reviews of a \l Place. - The ReviewModel is a read-only model used to fetch reviews about a Place. The model + The ReviewModel is a read-only model used to fetch reviews about a \l Place. The model incrementally fetches reviews. The number of reviews which are fetched at a time is specified - by the batchSize property. The total number of reviews available can be accessed via the - totalCount property and the number of fetched reviews via the count property. + by the \l batchSize property. The total number of reviews available can be accessed via the + \l totalCount property. The model returns data for the following roles: + \table \header \o Role \o Type \o Description \row - \o date - \o string - \o The date that the review was posted. + \o dateTime + \o datetime + \o The date and time that the review was posted. \row - \o description + \o content \o string \o The content of the review. \row @@ -79,45 +80,33 @@ QT_BEGIN_NAMESPACE \o string \o The language that the review is written in. \row - \o helpfulVotings - \o int - \o The number of votings indicating that the review was helpful. - \row - \o unhelpfulVotings - \o int - \o The number of votings indicating that the review was not helpful. - \row \o rating \o real \o The rating that the reviewer gave to the place. \row - \o mediaIds - \o list - \o The list of media ids associated with the review. - \row \o reviewId \o string \o The id of the review. \row - \o supplier - \o Supplier - \o The source of the review. - \row \o title \o string \o The title of the review. \row - \o userId - \o string - \o The id of the user who posted the review. - \row - \o userName - \o string - \o The name of the user who posted the review. + \o supplier + \o \l Supplier + \o The supplier of the editorial. \row - \o originatorUrl + \o sourceUrl \o url - \o The URL of the review. + \o The source URL of the editorial. + \row + \o user + \o \l User + \o The user who contributed the editorial. + \row + \o attribution + \o string + \o Attribution text which must be displayed when displaying the editorial. \endtable */ |