From d77cf0647ec49b225e436598e54161fa4aa8ff2c Mon Sep 17 00:00:00 2001 From: Ivan Solovev Date: Thu, 29 Sep 2022 14:16:16 +0200 Subject: [PATCH] Provide documentation for qsystemdetection.h header The description of the macros in this header should not belong to , so move it to a separate documentation page. Task-number: QTBUG-106154 Change-Id: Ic484f8b5ac137b052864937b526384e821f38fda Reviewed-by: Thiago Macieira --- src/corelib/global/qglobal.cpp | 183 -------------------- src/corelib/global/qsystemdetection.h | 1 + src/corelib/global/qsystemdetection.qdoc | 202 +++++++++++++++++++++++ 3 files changed, 203 insertions(+), 183 deletions(-) create mode 100644 src/corelib/global/qsystemdetection.qdoc diff --git a/src/corelib/global/qglobal.cpp b/src/corelib/global/qglobal.cpp index ef0f53c51c4..47a14500ba2 100644 --- a/src/corelib/global/qglobal.cpp +++ b/src/corelib/global/qglobal.cpp @@ -177,189 +177,6 @@ using namespace Qt::StringLiterals; System detection routines *****************************************************************************/ -/*! - \macro Q_OS_DARWIN - \relates - - Defined on Darwin-based operating systems such as \macos, iOS, watchOS, and tvOS. -*/ - -/*! - \macro Q_OS_MAC - \relates - - Deprecated synonym for \c Q_OS_DARWIN. Do not use. -*/ - -/*! - \macro Q_OS_OSX - \relates - - Deprecated synonym for \c Q_OS_MACOS. Do not use. -*/ - -/*! - \macro Q_OS_MACOS - \relates - - Defined on \macos. -*/ - -/*! - \macro Q_OS_IOS - \relates - - Defined on iOS. -*/ - -/*! - \macro Q_OS_WATCHOS - \relates - - Defined on watchOS. -*/ - -/*! - \macro Q_OS_TVOS - \relates - - Defined on tvOS. -*/ - -/*! - \macro Q_OS_WIN - \relates - - 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 - - This is a synonym for Q_OS_WIN. -*/ - -/*! - \macro Q_OS_WIN32 - \relates - - Defined on 32-bit and 64-bit versions of Windows. -*/ - -/*! - \macro Q_OS_WIN64 - \relates - - Defined on 64-bit versions of Windows. -*/ - -/*! - \macro Q_OS_CYGWIN - \relates - - Defined on Cygwin. -*/ - -/*! - \macro Q_OS_SOLARIS - \relates - - Defined on Sun Solaris. -*/ - -/*! - \macro Q_OS_HPUX - \relates - - Defined on HP-UX. -*/ - -/*! - \macro Q_OS_LINUX - \relates - - Defined on Linux. -*/ - -/*! - \macro Q_OS_ANDROID - \relates - - Defined on Android. -*/ - -/*! - \macro Q_OS_FREEBSD - \relates - - Defined on FreeBSD. -*/ - -/*! - \macro Q_OS_NETBSD - \relates - - Defined on NetBSD. -*/ - -/*! - \macro Q_OS_OPENBSD - \relates - - Defined on OpenBSD. -*/ - -/*! - \macro Q_OS_AIX - \relates - - Defined on AIX. -*/ - -/*! - \macro Q_OS_HURD - \relates - - Defined on GNU Hurd. -*/ - -/*! - \macro Q_OS_QNX - \relates - - Defined on QNX Neutrino. -*/ - -/*! - \macro Q_OS_LYNX - \relates - - Defined on LynxOS. -*/ - -/*! - \macro Q_OS_BSD4 - \relates - - Defined on Any BSD 4.4 system. -*/ - -/*! - \macro Q_OS_UNIX - \relates - - Defined on Any UNIX BSD/SYSV system. -*/ - -/*! - \macro Q_OS_WASM - \relates - - Defined on Web Assembly. -*/ - /*! \macro Q_CC_SYM \relates diff --git a/src/corelib/global/qsystemdetection.h b/src/corelib/global/qsystemdetection.h index 1c90aa0b19f..3a992f2abae 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 00000000000..210f865ffe6 --- /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 + \inmodule QtCore + \title Platform-specific Macro Definitions + \ingroup funclists + + \brief The header file includes various + platfrom-specific macros. + + The 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 + + Defined on Darwin-based operating systems such as \macos, iOS, watchOS, and tvOS. +*/ + +/*! + \macro Q_OS_MAC + \relates + + Deprecated synonym for \c Q_OS_DARWIN. Do not use. +*/ + +/*! + \macro Q_OS_OSX + \relates + + Deprecated synonym for \c Q_OS_MACOS. Do not use. +*/ + +/*! + \macro Q_OS_MACOS + \relates + + Defined on \macos. +*/ + +/*! + \macro Q_OS_IOS + \relates + + Defined on iOS. +*/ + +/*! + \macro Q_OS_WATCHOS + \relates + + Defined on watchOS. +*/ + +/*! + \macro Q_OS_TVOS + \relates + + Defined on tvOS. +*/ + +/*! + \macro Q_OS_WIN + \relates + + 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 + + This is a synonym for Q_OS_WIN. +*/ + +/*! + \macro Q_OS_WIN32 + \relates + + Defined on 32-bit and 64-bit versions of Windows. +*/ + +/*! + \macro Q_OS_WIN64 + \relates + + Defined on 64-bit versions of Windows. +*/ + +/*! + \macro Q_OS_CYGWIN + \relates + + Defined on Cygwin. +*/ + +/*! + \macro Q_OS_SOLARIS + \relates + + Defined on Sun Solaris. +*/ + +/*! + \macro Q_OS_HPUX + \relates + + Defined on HP-UX. +*/ + +/*! + \macro Q_OS_LINUX + \relates + + Defined on Linux. +*/ + +/*! + \macro Q_OS_ANDROID + \relates + + Defined on Android. +*/ + +/*! + \macro Q_OS_FREEBSD + \relates + + Defined on FreeBSD. +*/ + +/*! + \macro Q_OS_NETBSD + \relates + + Defined on NetBSD. +*/ + +/*! + \macro Q_OS_OPENBSD + \relates + + Defined on OpenBSD. +*/ + +/*! + \macro Q_OS_AIX + \relates + + Defined on AIX. +*/ + +/*! + \macro Q_OS_HURD + \relates + + Defined on GNU Hurd. +*/ + +/*! + \macro Q_OS_QNX + \relates + + Defined on QNX Neutrino. +*/ + +/*! + \macro Q_OS_LYNX + \relates + + Defined on LynxOS. +*/ + +/*! + \macro Q_OS_BSD4 + \relates + + Defined on any BSD 4.4 system. +*/ + +/*! + \macro Q_OS_UNIX + \relates + + Defined on any UNIX BSD/SYSV system. +*/ + +/*! + \macro Q_OS_WASM + \relates + + Defined on Web Assembly. +*/