summaryrefslogtreecommitdiffstats
path: root/src/gui/kernel
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2020-07-24 08:30:31 +0200
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2020-09-02 05:29:44 +0200
commita494da3b2097177774b7b6676acd8e8c46c3e41d (patch)
tree7350bed455368155d765492e337cdabdac54ba52 /src/gui/kernel
parentd23c118fd4b733b60bb41ee07c6a91d914afd129 (diff)
Document native interfaces
As the private headers are not included by default in the precompiled header QDoc builds for QtGui, create a custom module header for the documentation build and pull in the required headers. Add dummy declarations for Windows-specific types for building docs on non-Windows platforms. Task-number: QTBUG-83252 Change-Id: I225ed08f68cf4f7c1f1d093424070b13ce36aa51 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
Diffstat (limited to 'src/gui/kernel')
-rw-r--r--src/gui/kernel/qguiapplication_p.h2
-rw-r--r--src/gui/kernel/qkeymapper_p.h2
-rw-r--r--src/gui/kernel/qopenglcontext_platform.h10
-rw-r--r--src/gui/kernel/qplatformmenu_p.h6
-rw-r--r--src/gui/kernel/qplatformwindow_p.h6
5 files changed, 17 insertions, 9 deletions
diff --git a/src/gui/kernel/qguiapplication_p.h b/src/gui/kernel/qguiapplication_p.h
index 41b745e569..2bbb5ae9a6 100644
--- a/src/gui/kernel/qguiapplication_p.h
+++ b/src/gui/kernel/qguiapplication_p.h
@@ -372,7 +372,7 @@ Q_GUI_EXPORT bool operator==(const QGuiApplicationPrivate::ActiveTouchPointsKey
namespace QPlatformInterface::Private {
-#if defined(Q_OS_WIN)
+#if defined(Q_OS_WIN) || defined(Q_CLANG_QDOC)
class QWindowsMime;
diff --git a/src/gui/kernel/qkeymapper_p.h b/src/gui/kernel/qkeymapper_p.h
index 9abdbbb732..fea671cf40 100644
--- a/src/gui/kernel/qkeymapper_p.h
+++ b/src/gui/kernel/qkeymapper_p.h
@@ -103,7 +103,7 @@ QKeyMapperPrivate *qt_keymapper_private(); // from qkeymapper.cpp
namespace QPlatformInterface::Private {
-#if QT_CONFIG(evdev)
+#if QT_CONFIG(evdev) || defined(Q_CLANG_QDOC)
struct Q_GUI_EXPORT QEvdevKeyMapper
{
QT_DECLARE_PLATFORM_INTERFACE(QEvdevKeyMapper)
diff --git a/src/gui/kernel/qopenglcontext_platform.h b/src/gui/kernel/qopenglcontext_platform.h
index 25be8623c6..1b03325c7f 100644
--- a/src/gui/kernel/qopenglcontext_platform.h
+++ b/src/gui/kernel/qopenglcontext_platform.h
@@ -58,11 +58,15 @@ typedef void *EGLContext;
typedef void *EGLDisplay;
#endif
+#if !defined(Q_OS_MACOS) && defined(Q_CLANG_QDOC)
+typedef void *NSOpenGLContext;
+#endif
+
QT_BEGIN_NAMESPACE
namespace QPlatformInterface {
-#if defined(Q_OS_MACOS)
+#if defined(Q_OS_MACOS) || defined(Q_CLANG_QDOC)
struct Q_GUI_EXPORT QCocoaGLContext
{
QT_DECLARE_PLATFORM_INTERFACE(QCocoaGLContext)
@@ -71,7 +75,7 @@ struct Q_GUI_EXPORT QCocoaGLContext
};
#endif
-#if defined(Q_OS_WIN)
+#if defined(Q_OS_WIN) || defined(Q_CLANG_QDOC)
struct Q_GUI_EXPORT QWGLContext
{
QT_DECLARE_PLATFORM_INTERFACE(QWGLContext)
@@ -81,7 +85,7 @@ struct Q_GUI_EXPORT QWGLContext
};
#endif
-#if defined(Q_OS_LINUX)
+#if defined(Q_OS_LINUX) || defined(Q_CLANG_QDOC)
struct Q_GUI_EXPORT QGLXContext
{
QT_DECLARE_PLATFORM_INTERFACE(QGLXContext)
diff --git a/src/gui/kernel/qplatformmenu_p.h b/src/gui/kernel/qplatformmenu_p.h
index 05e17051ba..40aef4bfd4 100644
--- a/src/gui/kernel/qplatformmenu_p.h
+++ b/src/gui/kernel/qplatformmenu_p.h
@@ -57,13 +57,17 @@ QT_BEGIN_NAMESPACE
// ----------------- QPlatformInterface -----------------
+#if !defined(Q_OS_MACOS) && defined(Q_CLANG_QDOC)
+typedef void NSMenu;
+#else
QT_END_NAMESPACE
Q_FORWARD_DECLARE_OBJC_CLASS(NSMenu);
QT_BEGIN_NAMESPACE
+#endif
namespace QPlatformInterface::Private {
-#if defined(Q_OS_MACOS)
+#if defined(Q_OS_MACOS) || defined(Q_CLANG_QDOC)
struct Q_GUI_EXPORT QCocoaMenu
{
QT_DECLARE_PLATFORM_INTERFACE(QCocoaMenu)
diff --git a/src/gui/kernel/qplatformwindow_p.h b/src/gui/kernel/qplatformwindow_p.h
index d69e7a5749..7d459556fd 100644
--- a/src/gui/kernel/qplatformwindow_p.h
+++ b/src/gui/kernel/qplatformwindow_p.h
@@ -70,7 +70,7 @@ public:
namespace QPlatformInterface::Private {
-#if defined(Q_OS_MACOS)
+#if defined(Q_OS_MACOS) || defined(Q_CLANG_QDOC)
struct Q_GUI_EXPORT QCocoaWindow
{
QT_DECLARE_PLATFORM_INTERFACE(QCocoaWindow)
@@ -79,7 +79,7 @@ struct Q_GUI_EXPORT QCocoaWindow
};
#endif
-#if QT_CONFIG(xcb)
+#if QT_CONFIG(xcb) || defined(Q_CLANG_QDOC)
struct Q_GUI_EXPORT QXcbWindow
{
QT_DECLARE_PLATFORM_INTERFACE(QXcbWindow)
@@ -111,7 +111,7 @@ struct Q_GUI_EXPORT QXcbWindow
};
#endif // xcb
-#ifdef Q_OS_WIN
+#if defined(Q_OS_WIN) || defined(Q_CLANG_QDOC)
struct Q_GUI_EXPORT QWindowsWindow
{
QT_DECLARE_PLATFORM_INTERFACE(QWindowsWindow)