diff options
author | Robert Griebl <robert.griebl@qt.io> | 2023-05-23 14:12:56 +0200 |
---|---|---|
committer | Robert Griebl <robert.griebl@qt.io> | 2023-05-23 15:41:03 +0200 |
commit | c4f24b8435a52d2df7c00383688a10af721adfa4 (patch) | |
tree | ed104a3b14e1efb5a9edb6d21def8e1169bcf1d2 | |
parent | e43a946ddb881ef9984be077f620dcc8b3628495 (diff) |
A bunch of smaller documentation fixes
Change-Id: I8bede05ea5e7cd770301efdd5671c30c34bade9a
Fixes: QTBUG-113423
Fixes: QTBUG-113302
Fixes: QTBUG-113293
Task-number: QTBUG-113292
Fixes: QTBUG-113291
Pick-to: 6.5
Reviewed-by: Bernd Weimer <bernd.weimer@qt.io>
-rw-r--r-- | doc/installation.qdoc | 3 | ||||
-rw-r--r-- | src/manager-lib/applicationmanager.cpp | 6 | ||||
-rw-r--r-- | src/manager-lib/intentaminterface.cpp | 34 | ||||
-rw-r--r-- | src/manager-lib/notificationmanager.cpp | 4 |
4 files changed, 27 insertions, 20 deletions
diff --git a/doc/installation.qdoc b/doc/installation.qdoc index a2ef87c0..b0d3ca19 100644 --- a/doc/installation.qdoc +++ b/doc/installation.qdoc @@ -56,8 +56,7 @@ apt-get install libyaml-dev libarchive-dev libssl-dev that lack one of the prerequisites, the bundled versions of these libraries from the \c src/3rdparty folder are automatically used instead. Make sure you are aware of the licensing implications, since these bundled 3rdparty libs will be linked in as static libraries. - -\warning This option is not meant for production, but for development and testing environments only. +This option is not meant for production, but for development and testing environments only. \section1 Multi-process vs. Single-process diff --git a/src/manager-lib/applicationmanager.cpp b/src/manager-lib/applicationmanager.cpp index cd75d81b..66bc8ef6 100644 --- a/src/manager-lib/applicationmanager.cpp +++ b/src/manager-lib/applicationmanager.cpp @@ -250,7 +250,7 @@ \qmlsignal ApplicationManager::applicationAdded(string id) This signal is emitted after a new application, identified by \a id, has been installed via the - ApplicationInstaller. The model has already been update before this signal is sent out. + PackageManager. The model has already been update before this signal is sent out. \note In addition to the normal "low-level" QAbstractListModel signals, the application manager will also emit these "high-level" signals for System-UIs that cannot work directly on the @@ -261,7 +261,7 @@ \qmlsignal ApplicationManager::applicationAboutToBeRemoved(string id) This signal is emitted before an existing application, identified by \a id, is removed via the - ApplicationInstaller. + PackageManager. \note In addition to the normal "low-level" QAbstractListModel signals, the application manager will also emit these "high-level" signals for System-UIs that cannot work directly on the @@ -1071,7 +1071,7 @@ bool ApplicationManager::openUrl(const QString &urlStr) \note This signal is only emitted, if there is a receiver connected at all - see openUrl for the fallback behavior. - The receiver of this signal can inspect the requested \a url an its \a mimeType. It can then + The receiver of this signal can inspect the requested \a url and its \a mimeType. It can then either call acknowledgeOpenUrlRequest to choose from one of the supplied \a possibleAppIds or rejectOpenUrlRequest to ignore the request. In both cases the unique \a requestId needs to be sent to identify the request. diff --git a/src/manager-lib/intentaminterface.cpp b/src/manager-lib/intentaminterface.cpp index 267a6be9..14e96ecd 100644 --- a/src/manager-lib/intentaminterface.cpp +++ b/src/manager-lib/intentaminterface.cpp @@ -572,44 +572,52 @@ QT_BEGIN_NAMESPACE_AM /*! \qmlproperty url IntentServerHandler::icon - The intent's icon - see the \l{manifest-intent}{manifest documentation} for more - details. + The intent's icon. + This corresponds to the \c icon field in the \l{manifest-intent}{manifest documentation}. \note Any changes to this property after component completion will have no effect. */ /*! \qmlproperty object IntentServerHandler::names - The intent's name - see the \l{manifest-intent}{manifest documentation} for more - details. + An object with all the language code to localized name mappings for this intent. + This corresponds to the \c name field in the \l{manifest-intent}{manifest documentation}. + + \note Any changes to this property after component completion will have no effect. +*/ +/*! \qmlproperty object IntentServerHandler::descriptions + + An object with all the language code to localized description mappings for this intent. + This corresponds to the \c description field in the \l{manifest-intent}{manifest documentation}. \note Any changes to this property after component completion will have no effect. */ /*! \qmlproperty list<string> IntentServerHandler::categories - The intent's categories - see the \l{manifest-intent}{manifest documentation} for more - details. + The intent's categories. + This corresponds to the \c categories field in the \l{manifest-intent}{manifest documentation}. \note Any changes to this property after component completion will have no effect. */ /*! \qmlproperty enum IntentServerHandler::visibility - The intent's visibility - see the \l{manifest-intent}{manifest documentation} for more - details. - Can be either \c IntentObject.Public or \c IntentObject.Private (the default). + The intent's visibility. Can be either \c IntentObject.Public or \c IntentObject.Private + (the default). + This corresponds to the \c visibility field in the \l{manifest-intent}{manifest documentation}. \note Any changes to this property after component completion will have no effect. */ /*! \qmlproperty list<string> IntentServerHandler::requiredCapabilities - The intent's required capabilities - see the \l{manifest-intent}{manifest documentation} for - more details. + The intent's required capabilities. + This corresponds to the \c requiredCapabilities field in the \l{manifest-intent} + {manifest documentation}. \note Any changes to this property after component completion will have no effect. */ /*! \qmlproperty object IntentServerHandler::parameterMatch - The intent's parameter requirements - see the \l{manifest-intent}{manifest documentation} for - more details. + The intent's parameter requirements. + This corresponds to the \c parameterMatch field in the \l{manifest-intent}{manifest documentation}. \note Any changes to this property after component completion will have no effect. */ diff --git a/src/manager-lib/notificationmanager.cpp b/src/manager-lib/notificationmanager.cpp index 6e3b41e2..ebdd410d 100644 --- a/src/manager-lib/notificationmanager.cpp +++ b/src/manager-lib/notificationmanager.cpp @@ -123,8 +123,8 @@ \endtable The actual backend implementation that is receiving the notifications from other process is - fully compliant to the D-Bus interface of the \l {freedesktop.org specification} for - notifications. + fully compliant to the D-Bus interface of the \l {org.freedesktop.Notifications} + {freedesktop.org specification} for notifications. For testing purposes, the \e notify-send tool from the \e libnotify package can be used to create notifications. |