summaryrefslogtreecommitdiff
path: root/src/location
diff options
context:
space:
mode:
authorAaron McCarthy <aaron.mccarthy@nokia.com>2012-06-21 12:37:10 +1000
committerQt by Nokia <qt-info@nokia.com>2012-06-22 04:41:09 +0200
commit5f08b680a512a3a54ef5c9a49f7c39eab25d17c8 (patch)
tree15f3e0fe5e51bb1b0124a546dc95ee9e2b443dab /src/location
parentf7745328cccad0141ca3f43009ccd26c7d4af5ff (diff)
downloadqtlocation-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 'src/location')
-rw-r--r--src/location/places/qplaceicon.cpp2
-rw-r--r--src/location/places/qplacemanagerengine.cpp4
-rw-r--r--src/location/places/qplaceresult.cpp2
-rw-r--r--src/location/places/qplacesearchresult.cpp16
-rw-r--r--src/location/qgeocoordinate.cpp3
-rw-r--r--src/location/qgeosatelliteinfosource.cpp6
-rw-r--r--src/location/qnmeapositioninfosource.cpp3
7 files changed, 22 insertions, 14 deletions
diff --git a/src/location/places/qplaceicon.cpp b/src/location/places/qplaceicon.cpp
index da122023..259697ee 100644
--- a/src/location/places/qplaceicon.cpp
+++ b/src/location/places/qplaceicon.cpp
@@ -205,7 +205,7 @@ QVariantMap QPlaceIcon::parameters() const
}
/*!
- Sets the parameters of the icon.
+ Sets the parameters of the icon to \a parameters.
*/
void QPlaceIcon::setParameters(const QVariantMap &parameters)
{
diff --git a/src/location/places/qplacemanagerengine.cpp b/src/location/places/qplacemanagerengine.cpp
index e51b0b28..9340b2ef 100644
--- a/src/location/places/qplacemanagerengine.cpp
+++ b/src/location/places/qplacemanagerengine.cpp
@@ -252,8 +252,8 @@ QString QPlaceManagerEngine::parentCategoryId(const QString &categoryId) const
}
/*!
- Returns the child category identifiers of the category corresponding to \a parentId. If \a parentId is
- empty then all top level category identifiers are returned.
+ Returns the child category identifiers of the category corresponding to \a categoryId. If
+ \a categoryId is empty then all top level category identifiers are returned.
*/
QStringList QPlaceManagerEngine::childCategoryIds(const QString &categoryId) const
{
diff --git a/src/location/places/qplaceresult.cpp b/src/location/places/qplaceresult.cpp
index 0e2b4874..3122a8ef 100644
--- a/src/location/places/qplaceresult.cpp
+++ b/src/location/places/qplaceresult.cpp
@@ -82,7 +82,7 @@ bool QPlaceResultPrivate::compare(const QPlaceSearchResultPrivate *other) const
an instance of the place and an indication of whether the result is
sponsored or \l {http://en.wikipedia.org/wiki/Organic_search}{organic}.
- \sa QPlaceSearchResults
+ \sa QPlaceSearchResult
*/
/*!
diff --git a/src/location/places/qplacesearchresult.cpp b/src/location/places/qplacesearchresult.cpp
index c45c286a..0af98569 100644
--- a/src/location/places/qplacesearchresult.cpp
+++ b/src/location/places/qplacesearchresult.cpp
@@ -77,16 +77,12 @@ bool QPlaceSearchResultPrivate::compare(const QPlaceSearchResultPrivate *other)
\ingroup QtLocation-places-data
\since Qt Location 5.0
- \brief The QPlaceSearchResult class represents a search result.
-
- Currently the only useful search result type is the
- \l {QPlaceSearchResult::PlaceResult} {place result}.
- For search results of this type, the \l {QPlaceSearchResult::distance()} {distance},
- \l {QPlaceSearchResult::place()}{place} and {QPlaceSearchResult::isSponsored} isSponsored
- fields of the search result is filled in. Thus the result contains the distance
- from the place from the search center of the search request, the place data containing
- coordinates, address and so on, and finally an indication of whether the
- result is sponsored or \l {http://en.wikipedia.org/wiki/Organic_search}{organic}.
+ \brief The QPlaceSearchResult class is the base class for all place search results.
+
+ A list of place search results can be retrieved from the QPlaceSearchReply after it has
+ successfully completed the request. All place search results contain a \l {type()} which
+ describes the type of search result. A \l {title()} and an \l {icon()} which can be used to
+ present the search result to the user.
*/
/*!
diff --git a/src/location/qgeocoordinate.cpp b/src/location/qgeocoordinate.cpp
index 134a8464..0d2f3812 100644
--- a/src/location/qgeocoordinate.cpp
+++ b/src/location/qgeocoordinate.cpp
@@ -190,6 +190,9 @@ QGeoCoordinate::QGeoCoordinate(const QGeoCoordinate &other)
: d(other.d)
{}
+/*!
+ Assigns \a other to this coordinate and returns a reference to this coordinate.
+*/
QGeoCoordinate &QGeoCoordinate::operator=(const QGeoCoordinate &other)
{
if (this == &other)
diff --git a/src/location/qgeosatelliteinfosource.cpp b/src/location/qgeosatelliteinfosource.cpp
index 33c7054e..b42991e8 100644
--- a/src/location/qgeosatelliteinfosource.cpp
+++ b/src/location/qgeosatelliteinfosource.cpp
@@ -292,6 +292,12 @@ QStringList QGeoSatelliteInfoSource::availableSources()
*/
/*!
+ \fn QGeoSatelliteInfoSource::Error QGeoSatelliteInfoSource::error() const = 0
+
+ Returns the last error that occurred.
+*/
+
+/*!
\fn void QGeoSatelliteInfoSource::error(QGeoSatelliteInfoSource::Error satelliteError)
This signal is emitted after an error occurred. The \a satelliteError
diff --git a/src/location/qnmeapositioninfosource.cpp b/src/location/qnmeapositioninfosource.cpp
index 0fab0e59..89f44b48 100644
--- a/src/location/qnmeapositioninfosource.cpp
+++ b/src/location/qnmeapositioninfosource.cpp
@@ -605,6 +605,9 @@ int QNmeaPositionInfoSource::minimumUpdateInterval() const
return 100;
}
+/*!
+ \reimp
+*/
QGeoPositionInfoSource::Error QNmeaPositionInfoSource::error() const
{
return d->m_positionError;