summaryrefslogtreecommitdiff
path: root/src/positioning
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2019-11-08 23:57:52 +0100
committerTopi Reinio <topi.reinio@qt.io>2019-11-14 12:14:14 +0100
commita467eadd46bec7a66e2e97bc4fd3a5271430bc93 (patch)
treeda0f988be1b020ea64c9cb66c09e80552e1afc90 /src/positioning
parent664a83674b2bf8313763870c9eca7c4c558a14bc (diff)
downloadqtlocation-a467eadd46bec7a66e2e97bc4fd3a5271430bc93.tar.gz
Doc: Fix documentation warnings
Fix missing/incorrect parameter documentation, linking warnings, and \instantiates references to undocumented/internal classes. Remove mention of Navigator::currentRoute, as such a property no longer exists. Fixes: QTBUG-79811 Change-Id: I048a13109aa19f3db75e76611473d60a2396f028 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/positioning')
-rw-r--r--src/positioning/doc/src/qtpositioning-plugins.qdoc2
-rw-r--r--src/positioning/doc/src/qtpositioning.qdoc2
-rw-r--r--src/positioning/qgeocoordinate.cpp2
-rw-r--r--src/positioning/qgeopolygon.cpp2
-rw-r--r--src/positioning/qgeopositioninfosourcefactory.cpp2
5 files changed, 4 insertions, 6 deletions
diff --git a/src/positioning/doc/src/qtpositioning-plugins.qdoc b/src/positioning/doc/src/qtpositioning-plugins.qdoc
index 77fdf3aa..d11c3121 100644
--- a/src/positioning/doc/src/qtpositioning-plugins.qdoc
+++ b/src/positioning/doc/src/qtpositioning-plugins.qdoc
@@ -27,7 +27,7 @@
/*!
\page qtpositioning-plugins.html
-\title Qt Positioning plugins
+\title Qt Positioning Plugins
\brief Default Plugins and Implementing Qt Positioning plugins
Qt Positioning provides the majority of its functionality through plugins.
diff --git a/src/positioning/doc/src/qtpositioning.qdoc b/src/positioning/doc/src/qtpositioning.qdoc
index 970bc7bd..5ce8aae3 100644
--- a/src/positioning/doc/src/qtpositioning.qdoc
+++ b/src/positioning/doc/src/qtpositioning.qdoc
@@ -129,7 +129,7 @@ such as speed and direction. This provides the fundamental location information
\li \l {Qt Positioning C++ Classes}{for C++}
\row
\li Position plugins:
- \li \l {Qt Positioning service plugins}
+ \li \l {Qt Positioning Plugins}
\endtable
\section2 Examples
diff --git a/src/positioning/qgeocoordinate.cpp b/src/positioning/qgeocoordinate.cpp
index f3d3ef9c..5ff1299d 100644
--- a/src/positioning/qgeocoordinate.cpp
+++ b/src/positioning/qgeocoordinate.cpp
@@ -320,8 +320,6 @@ bool QGeoCoordinate::operator==(const QGeoCoordinate &other) const
/*!
\fn bool QGeoCoordinate::operator!=(const QGeoCoordinate &other) const
- \fn bool QGeoCoordinate::operator!=(const QGeoCoordinateObject &other) const
- \fn bool QGeoCoordinate::operator!=(const QGeoCoordinateObject *other) const
Returns \c true if latitude, longitude, or altitude of this
coordinate are not identical to \a other.
diff --git a/src/positioning/qgeopolygon.cpp b/src/positioning/qgeopolygon.cpp
index 04e09095..e8fdda76 100644
--- a/src/positioning/qgeopolygon.cpp
+++ b/src/positioning/qgeopolygon.cpp
@@ -117,7 +117,7 @@ QGeoPolygon::QGeoPolygon()
}
/*!
- Constructs a new geo \a polygon from the coordinates specified
+ Constructs a new geo polygon from the coordinates specified
in \a path.
*/
QGeoPolygon::QGeoPolygon(const QList<QGeoCoordinate> &path)
diff --git a/src/positioning/qgeopositioninfosourcefactory.cpp b/src/positioning/qgeopositioninfosourcefactory.cpp
index afb0a1d3..d9971c26 100644
--- a/src/positioning/qgeopositioninfosourcefactory.cpp
+++ b/src/positioning/qgeopositioninfosourcefactory.cpp
@@ -109,7 +109,7 @@ QGeoPositionInfoSourceFactory::~QGeoPositionInfoSourceFactory()
\fn QGeoSatelliteInfoSource *QGeoPositionInfoSourceFactoryV2::satelliteInfoSourceWithParameters(QObject *parent, const QVariantMap &parameters)
Returns a new QGeoSatelliteInfoSource associated with this plugin
- with parent \a parent., and using \a parameters as configuration parameters.
+ with parent \a parent, and using \a parameters as configuration parameters.
Can also return 0, in which case the plugin loader will use the factory with
the next highest priority.
*/