From 5bcc6ae6f5c29e06bf41cff536486fa728626a3c Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Mon, 8 May 2023 11:21:43 +0000 Subject: Doc: Fix linking to org.freedesktop.Notifications specification The \externalpage entry and hard-coded URLs were pointing to a location that no longer exists; Update it, move the \externalpage to doc/external-pages.qdoc, and fix associated linking. Fixes: QTBUG-113297 Change-Id: I19d6847d645e445498ba7b80bc5c44856d76b57c Reviewed-by: Venugopal Shivashankar (cherry picked from commit b94f3dea6e6dd2ce7d56536d428ed6b54de06277) Reviewed-by: Qt Cherry-pick Bot --- doc/configuration.qdoc | 2 +- doc/external-pages.qdoc | 5 +++++ src/manager-lib/notificationmanager.cpp | 8 ++------ src/notification-lib/notification.cpp | 8 ++++---- 4 files changed, 12 insertions(+), 11 deletions(-) diff --git a/doc/configuration.qdoc b/doc/configuration.qdoc index 40099c88..bb982ff9 100644 --- a/doc/configuration.qdoc +++ b/doc/configuration.qdoc @@ -577,7 +577,7 @@ of these available interfaces are as follows: \row \li \c org.freedesktop.Notifications \li Not application manager specific - this interface adheres to the - \l {freedesktop.org specification} + \l {org.freedesktop.Notifications} {freedesktop.org specification} \endtable \section1 Runtime Configuration diff --git a/doc/external-pages.qdoc b/doc/external-pages.qdoc index b1a67d76..3336b7e1 100644 --- a/doc/external-pages.qdoc +++ b/doc/external-pages.qdoc @@ -5,3 +5,8 @@ \externalpage https://doc-snapshots.qt.io/qtdltlogging/ \title Qt DLT Logging */ + +/*! + \externalpage https://specifications.freedesktop.org/notification-spec/ + \title org.freedesktop.Notifications +*/ diff --git a/src/manager-lib/notificationmanager.cpp b/src/manager-lib/notificationmanager.cpp index 0efbba39..6e3b41e2 100644 --- a/src/manager-lib/notificationmanager.cpp +++ b/src/manager-lib/notificationmanager.cpp @@ -17,10 +17,6 @@ #include "dbus-utilities.h" #include "package.h" -/*! - \externalpage https://developer.gnome.org/notification-spec/ - \title freedesktop.org specification -*/ /*! \qmltype NotificationManager \inqmlmodule QtApplicationManager.SystemUI @@ -37,8 +33,8 @@ \target NotificationManager Roles The following roles are available in this model - also take a look at the - \l {freedesktop.org specification} for an in-depth explanation of these fields - and how clients should populate them: + \l {org.freedesktop.Notifications} {freedesktop.org specification} for an + in-depth explanation of these fields and how clients should populate them: \table \header diff --git a/src/notification-lib/notification.cpp b/src/notification-lib/notification.cpp index dfc28a0c..f04b623c 100644 --- a/src/notification-lib/notification.cpp +++ b/src/notification-lib/notification.cpp @@ -16,12 +16,12 @@ statically or by dynamically calling ApplicationInterface::createNotification. A System UI can also create Notification instances. For all other applications and services, the notification service of the application manager - is available via a freedesktop.org compliant \l{https://developer.gnome.org/notification-spec/} - {org.freedesktop.Notifications} D-Bus interface. + is available via a freedesktop.org compliant \l {org.freedesktop.Notifications} D-Bus + interface. \note Most of the property documentation text is copied straight from the - \l{https://developer.gnome.org/notification-spec/} {org.freedesktop.Notifications specification} - because it is not possible to directly link to the documentation of a specific property. + \l {org.freedesktop.Notifications} specification because it is not possible to directly + link to the documentation of a specific property. The server/System UI side of the notification infrastructure is implemented by NotificationManager. */ -- cgit v1.2.1