summaryrefslogtreecommitdiff
path: root/src/location/qlocationglobal.h
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2018-03-26 09:40:56 +0200
committerTopi Reiniƶ <topi.reinio@qt.io>2018-03-27 10:16:26 +0000
commitacc8bc079cda6a31a9d19dca860a1a2db378addf (patch)
treeba4062a266431d7724d528c89364e9c1dc2f2be2 /src/location/qlocationglobal.h
parent0af62cbe7ddf6a6ef858daa63b0ab02426d3aad9 (diff)
downloadqtlocation-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/qlocationglobal.h')
-rw-r--r--src/location/qlocationglobal.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/location/qlocationglobal.h b/src/location/qlocationglobal.h
index 7992c097..e7355f04 100644
--- a/src/location/qlocationglobal.h
+++ b/src/location/qlocationglobal.h
@@ -50,6 +50,10 @@ QT_BEGIN_NAMESPACE
# define Q_LOCATION_EXPORT
#endif
+#ifdef Q_CLANG_QDOC
+#include "qlocation.h"
+#endif
+
QT_END_NAMESPACE
#endif // QLOCATIONGLOBAL_H