summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Solovev <ivan.solovev@qt.io>2021-07-30 16:41:35 +0200
committerIvan Solovev <ivan.solovev@qt.io>2021-08-02 21:29:52 +0200
commitde07b53c5a8f6de7559ec2ada0efbaf5bec69e61 (patch)
tree099f26009c26b917e21031b330867d706a2c2a68
parentcac741dd3a13bb724b9e16877ea5b3b404e0ad1f (diff)
downloadqtlocation-de07b53c5a8f6de7559ec2ada0efbaf5bec69e61.tar.gz
Fix qdoc warnings
This patch fixes the qdoc warnings that were introduced during previous refactoring and documentation rewrites. Pick-to: 6.2 Change-Id: I3bd32141cc37720abd40738f09d0c08152e8b9d2 Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
-rw-r--r--src/positioning/qgeoaddress.cpp2
-rw-r--r--src/positioning/qgeoareamonitorinfo.cpp6
-rw-r--r--src/positioning/qgeocircle.cpp14
-rw-r--r--src/positioning/qgeocoordinate.cpp7
-rw-r--r--src/positioning/qgeopath.cpp14
-rw-r--r--src/positioning/qgeopolygon.cpp14
-rw-r--r--src/positioning/qgeopositioninfo.cpp12
-rw-r--r--src/positioning/qgeorectangle.cpp14
-rw-r--r--src/positioning/qgeosatelliteinfo.cpp6
9 files changed, 11 insertions, 78 deletions
diff --git a/src/positioning/qgeoaddress.cpp b/src/positioning/qgeoaddress.cpp
index 3870dbf0..9d00c769 100644
--- a/src/positioning/qgeoaddress.cpp
+++ b/src/positioning/qgeoaddress.cpp
@@ -409,7 +409,7 @@ QGeoAddress::QGeoAddress(const QGeoAddress &other)
}
/*!
- \fn QGeoAddress::GeoAddress(QGeoAddress &&other)
+ \fn QGeoAddress::QGeoAddress(QGeoAddress &&other) noexcept
\since 6.2
Constructs a geo address object by moving from \a other.
diff --git a/src/positioning/qgeoareamonitorinfo.cpp b/src/positioning/qgeoareamonitorinfo.cpp
index 828286b2..ae9548f0 100644
--- a/src/positioning/qgeoareamonitorinfo.cpp
+++ b/src/positioning/qgeoareamonitorinfo.cpp
@@ -354,8 +354,7 @@ bool QGeoAreaMonitorInfo::equals(const QGeoAreaMonitorInfo &lhs, const QGeoAreaM
#ifndef QT_NO_DATASTREAM
/*!
- \fn QDataStream &operator<<(QDataStream &stream, const QGeoAreaMonitorInfo &monitor)
- \relates QGeoAreaMonitorInfo
+ \fn QDataStream &QGeoAreaMonitorInfo::operator<<(QDataStream &stream, const QGeoAreaMonitorInfo &monitor)
Writes the given \a monitor to the specified \a stream.
@@ -369,8 +368,7 @@ QDataStream &QGeoAreaMonitorInfo::dataStreamOut(QDataStream &ds, const QGeoAreaM
}
/*!
- \fn QDataStream &operator>>(QDataStream &stream, QGeoAreaMonitorInfo &monitor)
- \relates QGeoAreaMonitorInfo
+ \fn QDataStream &QGeoAreaMonitorInfo::operator>>(QDataStream &stream, QGeoAreaMonitorInfo &monitor)
Reads a area monitoring data from the specified \a stream into the given
\a monitor.
diff --git a/src/positioning/qgeocircle.cpp b/src/positioning/qgeocircle.cpp
index 195736e5..094a7dcb 100644
--- a/src/positioning/qgeocircle.cpp
+++ b/src/positioning/qgeocircle.cpp
@@ -171,20 +171,6 @@ QGeoCircle &QGeoCircle::operator=(const QGeoCircle &other)
return *this;
}
-/*!
- \fn bool QGeoCircle::operator==(const QGeoCircle &lhs, const QGeoCircle &rhs)
-
- Returns \c true if the \a lhs geo circle is equal to the \a rhs geo
- circle, otherwise returns \c false.
-*/
-
-/*!
- \fn bool QGeoCircle::operator!=(const QGeoCircle &lhs, const QGeoCircle &rhs)
-
- Returns \c true if the \a lhs geo circle is not equal to the \a rhs geo
- circle, otherwise returns \c false.
-*/
-
bool QGeoCirclePrivate::isValid() const
{
return m_center.isValid() && !qIsNaN(m_radius) && m_radius >= -1e-7;
diff --git a/src/positioning/qgeocoordinate.cpp b/src/positioning/qgeocoordinate.cpp
index 2dd7a20c..58c2ee15 100644
--- a/src/positioning/qgeocoordinate.cpp
+++ b/src/positioning/qgeocoordinate.cpp
@@ -734,9 +734,7 @@ QDebug QGeoCoordinate::debugStreaming(QDebug dbg, const QGeoCoordinate &coord)
#ifndef QT_NO_DATASTREAM
/*!
- \fn QDataStream &operator<<(QDataStream &stream, const QGeoCoordinate &coordinate)
-
- \relates QGeoCoordinate
+ \fn QDataStream &QGeoCoordinate::operator<<(QDataStream &stream, const QGeoCoordinate &coordinate)
Writes the given \a coordinate to the specified \a stream.
@@ -754,8 +752,7 @@ QDataStream &QGeoCoordinate::dataStreamOut(QDataStream &stream, const QGeoCoordi
#ifndef QT_NO_DATASTREAM
/*!
- \fn QDataStream &operator>>(QDataStream &stream, QGeoCoordinate &coordinate)
- \relates QGeoCoordinate
+ \fn QDataStream &QGeoCoordinate::operator>>(QDataStream &stream, QGeoCoordinate &coordinate)
Reads a coordinate from the specified \a stream into the given
\a coordinate.
diff --git a/src/positioning/qgeopath.cpp b/src/positioning/qgeopath.cpp
index 9f327bd8..4d6b1af2 100644
--- a/src/positioning/qgeopath.cpp
+++ b/src/positioning/qgeopath.cpp
@@ -168,20 +168,6 @@ QGeoPath &QGeoPath::operator=(const QGeoPath &other)
}
/*!
- \fn bool QGeoPath::operator==(const QGeoPath &lhs, const QGeoPath &rhs)
-
- Returns \c true if the \a lhs geo path is equal to the \a rhs geo path,
- otherwise returns \c false.
-*/
-
-/*!
- \fn bool QGeoPath::operator!=(const QGeoPath &lhs, const QGeoPath &rhs)
-
- Returns \c true if the \a lhs geo path is not equal to the \a rhs geo path,
- otherwise returns \c false.
-*/
-
-/*!
Sets all the elements of the \a path.
*/
void QGeoPath::setPath(const QList<QGeoCoordinate> &path)
diff --git a/src/positioning/qgeopolygon.cpp b/src/positioning/qgeopolygon.cpp
index 073b5b30..fc8d50cd 100644
--- a/src/positioning/qgeopolygon.cpp
+++ b/src/positioning/qgeopolygon.cpp
@@ -219,20 +219,6 @@ QGeoPolygon &QGeoPolygon::operator=(const QGeoPolygon &other)
}
/*!
- \fn bool QGeoPolygon::operator!=(const QGeoPolygon &lhs, const QGeoPolygon &rhs)
-
- Returns \c true if the \a lhs geo polygon is equal to the \a rhs geo
- polygon, otherwise returns \c false.
-*/
-
-/*!
- \fn bool QGeoPolygon::operator!=(const QGeoPolygon &lhs, const QGeoPolygon &rhs)
-
- Returns \c true if the \a lhs geo polygon is not equal to the \a rhs geo
- polygon, otherwise returns \c false.
-*/
-
-/*!
Sets the perimeter of the polygon based on a list of coordinates \a path.
\since QtPositioning 5.12
diff --git a/src/positioning/qgeopositioninfo.cpp b/src/positioning/qgeopositioninfo.cpp
index 2d50c57a..f641c0ad 100644
--- a/src/positioning/qgeopositioninfo.cpp
+++ b/src/positioning/qgeopositioninfo.cpp
@@ -334,8 +334,7 @@ QDebug QGeoPositionInfo::debugStreaming(QDebug dbg, const QGeoPositionInfo &info
#ifndef QT_NO_DATASTREAM
/*!
- \fn QDataStream &operator<<(QDataStream &stream, QGeoPositionInfo::Attribute attr)
- \relates QGeoPositionInfo
+ \fn QDataStream &QGeoPositionInfo::operator<<(QDataStream &stream, QGeoPositionInfo::Attribute attr)
Writes the given \a attr enumeration to the specified \a stream.
@@ -347,8 +346,7 @@ QDataStream &QGeoPositionInfo::dataStreamOut(QDataStream &stream, QGeoPositionIn
}
/*!
- \fn QDataStream &operator>>(QDataStream &stream, QGeoPositionInfo::Attribute &attr)
- \relates QGeoPositionInfo
+ \fn QDataStream &QGeoPositionInfo::operator>>(QDataStream &stream, QGeoPositionInfo::Attribute &attr)
Reads an attribute enumeration from the specified \a stream info the given \a attr.
@@ -363,8 +361,7 @@ QDataStream &QGeoPositionInfo::dataStreamIn(QDataStream &stream, QGeoPositionInf
}
/*!
- \fn QDataStream &operator<<(QDataStream &stream, const QGeoPositionInfo &info)
- \relates QGeoPositionInfo
+ \fn QDataStream &QGeoPositionInfo::operator<<(QDataStream &stream, const QGeoPositionInfo &info)
Writes the given \a info to the specified \a stream.
@@ -380,8 +377,7 @@ QDataStream &QGeoPositionInfo::dataStreamOut(QDataStream &stream, const QGeoPosi
}
/*!
- \fn QDataStream &operator>>(QDataStream &stream, QGeoPositionInfo &info)
- \relates QGeoPositionInfo
+ \fn QDataStream &QGeoPositionInfo::operator>>(QDataStream &stream, QGeoPositionInfo &info)
Reads a coordinate from the specified \a stream into the given
\a info.
diff --git a/src/positioning/qgeorectangle.cpp b/src/positioning/qgeorectangle.cpp
index 24ec22a3..b92ca17c 100644
--- a/src/positioning/qgeorectangle.cpp
+++ b/src/positioning/qgeorectangle.cpp
@@ -292,20 +292,6 @@ QGeoRectangle &QGeoRectangle::operator=(const QGeoRectangle &other)
return *this;
}
-/*!
- \fn bool QGeoRectangle::operator==(const QGeoRectangle &lhs, const QGeoRectangle &rhs)
-
- Returns \c true if the \a lhs geo rectangle is equal to the \a rhs geo
- rectangle, otherwise returns \c false.
-*/
-
-/*!
- \fn bool QGeoRectangle::operator!=(const QGeoRectangle &lhs, const QGeoRectangle &rhs)
-
- Returns \c true if the \a lhs geo rectangle is not equal to the \a rhs geo
- rectangle, otherwise returns \c false.
-*/
-
bool QGeoRectanglePrivate::isValid() const
{
return topLeft.isValid() && bottomRight.isValid() &&
diff --git a/src/positioning/qgeosatelliteinfo.cpp b/src/positioning/qgeosatelliteinfo.cpp
index da89b355..f9f242fe 100644
--- a/src/positioning/qgeosatelliteinfo.cpp
+++ b/src/positioning/qgeosatelliteinfo.cpp
@@ -342,8 +342,7 @@ QDebug QGeoSatelliteInfo::debugStreaming(QDebug dbg, const QGeoSatelliteInfo &in
#ifndef QT_NO_DATASTREAM
/*!
- \fn QDataStream &operator<<(QDataStream &stream, const QGeoSatelliteInfo &info)
- \relates QGeoSatelliteInfo
+ \fn QDataStream &QGeoSatelliteInfo::operator<<(QDataStream &stream, const QGeoSatelliteInfo &info)
Writes the given \a info to the specified \a stream.
@@ -363,8 +362,7 @@ QDataStream &QGeoSatelliteInfo::dataStreamOut(QDataStream &stream, const QGeoSat
#ifndef QT_NO_DATASTREAM
/*!
- \fn QDataStream &operator>>(QDataStream &stream, QGeoSatelliteInfo &info)
- \relates QGeoSatelliteInfo
+ \fn QDataStream &QGeoSatelliteInfo::operator>>(QDataStream &stream, QGeoSatelliteInfo &info)
Reads satellite information from the specified \a stream into the given
\a info.