From fc108e6f8f28dd28935df53a5a95a06717c5c33a Mon Sep 17 00:00:00 2001 From: Robert Griebl Date: Mon, 26 Feb 2024 10:43:54 +0100 Subject: doc: all QStringLists are documented as list for QML and YAML It doesn't make sense to use a different syntax for QML vs. YAML. Also fixed "categories" wrongly being documented as object. Change-Id: Iaa1ed6801908dd852ec1c5226605de67b0345ea8 Pick-to: 6.7 6.6 6.5 Fixes: QTBUG-122721 Reviewed-by: Bernd Weimer --- doc/configuration.qdoc | 22 +++++++++++----------- doc/manifest-old.qdoc | 14 +++++++------- doc/manifest.qdoc | 4 ++-- src/plugin-interfaces/containerinterface.cpp | 2 +- 4 files changed, 21 insertions(+), 21 deletions(-) diff --git a/doc/configuration.qdoc b/doc/configuration.qdoc index 9c396dde..6b454ec1 100644 --- a/doc/configuration.qdoc +++ b/doc/configuration.qdoc @@ -94,7 +94,7 @@ ui: \li Prints the build configuration of the application manager in YAML format and exits. \row \li \b --config-file or \b -c - \li array + \li list \li Loads configuration settings from a set of files. You can use more than one config file, for example, to split the configuration cleanly, into a device specific and a UI specific part. All the config files' content are merged in the order in which they @@ -233,11 +233,11 @@ ui: \row \li \b -I \br [\c ui/importPaths] - \li array + \li list \li Adds additional QML import paths to the System UI. \row \li [\c ui/pluginPaths] - \li array + \li list \li Adds additional Qt plugin paths to the System UI. \row \li [\c ui/style] @@ -245,13 +245,13 @@ ui: \li If set, the given style is used by QtQuickControls 2. \row \li [\c ui/resources] - \li array + \li list \li Takes a list of \l{The Qt Resource System}{Qt resource} files (.rcc) or libraries that have resources \l{Resource Collection Files}{compiled-in} and registers them within the System UI process. Resources can be accessed with the ":" or "qrc://" file path prefix. \row \li [\c plugins] - \li map> + \li map> \li A string-to-string-list map that defines plugins that the application manager should load. The value must be a single plugin or a list of plugin library file path names. Currently the only valid keys are \c startup and \c container: @@ -356,7 +356,7 @@ ui: \row \li \b --logging-rule \br [\c logging/rules] - \li array + \li list \li Adds standard Qt logging rules - see the QLoggingCategory documentation for the required format. Application manager specific logging categories are described in \l {Logging and Debugging}. @@ -403,7 +403,7 @@ ui: \li Enables QML Debugging/Profiling. For more information, see \l {Logging and Debugging}. \row \li [\c installationLocations] - \li array + \li list \li The definition of installation locations available on the system. This is deprecated, since only a single installation location is supported now, defined by \c --installationDir or \c{applications/installationDir}. @@ -622,17 +622,17 @@ an additional column specifying which runtime a configuration option applies to: \row \li \c importPaths \li qml - \li array + \li list \li Adds additional QML import paths for apps started via this runtime. \row \li \c pluginPaths \li qml - \li array + \li list \li Adds additional Qt plugin paths for apps started via this runtime. \row \li \c plugins \li qml - \li map> + \li map> \li A string-to-string-list map that defines plugins that the QML runtime should load. The value must be a single plugin or a list of plugin library file path names. Currently the only valid key is \c startup: @@ -643,7 +643,7 @@ an additional column specifying which runtime a configuration option applies to: \row \li \c resources \li qml - \li array + \li list \li Takes a list of \l{The Qt Resource System}{Qt resource} files (.rcc) or libraries that have resources \l{Resource Collection Files}{compiled-in} and registers them within each QML runtime. Consequently, all running QML applications will include these resources. diff --git a/doc/manifest-old.qdoc b/doc/manifest-old.qdoc index 88a04349..501122e6 100644 --- a/doc/manifest-old.qdoc +++ b/doc/manifest-old.qdoc @@ -117,7 +117,7 @@ The fields within the \c info.yaml manifest data (second YAML document) are as f \li \e Required. The main executable - interpreted by the \c runtime. \row \li \c categories - \li array + \li list \li The list of category names the application should be associated with. This is mainly for the automated app-store uploads as well as displaying the application within a fixed set of categories in the System UI. @@ -161,14 +161,14 @@ 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 - \li array + \li list \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}. \row \li \c capabilities - \li array + \li list \li An optional, platform specific list of special access rights for the application. Later, the middleware can query these capabilities and verify them, via the application manager. @@ -249,27 +249,27 @@ that specifies which runtime a configuration option applies to: \row \li \c importPaths \li qml, qml-in-process - \li array + \li list \li A list of paths to add to the QML-engine's import paths. Use of this parameter is equivalent to setting \c QML2_IMPORT_PATH for a program started from the command line. \row \li \c resources \li qml, qml-in-process - \li array + \li list \li Takes a list of \l{The Qt Resource System}{Qt resource} files (.rcc) or libraries that have resources \l{Resource Collection Files}{compiled-in} and registers them within the application process. Resources can be accessed with the ":" or "qrc://" file path prefix. \row \li \c pluginPaths \li qml, qml-in-process - \li array + \li list \li A list of paths to add to Qt's library paths, which are used to find plugins. Use of this parameter is equivalent to setting \c QT_PLUGIN_PATH for a program started from the command line. \row \li \c arguments \li native - \li array + \li list \li A list of command line parameters to use when starting the application's executable. \row \li \c environmentVariables diff --git a/doc/manifest.qdoc b/doc/manifest.qdoc index 31abdf86..c9c534d6 100644 --- a/doc/manifest.qdoc +++ b/doc/manifest.qdoc @@ -260,7 +260,7 @@ The fields used for each item within the \c applications list are as follows: field. \row \li \c categories - \li object + \li list \li The list of categories for this application. It will default to the \c categories field in the global package section, but it can be overwritten for each application by specifying this field. @@ -332,7 +332,7 @@ The fields used for each item within the \c intents list are as follows: package section, but it can be overwritten for each intent by specifying this field. \row \li \c categories - \li object + \li list \li The list of categories for this intent. It will default to the \c categories field in the global package section, but it can be overwritten for each intent by specifying this field. \endtable diff --git a/src/plugin-interfaces/containerinterface.cpp b/src/plugin-interfaces/containerinterface.cpp index ca9e1c20..6c77ff7f 100644 --- a/src/plugin-interfaces/containerinterface.cpp +++ b/src/plugin-interfaces/containerinterface.cpp @@ -231,7 +231,7 @@ bool ContainerManagerInterface::initialize(ContainerHelperFunctions *) { return \li Logging should be done via DLT, if this is set to \c true. \row \li \c logging/rules - \li array + \li list \li The Qt logging rules as set in the application manager's main config. \row \li \c systemProperties -- cgit v1.2.3