Skip to content

Commit

Permalink
Doc: Fix documentation warnings for Qt Core
Browse files Browse the repository at this point in the history
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 <[email protected]>
Reviewed-by: Nicholas Bennett <[email protected]>
  • Loading branch information
toreinio committed Feb 6, 2023
1 parent e8322a4 commit c4b3259
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/corelib/doc/src/ipc.qdoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions src/corelib/ipc/qsharedmemory.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

/*!
Expand Down Expand Up @@ -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()
*/

/*!
Expand All @@ -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)
{
Expand Down Expand Up @@ -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
{
Expand Down
6 changes: 3 additions & 3 deletions src/corelib/ipc/qsystemsemaphore.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

/*!
Expand Down Expand Up @@ -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)
{
Expand Down
4 changes: 2 additions & 2 deletions src/corelib/ipc/qtipccommon.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit c4b3259

Please sign in to comment.