summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobert Griebl <robert.griebl@qt.io>2023-07-14 02:02:20 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2023-07-14 11:47:15 +0000
commit984757f2706ce7453ea4371dd1f4774f569ed4a9 (patch)
tree51b0595b3a3f6314b53b0f3f8e4b6ffab93e03d4
parent1105a1a0c40fe05c522929ef05346744cefe81a7 (diff)
Documentation: fix link targets inside of tables
A \target directly after a \row is generated as a <span> within a <tr>. This is invalid HTML, so these link targets are relocated to the start of the table by both Chrome and Firefox. Change-Id: I2720ca7e9c2e27c22bd0376c8e0ce6835750e2b5 Reviewed-by: Bernd Weimer <bernd.weimer@qt.io> (cherry picked from commit ae9507f0c7cd0c0ff4276c8cb411a7ed4ab9ebf1) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--doc/configuration.qdoc18
-rw-r--r--doc/container.qdoc2
-rw-r--r--doc/installation.qdoc2
-rw-r--r--doc/manifest-old.qdoc4
-rw-r--r--doc/manifest.qdoc3
-rw-r--r--src/window-lib/windowmanager.cpp4
6 files changed, 18 insertions, 15 deletions
diff --git a/doc/configuration.qdoc b/doc/configuration.qdoc
index bb982ff9..fdcefde0 100644
--- a/doc/configuration.qdoc
+++ b/doc/configuration.qdoc
@@ -139,10 +139,10 @@ ui:
configuration files, but before more specific, direct options such as \c --fullscreen
(which can be rewritten as \c{ -o 'ui: { fullscreen: no }'}).
\row
- \target instance-id
\li \b --instance-id
\br [\c instanceId]
\li string
+ \target instance-id
\li Assign an unique name to this application manager instance. Only useful if you are
running multiple instances at the same time and you need to address them via the
\l{Controller}{appman-controller tool}.
@@ -261,9 +261,9 @@ ui:
(see \l Containers).
\endlist
\row
- \target system properties
\li [\c systemProperties]
\li object
+ \target system properties
\li Exports user-defined properties (key/value pairs) to the System UI and applications.
This field can only have the following children, that control access to the actual
properties: \c private, \c protected, and \c public; other children are ignored.
@@ -298,22 +298,23 @@ ui:
\li bool
\li Loads QML dummy data into the System UI, similar to \c qmlscene and \c qml.
\row
- \target no-security
\li \b --no-security
\br [\c flags/noSecurity]
\li bool
+ \target no-security
\li Disables all security related checks. Use this option in a development setup only;
never in production. (default: false)
\row
- \target development-mode
\li \b --development-mode
\br [\c flags/developmentMode]
\li bool
+ \target development-mode
\li Allows the installation of packages that only come with a valid developer signature.
(default: false)
\row
\li [\c flags/allowUnsignedPackages]
\li bool
+ \target allow-unsigned-packages
\li Allows the installation of packages that have no signature at all. Only use this in
production, if you are verifying packages by other means, while also limiting the
access to the installer API. (default: false)
@@ -472,8 +473,8 @@ ui:
not even compile it in the first place, in the \l{config disable installer}{qmake step}.
\row
\li [\c installer/caCertificates]
- \target ca certificates
\li list<string>
+ \target ca certificates
\li A list of file paths to CA-certifcates that are used to verify packages. For more
details, see the \l {Public Key Infrastructure} {Installer documentation}.
\row
@@ -488,14 +489,14 @@ ui:
\l{OpenGL Specification}.
\row
\li [\c ui/iconThemeName]
- \target iconThemeName
\li string
+ \target iconThemeName
\li Specifies which icon theme to use. See \l{iconThemeSearchPaths}{ui/iconThemeSearchPaths}
for details on how to add a path to a custom theme.
\row
\li [\c ui/iconThemeSearchPaths]
- \target iconThemeSearchPaths
\li list<string>
+ \target iconThemeSearchPaths
\li Adds additional icon theme search paths to the System UI and all apps. This option can
be used to add a custom icon theme to the search path and load it by specifying
\l{iconThemeName} {ui/iconThemeName}.
@@ -505,8 +506,8 @@ ui:
\li Disables the intent sub-system at runtime completely.
\row
\li [\c intents/timeouts]
- \target intentConfiguration
\li object
+ \target intentConfiguration
\li Lets you specify the processing timeouts used in the intent
sub-system. For more details, see \l{Intent Timeout Specification}.
@@ -657,6 +658,7 @@ an additional column specifying which runtime a configuration option applies to:
\li \c quitTime
\li qml
\li int
+ \target qml quitTime
\li Defines the grace period in milliseconds, that an application is given for shutting
down. This is the time limit between receiving the
\l{ApplicationInterface::quit()}{quit()} signal and responding with
diff --git a/doc/container.qdoc b/doc/container.qdoc
index dfed3522..74927588 100644
--- a/doc/container.qdoc
+++ b/doc/container.qdoc
@@ -183,9 +183,9 @@ The \c process container accepts the following configuration settings:
\li Type
\li Description
\row
- \target control group mapping
\li \c controlGroups
\li object
+ \target control group mapping
\li A two-stage mapping object to allow for more readable code when dealing with \c cgroups
from the System UI via Container::controlGroup. The top-level \c keys are readable group names
that are used to interface with Container::controlGroup. The values themselves are \c maps
diff --git a/doc/installation.qdoc b/doc/installation.qdoc
index b0d3ca19..7a8b8e7b 100644
--- a/doc/installation.qdoc
+++ b/doc/installation.qdoc
@@ -130,7 +130,7 @@ modules:
\br The corresponding cmake input is \c{-DINPUT_force_mode=multi}.
\row
\li \c{installer}
- \target config disable installer
+ \target config disable installer
\li Set to \c no to disable the installer part.
\row
\li \c{external-dbus-interfaces}
diff --git a/doc/manifest-old.qdoc b/doc/manifest-old.qdoc
index d65a0235..bcd2e00c 100644
--- a/doc/manifest-old.qdoc
+++ b/doc/manifest-old.qdoc
@@ -105,8 +105,8 @@ The fields within the \c info.yaml manifest data (second YAML document) are as f
\c info.yaml and can be in any image format that Qt supports.
\row
\li \c name
- \target application-name-map
\li object
+ \target application-name-map
\li \e Required. An object containing language (\c string) to display name (\c string)
mappings. The language identifiers need to adhere to the standard POSIX locale definition.
For more information, see \l{QLocale}. At least one mapping needs to be present. However,
@@ -161,8 +161,8 @@ The fields within the \c info.yaml manifest data (second YAML document) are as f
\c true. Otherwise the default is \c false.
\row
\li \c mimeTypes
- \target mimeTypes field
\li array<string>
+ \target mimeTypes field
\li An optional array of MIME types the application can handle. The application manager
supports the classic file name or content to MIME type matching, as well as URL scheme
matching. For more information, see \l{ApplicationManager::openUrl}.
diff --git a/doc/manifest.qdoc b/doc/manifest.qdoc
index 0cfa7c4e..6d60c0f2 100644
--- a/doc/manifest.qdoc
+++ b/doc/manifest.qdoc
@@ -99,8 +99,8 @@ The fields within the \c info.yaml manifest data (second YAML document) are as f
\c info.yaml and can be in any image format that Qt supports.
\row
\li \c name
- \target package-name-map
\li object
+ \target package-name-map
\li An optional object containing language (\c string) to display name (\c string)
mappings. The language identifiers need to adhere to the standard POSIX locale definition.
For more information, see \l{QLocale}. It is good practice to supply at least the English
@@ -179,6 +179,7 @@ The fields used for each item within the \c applications list are as follows:
\row
\li \c supportsApplicationInterface
\li bool
+ \target manifest supportsApplicationInterface
\li If set to \c true the application must implement the \l ApplicationInterface API.
In this case the application manager will wait until the application is connected to the
ApplicationInterface on the P2P D-Bus until it marks it as 'running'. For runtimes that
diff --git a/src/window-lib/windowmanager.cpp b/src/window-lib/windowmanager.cpp
index 907f314a..09df36a7 100644
--- a/src/window-lib/windowmanager.cpp
+++ b/src/window-lib/windowmanager.cpp
@@ -67,14 +67,14 @@
information about the application in the ApplicationManager model.
\row
\li \c window
- \target windowmanager-window-role
\li WindowObject
+ \target windowmanager-window-role
\li The WindowObject containing the client surface. To display it you have to put it in a
WindowItem
\row
\li \c contentState
- \target windowmanager-contentState-role
\li WindowObject::ContentState
+ \target windowmanager-contentState-role
\li The content state of the WindowObject. See WindowObject::contentState
\endtable