summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Solovev <ivan.solovev@qt.io>2021-03-15 15:27:15 +0100
committerIvan Solovev <ivan.solovev@qt.io>2021-03-23 10:44:01 +0100
commitf8b6d5bcaefa8386dae6e2ddcc60f55257f911fe (patch)
treed677c59e180d66d7b90c052d6a9d0a9a05a632bb
parent5dc9fb4149e124d01c8fe6d9ace735320af895d2 (diff)
downloadqtlocation-f8b6d5bcaefa8386dae6e2ddcc60f55257f911fe.tar.gz
QtPositioning: fix QDoc warnings
Fix some QDoc warnings and update some code samples Task-number: QTBUG-89856 Change-Id: I12ac2f3ac58d2701e1458d7d28f9c1c19fb1244a Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
-rw-r--r--src/imports/positioning/positioning.cpp24
-rw-r--r--src/positioning/qgeoareamonitorsource.cpp4
-rw-r--r--src/positioning/qgeopositioninfosource.cpp10
-rw-r--r--src/positioning/qgeosatelliteinfosource.cpp6
-rw-r--r--src/positioning/qnmeasatelliteinfosource.cpp5
-rw-r--r--src/positioningquick/locationsingleton.cpp5
6 files changed, 27 insertions, 27 deletions
diff --git a/src/imports/positioning/positioning.cpp b/src/imports/positioning/positioning.cpp
index bdab1ef0..ca6a4054 100644
--- a/src/imports/positioning/positioning.cpp
+++ b/src/imports/positioning/positioning.cpp
@@ -82,7 +82,7 @@ QT_BEGIN_NAMESPACE
\section1 Example Usage
- Use properties of type \l variant to store a \c {coordinate}. To create a \c coordinate use
+ Use properties of type \l var to store a \c {coordinate}. To create a \c coordinate use
one of the methods described below. In all cases, specifying the \l altitude attribute is
optional.
@@ -90,7 +90,7 @@ QT_BEGIN_NAMESPACE
function:
\qml
- import QtPositioning 5.2
+ import QtPositioning
Location { coordinate: QtPositioning.coordinate(-27.5, 153.1) }
\endqml
@@ -224,7 +224,7 @@ QT_BEGIN_NAMESPACE
\section1 Example Usage
- Use properties of type \l variant to store a \c {geoshape}. To create a \c geoshape use one
+ Use properties of type \l var to store a \c {geoshape}. To create a \c geoshape use one
of the methods described below.
To create a \c geoshape value, specify it as a "shape()" string:
@@ -233,17 +233,17 @@ QT_BEGIN_NAMESPACE
import QtPositioning
Item {
- property variant region: "shape()"
+ property var region: "shape()"
}
\endqml
or with the \l {QtPositioning::shape}{QtPositioning.shape()} function:
\qml
- import QtPositioning 5.2
+ import QtPositioning
Item {
- property variant region: QtPositioning.shape()
+ property var region: QtPositioning.shape()
}
\endqml
@@ -337,14 +337,14 @@ QT_BEGIN_NAMESPACE
\section1 Example Usage
- Use properties of type \l variant to store a \c {georectangle}. To create a \c georectangle
+ Use properties of type \l var to store a \c {georectangle}. To create a \c georectangle
value, use the \l {QtPositioning::rectangle}{QtPositioning.rectangle()} function:
\qml
- import QtPositioning 5.2
+ import QtPositioning
Item {
- property variant region: QtPositioning.rectangle(QtPositioning.coordinate(-27.5, 153.1), QtPositioning.coordinate(-27.6, 153.2))
+ property var region: QtPositioning.rectangle(QtPositioning.coordinate(-27.5, 153.1), QtPositioning.coordinate(-27.6, 153.2))
}
\endqml
@@ -437,14 +437,14 @@ QT_BEGIN_NAMESPACE
\section1 Example Usage
- Use properties of type \l variant to store a \c {geocircle}. To create a \c geocircle value,
+ Use properties of type \l var to store a \c {geocircle}. To create a \c geocircle value,
use the \l {QtPositioning::circle}{QtPositioning.circle()} function:
\qml
- import QtPositioning 5.2
+ import QtPositioning
Item {
- property variant region: QtPositioning.circle(QtPositioning.coordinate(-27.5, 153.1), 1000)
+ property var region: QtPositioning.circle(QtPositioning.coordinate(-27.5, 153.1), 1000)
}
\endqml
diff --git a/src/positioning/qgeoareamonitorsource.cpp b/src/positioning/qgeoareamonitorsource.cpp
index 94393245..412919a0 100644
--- a/src/positioning/qgeoareamonitorsource.cpp
+++ b/src/positioning/qgeoareamonitorsource.cpp
@@ -281,7 +281,7 @@ void QGeoAreaMonitorSource::setPositionInfoSource(QGeoPositionInfoSource *newSou
backend doesn't support \l QGeoAreaMonitorSource::PersistentAreaMonitorFeature.
\note Since Qt6 this method always resets the last error to
- \l {QGeoAreaMonitorSource::Error::}{NoError} before starting monitoring.
+ \l {QGeoAreaMonitorSource::}{NoError} before starting monitoring.
\sa stopMonitoring()
*/
@@ -318,7 +318,7 @@ void QGeoAreaMonitorSource::setPositionInfoSource(QGeoPositionInfoSource *newSou
shot behavior.
\note Since Qt6 this method always resets the last error to
- \l {QGeoAreaMonitorSource::Error::}{NoError} before starting monitoring.
+ \l {QGeoAreaMonitorSource::}{NoError} before starting monitoring.
\sa startMonitoring(), stopMonitoring()
*/
diff --git a/src/positioning/qgeopositioninfosource.cpp b/src/positioning/qgeopositioninfosource.cpp
index 99818587..51284538 100644
--- a/src/positioning/qgeopositioninfosource.cpp
+++ b/src/positioning/qgeopositioninfosource.cpp
@@ -488,16 +488,16 @@ QGeoPositionInfoSource::QGeoPositionInfoSource(QGeoPositionInfoSourcePrivate &dd
If setUpdateInterval() has not been called, the source will emit updates
as soon as they become available.
- An errorOccurred() signal with the \l {QGeoPositionInfoSource::Error::}
+ An errorOccurred() signal with the \l {QGeoPositionInfoSource::}
{UpdateTimeoutError} will be emitted if this QGeoPositionInfoSource subclass
determines that it will not be able to provide regular updates. This could
happen if a satellite fix is lost or if a hardware error is detected.
Position updates will recommence if the data becomes available later on.
- The \l {QGeoPositionInfoSource::Error::}{UpdateTimeoutError} error will not
+ The \l {QGeoPositionInfoSource::}{UpdateTimeoutError} error will not
be emitted again until after the periodic updates resume.
\note Since Qt6 this method always resets the last error to
- \l {QGeoPositionInfoSource::Error::}{NoError} before starting the updates.
+ \l {QGeoPositionInfoSource::}{NoError} before starting the updates.
On iOS, starting from version 8, Core Location framework requires additional
entries in the application's Info.plist with keys NSLocationAlwaysUsageDescription or
@@ -523,7 +523,7 @@ QGeoPositionInfoSource::QGeoPositionInfoSource(QGeoPositionInfoSourcePrivate &dd
this information. If the current position cannot be found within the given \a timeout
(in milliseconds) or if \a timeout is less than the value returned by
minimumUpdateInterval(), an errorOccurred() signal with the
- \l {QGeoPositionInfoSource::Error::}{UpdateTimeoutError} is emitted.
+ \l {QGeoPositionInfoSource::}{UpdateTimeoutError} is emitted.
If the timeout is zero, the timeout defaults to a reasonable timeout
period as appropriate for the source.
@@ -537,7 +537,7 @@ QGeoPositionInfoSource::QGeoPositionInfoSource(QGeoPositionInfoSourcePrivate &dd
given timeout.
\note Since Qt6 this method always resets the last error to
- \l {QGeoPositionInfoSource::Error::}{NoError} before requesting
+ \l {QGeoPositionInfoSource::}{NoError} before requesting
the position.
*/
diff --git a/src/positioning/qgeosatelliteinfosource.cpp b/src/positioning/qgeosatelliteinfosource.cpp
index a84dba02..89607438 100644
--- a/src/positioning/qgeosatelliteinfosource.cpp
+++ b/src/positioning/qgeosatelliteinfosource.cpp
@@ -340,7 +340,7 @@ QStringList QGeoSatelliteInfoSource::availableSources()
empty parameter lists.
\note Since Qt6 this method always resets the last error to
- \l {QGeoSatelliteInfoSource::Error::}{NoError} before starting
+ \l {QGeoSatelliteInfoSource::}{NoError} before starting
the updates.
\sa satellitesInViewUpdated(), satellitesInUseUpdated()
@@ -360,7 +360,7 @@ QStringList QGeoSatelliteInfoSource::availableSources()
information. If the current satellite information cannot be found
within the given \a timeout (in milliseconds) or if \a timeout is less than
the value returned by minimumUpdateInterval(), an errorOccurred() signal
- with \l {QGeoSatelliteInfoSource::Error::UpdateTimeoutError}
+ with \l {QGeoSatelliteInfoSource::UpdateTimeoutError}
{UpdateTimeoutError} is emitted.
If the timeout is zero, the timeout defaults to a reasonable timeout
@@ -371,7 +371,7 @@ QStringList QGeoSatelliteInfoSource::availableSources()
regular updates are in progress.
\note Since Qt6 this method always resets the last error to
- \l {QGeoSatelliteInfoSource::Error::}{NoError} before requesting
+ \l {QGeoSatelliteInfoSource::}{NoError} before requesting
the satellite information.
*/
diff --git a/src/positioning/qnmeasatelliteinfosource.cpp b/src/positioning/qnmeasatelliteinfosource.cpp
index 1d648262..a27ac2b0 100644
--- a/src/positioning/qnmeasatelliteinfosource.cpp
+++ b/src/positioning/qnmeasatelliteinfosource.cpp
@@ -625,8 +625,9 @@ QNmeaSatelliteInfoSource::parseSatellitesInUseFromNmea(const char *data, int siz
fill \a infos list.
Returns \l SatelliteInfoParseStatus with parse result.
- Modifies \a infos list in case \l SatelliteInfoParseStatus::PartiallyParsed
- or \l SatelliteInfoParseStatus::FullyParsed is returned.
+ Modifies \a infos list in case \l {QNmeaSatelliteInfoSource::}
+ {PartiallyParsed} or \l {QNmeaSatelliteInfoSource::}{FullyParsed} is
+ returned.
Also sets the \a system to correct satellite system type. This is required
to determine the system type in case there are no satellites in view.
*/
diff --git a/src/positioningquick/locationsingleton.cpp b/src/positioningquick/locationsingleton.cpp
index 4ee0e3c9..81ca3eda 100644
--- a/src/positioningquick/locationsingleton.cpp
+++ b/src/positioningquick/locationsingleton.cpp
@@ -66,7 +66,6 @@ static QGeoCoordinate parseCoordinate(const QJSValue &value, bool *ok)
/*!
\qmltype QtPositioning
- \instantiates LocationSingleton
\inqmlmodule QtPositioning
\since 5.2
@@ -74,10 +73,10 @@ static QGeoCoordinate parseCoordinate(const QJSValue &value, bool *ok)
types in QML.
\qml
- import QtPositioning 5.2
+ import QtPositioning
Item {
- property variant coordinate: QtPositioning.coordinate(-27.5, 153.1)
+ property var coordinate: QtPositioning.coordinate(-27.5, 153.1)
}
\endqml
*/