summaryrefslogtreecommitdiffstats
path: root/src/corelib/global
diff options
context:
space:
mode:
authorIvan Solovev <ivan.solovev@qt.io>2022-09-29 14:16:16 +0200
committerIvan Solovev <ivan.solovev@qt.io>2022-10-06 11:36:46 +0200
commitd77cf0647ec49b225e436598e54161fa4aa8ff2c (patch)
treeaaafec3a3da1ca80d0d85f76d8ff0132daee881a /src/corelib/global
parentb22a726f25b47f2a800a16d35da6aee7f622bcd9 (diff)
Provide documentation for qsystemdetection.h header
The description of the macros in this header should not belong to <QtGlobal>, so move it to a separate documentation page. Task-number: QTBUG-106154 Change-Id: Ic484f8b5ac137b052864937b526384e821f38fda Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Diffstat (limited to 'src/corelib/global')
-rw-r--r--src/corelib/global/qglobal.cpp183
-rw-r--r--src/corelib/global/qsystemdetection.h1
-rw-r--r--src/corelib/global/qsystemdetection.qdoc202
3 files changed, 203 insertions, 183 deletions
diff --git a/src/corelib/global/qglobal.cpp b/src/corelib/global/qglobal.cpp
index ef0f53c51c..47a14500ba 100644
--- a/src/corelib/global/qglobal.cpp
+++ b/src/corelib/global/qglobal.cpp
@@ -178,189 +178,6 @@ using namespace Qt::StringLiterals;
*****************************************************************************/
/*!
- \macro Q_OS_DARWIN
- \relates <QtGlobal>
-
- Defined on Darwin-based operating systems such as \macos, iOS, watchOS, and tvOS.
-*/
-
-/*!
- \macro Q_OS_MAC
- \relates <QtGlobal>
-
- Deprecated synonym for \c Q_OS_DARWIN. Do not use.
-*/
-
-/*!
- \macro Q_OS_OSX
- \relates <QtGlobal>
-
- Deprecated synonym for \c Q_OS_MACOS. Do not use.
-*/
-
-/*!
- \macro Q_OS_MACOS
- \relates <QtGlobal>
-
- Defined on \macos.
-*/
-
-/*!
- \macro Q_OS_IOS
- \relates <QtGlobal>
-
- Defined on iOS.
-*/
-
-/*!
- \macro Q_OS_WATCHOS
- \relates <QtGlobal>
-
- Defined on watchOS.
-*/
-
-/*!
- \macro Q_OS_TVOS
- \relates <QtGlobal>
-
- Defined on tvOS.
-*/
-
-/*!
- \macro Q_OS_WIN
- \relates <QtGlobal>
-
- Defined on all supported versions of Windows. That is, if
- \l Q_OS_WIN32 or \l Q_OS_WIN64 is defined.
-*/
-
-/*!
- \macro Q_OS_WINDOWS
- \relates <QtGlobal>
-
- This is a synonym for Q_OS_WIN.
-*/
-
-/*!
- \macro Q_OS_WIN32
- \relates <QtGlobal>
-
- Defined on 32-bit and 64-bit versions of Windows.
-*/
-
-/*!
- \macro Q_OS_WIN64
- \relates <QtGlobal>
-
- Defined on 64-bit versions of Windows.
-*/
-
-/*!
- \macro Q_OS_CYGWIN
- \relates <QtGlobal>
-
- Defined on Cygwin.
-*/
-
-/*!
- \macro Q_OS_SOLARIS
- \relates <QtGlobal>
-
- Defined on Sun Solaris.
-*/
-
-/*!
- \macro Q_OS_HPUX
- \relates <QtGlobal>
-
- Defined on HP-UX.
-*/
-
-/*!
- \macro Q_OS_LINUX
- \relates <QtGlobal>
-
- Defined on Linux.
-*/
-
-/*!
- \macro Q_OS_ANDROID
- \relates <QtGlobal>
-
- Defined on Android.
-*/
-
-/*!
- \macro Q_OS_FREEBSD
- \relates <QtGlobal>
-
- Defined on FreeBSD.
-*/
-
-/*!
- \macro Q_OS_NETBSD
- \relates <QtGlobal>
-
- Defined on NetBSD.
-*/
-
-/*!
- \macro Q_OS_OPENBSD
- \relates <QtGlobal>
-
- Defined on OpenBSD.
-*/
-
-/*!
- \macro Q_OS_AIX
- \relates <QtGlobal>
-
- Defined on AIX.
-*/
-
-/*!
- \macro Q_OS_HURD
- \relates <QtGlobal>
-
- Defined on GNU Hurd.
-*/
-
-/*!
- \macro Q_OS_QNX
- \relates <QtGlobal>
-
- Defined on QNX Neutrino.
-*/
-
-/*!
- \macro Q_OS_LYNX
- \relates <QtGlobal>
-
- Defined on LynxOS.
-*/
-
-/*!
- \macro Q_OS_BSD4
- \relates <QtGlobal>
-
- Defined on Any BSD 4.4 system.
-*/
-
-/*!
- \macro Q_OS_UNIX
- \relates <QtGlobal>
-
- Defined on Any UNIX BSD/SYSV system.
-*/
-
-/*!
- \macro Q_OS_WASM
- \relates <QtGlobal>
-
- Defined on Web Assembly.
-*/
-
-/*!
\macro Q_CC_SYM
\relates <QtGlobal>
diff --git a/src/corelib/global/qsystemdetection.h b/src/corelib/global/qsystemdetection.h
index 1c90aa0b19..3a992f2aba 100644
--- a/src/corelib/global/qsystemdetection.h
+++ b/src/corelib/global/qsystemdetection.h
@@ -7,6 +7,7 @@
#endif
#if 0
+#pragma qt_class(QtSystemDetection)
#pragma qt_sync_skip_header_check
#pragma qt_sync_stop_processing
#endif
diff --git a/src/corelib/global/qsystemdetection.qdoc b/src/corelib/global/qsystemdetection.qdoc
new file mode 100644
index 0000000000..210f865ffe
--- /dev/null
+++ b/src/corelib/global/qsystemdetection.qdoc
@@ -0,0 +1,202 @@
+// Copyright (C) 2022 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+ \headerfile <QtSystemDetection>
+ \inmodule QtCore
+ \title Platform-specific Macro Definitions
+ \ingroup funclists
+
+ \brief The <QtSystemDetection> header file includes various
+ platfrom-specific macros.
+
+ The <QtSystemDetection> header file declares a range of macros (Q_OS_*)
+ that are defined for the specified platforms. For example, Q_OS_UNIX which
+ is defined for Unix-based systems.
+
+ The purpose of these macros is to enable programmers to add
+ platform-specific code to their application.
+*/
+
+/*!
+ \macro Q_OS_DARWIN
+ \relates <QtSystemDetection>
+
+ Defined on Darwin-based operating systems such as \macos, iOS, watchOS, and tvOS.
+*/
+
+/*!
+ \macro Q_OS_MAC
+ \relates <QtSystemDetection>
+
+ Deprecated synonym for \c Q_OS_DARWIN. Do not use.
+*/
+
+/*!
+ \macro Q_OS_OSX
+ \relates <QtSystemDetection>
+
+ Deprecated synonym for \c Q_OS_MACOS. Do not use.
+*/
+
+/*!
+ \macro Q_OS_MACOS
+ \relates <QtSystemDetection>
+
+ Defined on \macos.
+*/
+
+/*!
+ \macro Q_OS_IOS
+ \relates <QtSystemDetection>
+
+ Defined on iOS.
+*/
+
+/*!
+ \macro Q_OS_WATCHOS
+ \relates <QtSystemDetection>
+
+ Defined on watchOS.
+*/
+
+/*!
+ \macro Q_OS_TVOS
+ \relates <QtSystemDetection>
+
+ Defined on tvOS.
+*/
+
+/*!
+ \macro Q_OS_WIN
+ \relates <QtSystemDetection>
+
+ Defined on all supported versions of Windows. That is, if
+ \l Q_OS_WIN32 or \l Q_OS_WIN64 is defined.
+*/
+
+/*!
+ \macro Q_OS_WINDOWS
+ \relates <QtSystemDetection>
+
+ This is a synonym for Q_OS_WIN.
+*/
+
+/*!
+ \macro Q_OS_WIN32
+ \relates <QtSystemDetection>
+
+ Defined on 32-bit and 64-bit versions of Windows.
+*/
+
+/*!
+ \macro Q_OS_WIN64
+ \relates <QtSystemDetection>
+
+ Defined on 64-bit versions of Windows.
+*/
+
+/*!
+ \macro Q_OS_CYGWIN
+ \relates <QtSystemDetection>
+
+ Defined on Cygwin.
+*/
+
+/*!
+ \macro Q_OS_SOLARIS
+ \relates <QtSystemDetection>
+
+ Defined on Sun Solaris.
+*/
+
+/*!
+ \macro Q_OS_HPUX
+ \relates <QtSystemDetection>
+
+ Defined on HP-UX.
+*/
+
+/*!
+ \macro Q_OS_LINUX
+ \relates <QtSystemDetection>
+
+ Defined on Linux.
+*/
+
+/*!
+ \macro Q_OS_ANDROID
+ \relates <QtSystemDetection>
+
+ Defined on Android.
+*/
+
+/*!
+ \macro Q_OS_FREEBSD
+ \relates <QtSystemDetection>
+
+ Defined on FreeBSD.
+*/
+
+/*!
+ \macro Q_OS_NETBSD
+ \relates <QtSystemDetection>
+
+ Defined on NetBSD.
+*/
+
+/*!
+ \macro Q_OS_OPENBSD
+ \relates <QtSystemDetection>
+
+ Defined on OpenBSD.
+*/
+
+/*!
+ \macro Q_OS_AIX
+ \relates <QtSystemDetection>
+
+ Defined on AIX.
+*/
+
+/*!
+ \macro Q_OS_HURD
+ \relates <QtSystemDetection>
+
+ Defined on GNU Hurd.
+*/
+
+/*!
+ \macro Q_OS_QNX
+ \relates <QtSystemDetection>
+
+ Defined on QNX Neutrino.
+*/
+
+/*!
+ \macro Q_OS_LYNX
+ \relates <QtSystemDetection>
+
+ Defined on LynxOS.
+*/
+
+/*!
+ \macro Q_OS_BSD4
+ \relates <QtSystemDetection>
+
+ Defined on any BSD 4.4 system.
+*/
+
+/*!
+ \macro Q_OS_UNIX
+ \relates <QtSystemDetection>
+
+ Defined on any UNIX BSD/SYSV system.
+*/
+
+/*!
+ \macro Q_OS_WASM
+ \relates <QtSystemDetection>
+
+ Defined on Web Assembly.
+*/