From 4a4e4ace4582b4e769f9ffdcf1527976e7c76273 Mon Sep 17 00:00:00 2001
From: Nico Vertriest <nico.vertriest@qt.io>
Date: Wed, 29 Mar 2017 16:16:50 +0200
Subject: [PATCH] Doc: Complete parameter documentation
qdeclarativegeomap.cpp: 1327: warning: Can't link to 'Component.onCompleted'
qgeopath.cpp:117: warning: Undocumented parameter 'width' in QGeoPath::QGeoPath()
qgeopath.cpp:117: warning: Undocumented parameter 'path' in QGeoPath::QGeoPath()
qgeoshape.cpp:90: warning: Undocumented enum item 'PathType' in QGeoShape::ShapeType
qgeoshape.cpp:231: warning: No such parameter 'QGeoRectangle' in QGeoShape::boundingGeoRectangle()
Change-Id: Ie57dff2aabe82d61b8122362a396ac706939c3b3
Reviewed-by: Paolo Angelelli <paolo.angelelli@qt.io>
---
src/location/declarativemaps/qdeclarativegeomap.cpp | 2 +-
src/positioning/qgeopath.cpp | 3 ++-
src/positioning/qgeoshape.cpp | 3 ++-
3 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/src/location/declarativemaps/qdeclarativegeomap.cpp b/src/location/declarativemaps/qdeclarativegeomap.cpp
index fd0b036d7..ff34f1ea3 100644
--- a/src/location/declarativemaps/qdeclarativegeomap.cpp
+++ b/src/location/declarativemaps/qdeclarativegeomap.cpp
@@ -1336,7 +1336,7 @@ QColor QDeclarativeGeoMap::color() const
This property holds whether the map has been successfully initialized and is ready to be used.
Some methods, such as \l fromCoordinate and \l toCoordinate, will not work before the map is ready.
Due to the architecture of the \l Map, it's advised to use the signal emitted for this property
- in place of \l Component.onCompleted, to make sure that everything behaves as expected.
+ in place of \l {QtQml::Component::completed()}{Component.onCompleted}, to make sure that everything behaves as expected.
\since 5.9
*/
diff --git a/src/positioning/qgeopath.cpp b/src/positioning/qgeopath.cpp
index 87f4a9d43..b24daec67 100644
--- a/src/positioning/qgeopath.cpp
+++ b/src/positioning/qgeopath.cpp
@@ -115,7 +115,8 @@ QGeoPath::QGeoPath()
}
/*!
- Constructs a new geo path from a list of coordinates.
+ Constructs a new geo path from a list of coordinates
+ (\a path and \a width).
*/
QGeoPath::QGeoPath(const QList<QGeoCoordinate> &path, const qreal &width)
: QGeoShape(new QGeoPathPrivate(path, width))
diff --git a/src/positioning/qgeoshape.cpp b/src/positioning/qgeoshape.cpp
index 60ef18a4f..73dccaa4c 100644
--- a/src/positioning/qgeoshape.cpp
+++ b/src/positioning/qgeoshape.cpp
@@ -95,6 +95,7 @@ bool QGeoShapePrivate::operator==(const QGeoShapePrivate &other) const
\value UnknownType A shape of unknown type.
\value RectangleType A rectangular shape.
\value CircleType A circular shape.
+ \value PathType A path type.
*/
/*!
@@ -229,7 +230,7 @@ bool QGeoShape::contains(const QGeoCoordinate &coordinate) const
}
/*!
- Returns a \a QGeoRectangle representing the geographical bounding rectangle of the
+ Returns a QGeoRectangle representing the geographical bounding rectangle of the
geo shape, that defines the latitudinal/longitudinal bounds of the geo shape.
\since 5.9
--
GitLab