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/location/declarativemaps/qdeclarativepolylinemapitem.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/location/declarativemaps/qdeclarativepolylinemapitem.cpp')
| -rw-r--r-- | src/location/declarativemaps/qdeclarativepolylinemapitem.cpp | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp b/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp index 9ef65188..473c92ff 100644 --- a/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp +++ b/src/location/declarativemaps/qdeclarativepolylinemapitem.cpp @@ -62,7 +62,7 @@ QT_BEGIN_NAMESPACE \instantiates QDeclarativePolylineMapItem \inqmlmodule QtLocation \ingroup qml-QtLocation5-maps - \since Qt Location 5.0 + \since QtLocation 5.0 \brief The MapPolyline type displays a polyline on a map. @@ -509,7 +509,7 @@ void QDeclarativePolylineMapItem::setPathFromGeoList(const QList<QGeoCoordinate> Returns the number of coordinates of the polyline. - \since Qt Location 5.6 + \since QtLocation 5.6 \sa path */ @@ -543,7 +543,7 @@ void QDeclarativePolylineMapItem::addCoordinate(const QGeoCoordinate &coordinate Inserts a \a coordinate to the path at the given \a index. - \since Qt Location 5.6 + \since QtLocation 5.6 \sa addCoordinate, removeCoordinate, path */ @@ -566,7 +566,7 @@ void QDeclarativePolylineMapItem::insertCoordinate(int index, const QGeoCoordina Replaces the coordinate in the current path at the given \a index with the new \a coordinate. - \since Qt Location 5.6 + \since QtLocation 5.6 \sa addCoordinate, insertCoordinate, removeCoordinate, path */ @@ -590,7 +590,7 @@ void QDeclarativePolylineMapItem::replaceCoordinate(int index, const QGeoCoordin If the index is outside the path's bounds then an invalid coordinate is returned. - \since Qt Location 5.6 + \since QtLocation 5.6 */ QGeoCoordinate QDeclarativePolylineMapItem::coordinateAt(int index) const { @@ -605,7 +605,7 @@ QGeoCoordinate QDeclarativePolylineMapItem::coordinateAt(int index) const Returns true if the given \a coordinate is part of the path. - \since Qt Location 5.6 + \since QtLocation 5.6 */ bool QDeclarativePolylineMapItem::containsCoordinate(const QGeoCoordinate &coordinate) { @@ -641,7 +641,7 @@ void QDeclarativePolylineMapItem::removeCoordinate(const QGeoCoordinate &coordin If \a index is invalid then this method does nothing. - \since Qt Location 5.6 + \since QtLocation 5.6 \sa addCoordinate, insertCoordinate, path */ |