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/positioningquick | |
| 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/positioningquick')
| -rw-r--r-- | src/positioningquick/qdeclarativeposition.cpp | 2 | ||||
| -rw-r--r-- | src/positioningquick/qdeclarativepositionsource.cpp | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/src/positioningquick/qdeclarativeposition.cpp b/src/positioningquick/qdeclarativeposition.cpp index 7e72f358..b63aaab8 100644 --- a/src/positioningquick/qdeclarativeposition.cpp +++ b/src/positioningquick/qdeclarativeposition.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype Position - \instantiates QDeclarativePosition + //! \instantiates QDeclarativePosition \inqmlmodule QtPositioning \since 5.2 diff --git a/src/positioningquick/qdeclarativepositionsource.cpp b/src/positioningquick/qdeclarativepositionsource.cpp index d290de25..ec462f23 100644 --- a/src/positioningquick/qdeclarativepositionsource.cpp +++ b/src/positioningquick/qdeclarativepositionsource.cpp @@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype PositionSource - \instantiates QDeclarativePositionSource + //! \instantiates QDeclarativePositionSource \inqmlmodule QtPositioning \since 5.2 |