aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2018-03-20 12:08:38 +0100
committerTopi Reiniƶ <topi.reinio@qt.io>2018-04-11 09:43:58 +0000
commit0fca0cc446c708aedc4fc5130068ad00e84f275b (patch)
tree03ddc826216f13574dabd39d942c71ff9e4679ef
parente484402ad1d9b6d3b89333585b1ead97e4d21635 (diff)
Doc: Fix documentation warnings related to Clang-enabled QDoc
Since Qt 5.11, QDoc uses Clang to parse C++ documentation. On platforms where Qt Windows Extras does not build, we still need to be able to build the documentation. To enable this, create a custom module header and include paths for Clang-QDoc, used only in documentation builds, and add dummy typedefs for Windows-specific types for Clang to see. Change-Id: I641570c80b6cc948c92c404d8d90ad1a3045925c Reviewed-by: Martin Smith <martin.smith@qt.io>
-rw-r--r--src/winextras/doc/QtWinExtras/qwinextrasglobal.h1
-rw-r--r--src/winextras/doc/QtWinExtrasDoc22
-rw-r--r--src/winextras/doc/qtwinextras.qdocconf5
-rw-r--r--src/winextras/qwinmime.h5
4 files changed, 33 insertions, 0 deletions
diff --git a/src/winextras/doc/QtWinExtras/qwinextrasglobal.h b/src/winextras/doc/QtWinExtras/qwinextrasglobal.h
new file mode 100644
index 0000000..2da776f
--- /dev/null
+++ b/src/winextras/doc/QtWinExtras/qwinextrasglobal.h
@@ -0,0 +1 @@
+#include "../../qwinextrasglobal.h"
diff --git a/src/winextras/doc/QtWinExtrasDoc b/src/winextras/doc/QtWinExtrasDoc
new file mode 100644
index 0000000..7d14c34
--- /dev/null
+++ b/src/winextras/doc/QtWinExtrasDoc
@@ -0,0 +1,22 @@
+#include "qwinevent.h"
+#include "qwinjumplist_p.h"
+#include "winpropkey_p.h"
+#include "qwinfunctions_p.h"
+#include "qwineventfilter_p.h"
+#include "winshobjidl_p.h"
+#include "qwintaskbarbutton.h"
+#include "qwinmime.h"
+#include "qwinextrasglobal.h"
+#include "qwinthumbnailtoolbar.h"
+#include "qwinthumbnailtoolbutton_p.h"
+#include "qwinjumplistitem.h"
+#include "qwinjumplist.h"
+#include "qwinthumbnailtoolbar_p.h"
+#include "qwinjumplistitem_p.h"
+#include "windowsguidsdefs_p.h"
+#include "qwinfunctions.h"
+#include "qwinjumplistcategory_p.h"
+#include "qwintaskbarbutton_p.h"
+#include "qwinthumbnailtoolbutton.h"
+#include "qwintaskbarprogress.h"
+#include "qwinjumplistcategory.h"
diff --git a/src/winextras/doc/qtwinextras.qdocconf b/src/winextras/doc/qtwinextras.qdocconf
index 27b991a..c6238f2 100644
--- a/src/winextras/doc/qtwinextras.qdocconf
+++ b/src/winextras/doc/qtwinextras.qdocconf
@@ -9,6 +9,11 @@ exampledirs += ../../../examples/winextras \
examplesinstallpath = winextras
+moduleheader = QtWinExtrasDoc
+
+includepaths = -I . \
+ -I ..
+
headerdirs = .. ../../imports/winextras
sourcedirs = .. ../../imports/winextras
imagedirs += images
diff --git a/src/winextras/qwinmime.h b/src/winextras/qwinmime.h
index ff20dd3..469ef30 100644
--- a/src/winextras/qwinmime.h
+++ b/src/winextras/qwinmime.h
@@ -51,6 +51,11 @@ QT_BEGIN_NAMESPACE
class QMimeData;
+#ifdef Q_CLANG_QDOC
+typedef struct _FORMATETC {} FORMATETC;
+typedef struct _STGMEDIUM {} STGMEDIUM;
+#endif
+
class Q_WINEXTRAS_EXPORT QWinMime // Keep in sync with QWindowsMime in the Windows platform plugin.
{
Q_DISABLE_COPY(QWinMime)