diff options
author | Peter Yard <peter.yard@nokia.com> | 2012-03-14 11:27:00 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-03-15 12:38:17 +0100 |
commit | b827cee44697b3766543870be7c5bcbb89f0c692 (patch) | |
tree | 45e7a5c49de5e41977bd6494ba68bb9529e28f7d /src | |
parent | b36948312d237924f268f5c1308abea3911e0d92 (diff) | |
download | qtlocation-b827cee44697b3766543870be7c5bcbb89f0c692.tar.gz |
Docs: Bug-6677 fix for items 001-003.
Change-Id: I8da3e2e445782eccec379a54823d39df7ed8d9f8
Reviewed-by: Alex <alex.blasche@nokia.com>
Diffstat (limited to 'src')
13 files changed, 19 insertions, 19 deletions
diff --git a/src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp b/src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp index 861fc73d..ad5e4268 100644 --- a/src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativecontactdetail.cpp @@ -194,7 +194,7 @@ void QDeclarativeContactDetail::setLabel(const QString &label) \qmlproperty string QtLocation5::ContactDetail::value This property holds the value of the contact detail which may be a phone number, an email - address, a website url etc. + address, a website url and so on. */ QString QDeclarativeContactDetail::value() const { diff --git a/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp b/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp index e419158e..ca761c56 100644 --- a/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativeplaceattribute.cpp @@ -66,12 +66,12 @@ \li The trading hours of the place \row \li payment - \li The types of payment the place accepts, e.g. visa, mastercard etc. + \li The types of payment the place accepts, for example visa, mastercard. \row \li x_provider \li The name of the provider that a place is sourced from \row - \li x_id_<provider> (e.g x_id_nokia) + \li x_id_<provider> (for example x_id_nokia) \li An alternative id which identifies the place from the perspective of the specified provider. \endtable diff --git a/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp b/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp index de0f577c..be89890e 100644 --- a/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp +++ b/src/imports/location/declarativeplaces/qdeclarativesearchsuggestionmodel.cpp @@ -216,7 +216,7 @@ void QDeclarativeSearchSuggestionModel::setSearchTerm(const QString &searchTerm) } /*! - \qmlproperty QStringList PlaceSearchSuggestionModel::suggestions + \qmlproperty list<string> PlaceSearchSuggestionModel::suggestions This property holds the list of predicted search terms that the model currently has. */ diff --git a/src/imports/location/qdeclarativegeocodemodel.cpp b/src/imports/location/qdeclarativegeocodemodel.cpp index 4f292262..56fe7bd2 100644 --- a/src/imports/location/qdeclarativegeocodemodel.cpp +++ b/src/imports/location/qdeclarativegeocodemodel.cpp @@ -500,7 +500,7 @@ QDeclarativeGeoLocation* QDeclarativeGeocodeModel::get(int index) \qmlproperty int QtLocation5::GeocodeModel::limit This property holds the maximum number of results. The \l limit and \l offset values only - applicable with free string geocoding (i.e. they are not considered when using addresses + applicable with free string geocoding (that is they are not considered when using addresses or coordinates in the search query). If limit is -1 the entire result set will be returned, otherwise at most limit results will be returned. @@ -527,7 +527,7 @@ void QDeclarativeGeocodeModel::setLimit(int limit) \qmlproperty int QtLocation5::GeocodeModel::offset This property tells not to return the first 'offset' number of the results. The \l limit - and \l offset values are only applicable with free string geocoding (i.e. they are not considered + and \l offset values are only applicable with free string geocoding (that is they are not considered when using addresses or coordinates in the search query). The \l limit and offset results can be used together to implement paging. diff --git a/src/imports/location/qdeclarativegeomapflickable.cpp b/src/imports/location/qdeclarativegeomapflickable.cpp index 8fb101a0..a72dfc8a 100644 --- a/src/imports/location/qdeclarativegeomapflickable.cpp +++ b/src/imports/location/qdeclarativegeomapflickable.cpp @@ -151,7 +151,7 @@ QT_BEGIN_NAMESPACE interaction. If a flick was generated, this handler will be triggered once the flick stops. If a flick was not generated, the handler will be triggered when the - user stops dragging - i.e. a mouse or touch release. + user stops dragging - that is a mouse or touch release. */ diff --git a/src/imports/location/qdeclarativegeoserviceprovider.cpp b/src/imports/location/qdeclarativegeoserviceprovider.cpp index 63c394db..59c99837 100644 --- a/src/imports/location/qdeclarativegeoserviceprovider.cpp +++ b/src/imports/location/qdeclarativegeoserviceprovider.cpp @@ -310,7 +310,7 @@ QGeoServiceProvider *QDeclarativeGeoServiceProvider::sharedGeoServiceProvider() } /*! - \qmlproperty stringlist Plugin::locales + \qmlproperty list<string> Plugin::locales This property holds a set of locale preferences. If the first locale cannot be accommodated, then the backend falls back to using the second, and so on. By default the locales property contains the system locale. diff --git a/src/location/maps/qgeocameracapabilities.cpp b/src/location/maps/qgeocameracapabilities.cpp index 0bf30b1c..47def7c9 100644 --- a/src/location/maps/qgeocameracapabilities.cpp +++ b/src/location/maps/qgeocameracapabilities.cpp @@ -265,7 +265,7 @@ bool QGeoCameraCapabilities::supportsTilting() const Sets the minimum tilt supported by the associated plugin to \a minimumTilt. The value is in degrees where 0 is equivalent to 90 degrees between - the line of view and earth's surface i.e. looking straight down to earth. + the line of view and earth's surface, that is, looking straight down to earth. */ void QGeoCameraCapabilities::setMinimumTilt(double minimumTilt) { @@ -277,7 +277,7 @@ void QGeoCameraCapabilities::setMinimumTilt(double minimumTilt) Returns the minimum tilt supported by the associated plugin. The value is in degrees where 0 is equivalent to 90 degrees between - the line of view and earth's surface i.e. looking straight down to earth. + the line of view and earth's surface, that is, looking straight down to earth. */ double QGeoCameraCapabilities::minimumTilt() const { @@ -289,7 +289,7 @@ double QGeoCameraCapabilities::minimumTilt() const Sets the maximum tilt supported by the associated plugin to \a maximumTilt. The value is in degrees where 0 is equivalent to 90 degrees between - the line of view and earth's surface i.e. looking straight down to earth. + the line of view and earth's surface, that is, looking straight down to earth. */ void QGeoCameraCapabilities::setMaximumTilt(double maximumTilt) { @@ -301,7 +301,7 @@ void QGeoCameraCapabilities::setMaximumTilt(double maximumTilt) Returns the maximum tilt supported by the associated plugin. The value is in degrees where 0 is equivalent to 90 degrees between - the line of view and earth's surface i.e. looking straight down to earth. + the line of view and earth's surface, that is, looking straight down to earth. */ double QGeoCameraCapabilities::maximumTilt() const { diff --git a/src/location/maps/qgeorouterequest.cpp b/src/location/maps/qgeorouterequest.cpp index 21dfee81..7e0eacee 100644 --- a/src/location/maps/qgeorouterequest.cpp +++ b/src/location/maps/qgeorouterequest.cpp @@ -90,7 +90,7 @@ QT_BEGIN_NAMESPACE departure / arrrival time could be set, and the presence of this transport options subclass (and the fact that user auth said that the user had support) would mean we could provide better values for the estimated - travel times etc... + travel times and so on. This all relies on at least one service making this data available to us, which would probably be tied to token based authorization. It could be diff --git a/src/location/places/qplace.cpp b/src/location/places/qplace.cpp index b90bb1d2..8c399fb5 100644 --- a/src/location/places/qplace.cpp +++ b/src/location/places/qplace.cpp @@ -92,7 +92,7 @@ QT_BEGIN_NAMESPACE \section2 Content The QPlace object is only meant to be a convenient container to hold - rich content such as images, reviews etc. Retrieval of content + rich content such as images, reviews and so on. Retrieval of content should happen via QPlaceManager::getPlaceContent(). The content is stored as a QPlaceContent::Collection which contains diff --git a/src/location/places/qplacecontactdetail.cpp b/src/location/places/qplacecontactdetail.cpp index c18c2af0..22061a8c 100644 --- a/src/location/places/qplacecontactdetail.cpp +++ b/src/location/places/qplacecontactdetail.cpp @@ -66,7 +66,7 @@ bool QPlaceContactDetailPrivate::operator== (const QPlaceContactDetailPrivate &o \ingroup QtLocation-places-data The detail consists of a label and value. The label is a localized string that can be presented -to the end user that describes that detail value which is the actual phone number, email address etc. +to the end user that describes that detail value which is the actual phone number, email address and so on. \section2 Contact Types diff --git a/src/location/places/qplacecontentreply.cpp b/src/location/places/qplacecontentreply.cpp index f2cc2f78..4a17fd22 100644 --- a/src/location/places/qplacecontentreply.cpp +++ b/src/location/places/qplacecontentreply.cpp @@ -117,7 +117,7 @@ void QPlaceContentReply::setContent(const QPlaceContent::Collection &content) /*! Returns the total number of content objects for a place. If the total number of content objects cannot be counted, a value of -1 is returned. This count only - refers to the total count for a single content type i.e. the content type that + refers to the total count for a single content type, that is, the content type that was specified when content was requested with the QPlaceManager. */ int QPlaceContentReply::totalCount() const diff --git a/src/location/places/qplaceidreply.cpp b/src/location/places/qplaceidreply.cpp index c351092f..9c1455c6 100644 --- a/src/location/places/qplaceidreply.cpp +++ b/src/location/places/qplaceidreply.cpp @@ -111,7 +111,7 @@ QPlaceReply::Type QPlaceIdReply::type() const /*! Returns the operation type of the reply. i.e whether this id reply was for a save place operation, - remove category operation etc. + remove category operation and so on. */ QPlaceIdReply::OperationType QPlaceIdReply::operationType() const { diff --git a/src/location/places/qplacereply.cpp b/src/location/places/qplacereply.cpp index 5544b65e..7658a673 100644 --- a/src/location/places/qplacereply.cpp +++ b/src/location/places/qplacereply.cpp @@ -56,13 +56,13 @@ QT_USE_NAMESPACE The QPlaceReply and each of its specialized subclasses manage the state and results of their corresponding operations. The QPlaceReply itself is used - for operations that have no results i.e. it only necessary to know if the operation + for operations that have no results, that is, it only necessary to know if the operation succeeded or failed. The finished() signal can be used to monitor the progress of an operation. Once an operation is complete, the error() and errorString() methods provide information on whether the operation completed successfully. If successful, the reply - will contain the results for that operation i.e. each subclass will have appropriate + will contain the results for that operation, that is, each subclass will have appropriate functions to retrieve the results of an operation. \sa QPlaceManager |