diff options
author | Topi Reinio <topi.reinio@qt.io> | 2018-03-26 09:40:56 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@qt.io> | 2018-03-27 10:16:26 +0000 |
commit | acc8bc079cda6a31a9d19dca860a1a2db378addf (patch) | |
tree | ba4062a266431d7724d528c89364e9c1dc2f2be2 /src/positioning/qgeoshape.cpp | |
parent | 0af62cbe7ddf6a6ef858daa63b0ab02426d3aad9 (diff) | |
download | qtlocation-acc8bc079cda6a31a9d19dca860a1a2db378addf.tar.gz |
Doc: Fix all documentation warnings
Fix multiple warnings caused by invalid documentation configuration,
missing QML module specifiers, wrong QML type names, incorrect
arguments for the \fn command, and missing documentation.
Remove incorrect statement from the example usage of the Waypoint
QML type.
Use 'QtLocation' as the name for the module throughout the docs.
Clang (used as the parser for QDoc in Qt 5.11) was unable to
resolve the path for qlocation.h, causing QDoc to omit the
QLocation namespace documentation. Fix this by including the
file explicitly from qlocationglobal.h for documentation
builds.
Change-Id: I2bd790db1ff5ad96f0cdb415a682b97593b3a6dc
Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'src/positioning/qgeoshape.cpp')
-rw-r--r-- | src/positioning/qgeoshape.cpp | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/src/positioning/qgeoshape.cpp b/src/positioning/qgeoshape.cpp index 7acbc9fa..d17f9eea 100644 --- a/src/positioning/qgeoshape.cpp +++ b/src/positioning/qgeoshape.cpp @@ -93,10 +93,11 @@ bool QGeoShapePrivate::operator==(const QGeoShapePrivate &other) const Describes the type of the shape. - \value UnknownType A shape of unknown type. - \value RectangleType A rectangular shape. - \value CircleType A circular shape. - \value PathType A path type. + \value UnknownType A shape of unknown type + \value RectangleType A rectangular shape + \value CircleType A circular shape + \value PathType A path type + \value PolygonType A polygon type */ /*! |