From c4b32597e789b259a4881c76f51a6c7150d2bc10 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Wed, 1 Feb 2023 13:19:17 +0000 Subject: [PATCH] Doc: Fix documentation warnings for Qt Core These linking issues were not caught by documentation testing in the CI. * android-content-uri-limitations.qdocinc: Fix external link title * Fix links to 'Native IPC Keys' * Fix \sa links to 'Inter-Process Communication' * Replace \sa links to non-existent function nativeKeyType() * Drop explicit link to undocumented class QBasicAtomicInteger Change-Id: I041a8cd2301cc2e77b88c085e74e9178e507a7a1 Reviewed-by: Venugopal Shivashankar Reviewed-by: Nicholas Bennett --- .../includes/android-content-uri-limitations.qdocinc | 2 +- src/corelib/doc/src/ipc.qdoc | 2 +- src/corelib/ipc/qsharedmemory.cpp | 10 +++++----- src/corelib/ipc/qsystemsemaphore.cpp | 6 +++--- src/corelib/ipc/qtipccommon.cpp | 4 ++-- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/corelib/doc/src/includes/android-content-uri-limitations.qdocinc b/src/corelib/doc/src/includes/android-content-uri-limitations.qdocinc index f08086407ee..0521aff662e 100644 --- a/src/corelib/doc/src/includes/android-content-uri-limitations.qdocinc +++ b/src/corelib/doc/src/includes/android-content-uri-limitations.qdocinc @@ -3,7 +3,7 @@ On Android, some limitations apply when dealing with \list \li Access permissions might be needed by prompting the user through the \l QFileDialog which implements - \l {Access documents and other files from shared storage}{Android's native file picker}. + \l {Android: Access documents and other files from shared storage}{Android's native file picker}. \li Aim to follow the \l {Android: Scoped storage}{Scoped storage} guidelines, such as using app specific directories instead of other public external directories. For more information, also see diff --git a/src/corelib/doc/src/ipc.qdoc b/src/corelib/doc/src/ipc.qdoc index e78f412f780..1de20f89a2a 100644 --- a/src/corelib/doc/src/ipc.qdoc +++ b/src/corelib/doc/src/ipc.qdoc @@ -138,7 +138,7 @@ To achieve locking of the shared memory segment, applications will need to deploy their own mechanisms. One way may be to use \l QLockFile. Another - and less costly solution is to \l QBasicAtomicInteger or \c{std::atomic} in + and less costly solution is to use QBasicAtomicInteger or \c{std::atomic} in a pre-determined offset in the segment itself. Higher-level locking primitives may be available on some operating systems; for example, on Linux, applications can set the "pshared" flag in the mutex attribute diff --git a/src/corelib/ipc/qsharedmemory.cpp b/src/corelib/ipc/qsharedmemory.cpp index 501036a6502..ea0ff4f1b3b 100644 --- a/src/corelib/ipc/qsharedmemory.cpp +++ b/src/corelib/ipc/qsharedmemory.cpp @@ -94,11 +94,11 @@ inline QNativeIpcKey QSharedMemoryPrivate::semaphoreNativeKey() const For details on the key types, platform-specific limitations, and interoperability with older or non-Qt applications, see the \l{Native IPC - Key} documentation. That includes important information for sandboxed + Keys} documentation. That includes important information for sandboxed applications on Apple platforms, including all apps obtained via the Apple App Store. - \sa Inter-Process Communication, QSystemSemaphore + \sa {Inter-Process Communication}, QSystemSemaphore */ /*! @@ -212,7 +212,7 @@ void QSharedMemory::setKey(const QString &key) You can call nativeKey() to retrieve the native key. - \sa nativeKey(), nativeKeyType(), isAttached() + \sa nativeKey(), nativeIpcKey(), isAttached() */ /*! @@ -231,7 +231,7 @@ void QSharedMemory::setKey(const QString &key) You can call nativeKey() to retrieve the native key. - \sa nativeKey(), nativeKeyType(), isAttached() + \sa nativeKey(), nativeIpcKey(), isAttached() */ void QSharedMemory::setNativeKey(const QNativeIpcKey &key) { @@ -329,7 +329,7 @@ QString QSharedMemory::key() const been created by Qt, or to grant shared memory access to non-Qt applications. See \l{Native IPC Keys} for more information. - \sa setNativeKey(), nativeKeyType() + \sa setNativeKey(), nativeIpcKey() */ QString QSharedMemory::nativeKey() const { diff --git a/src/corelib/ipc/qsystemsemaphore.cpp b/src/corelib/ipc/qsystemsemaphore.cpp index fed4f414962..c41ae6dbc26 100644 --- a/src/corelib/ipc/qsystemsemaphore.cpp +++ b/src/corelib/ipc/qsystemsemaphore.cpp @@ -61,11 +61,11 @@ inline void QSystemSemaphorePrivate::destructBackend() For details on the key types, platform-specific limitations, and interoperability with older or non-Qt applications, see the \l{Native IPC - Key} documentation. That includes important information for sandboxed + Keys} documentation. That includes important information for sandboxed applications on Apple platforms, including all apps obtained via the Apple App Store. - \sa Inter-Process Communication, QSharedMemory, QSemaphore + \sa {Inter-Process Communication}, QSharedMemory, QSemaphore */ /*! @@ -183,7 +183,7 @@ QSystemSemaphore::~QSystemSemaphore() This function is useful if the native key was shared from another process. See \l{Native IPC Keys} for more information. - \sa QSystemSemaphore(), nativeKey() + \sa QSystemSemaphore(), nativeIpcKey() */ void QSystemSemaphore::setNativeKey(const QNativeIpcKey &key, int initialValue, AccessMode mode) { diff --git a/src/corelib/ipc/qtipccommon.cpp b/src/corelib/ipc/qtipccommon.cpp index 050c79c6290..df525682d90 100644 --- a/src/corelib/ipc/qtipccommon.cpp +++ b/src/corelib/ipc/qtipccommon.cpp @@ -236,7 +236,7 @@ QString QtIpcCommon::platformSafeKey(const QString &key, QtIpcCommon::IpcType ip For details on the key types, platform-specific limitations, and interoperability with older or non-Qt applications, see the \l{Native IPC - Key} documentation. That includes important information for sandboxed + Keys} documentation. That includes important information for sandboxed applications on Apple platforms, including all apps obtained via the Apple App Store. @@ -302,7 +302,7 @@ QString QtIpcCommon::platformSafeKey(const QString &key, QtIpcCommon::IpcType ip \enum QNativeIpcKey::Type This enum describes the backend type for the IPC object. For details on the - key types, see the \l{Native IPC Key} documentation. + key types, see the \l{Native IPC Keys} documentation. \value SystemV X/Open System Initiative (XSI) or System V (SVr4) API \value PosixRealtime IEEE 1003.1b (POSIX.1b) API