blob: 8164e5ff7c7d122e83092c9949ba49bffb3fb9d0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
// Copyright (C) 2021 The Qt Company Ltd.
// Copyright (C) 2019 Luxoft Sweden AB
// Copyright (C) 2018 Pelagicore AG
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page yaml.html
\ingroup qtappman
\title YAML Syntax
All YAML files used in the application manager are parsed using a YAML 1.1 compliant parser.
You can find the official specification here: \l{https://yaml.org/spec/1.1}.
\note Node anchors and aliases are not supported in the application manager.
To help with backward compatibility, all configuration files consist of at least two YAML
sub-documents, with the first one acting as a file header, for example:
\badcode
formatType: am-configuration
formatVersion: 1
---
...
\endcode
The header always has exactly two fields:
\list
\li \c formatType specifies the type of document(s) that follow the \c --- end-of-document marker.
\li \c formatVersion is an integer value starting at \c 1.
\endlist
See the corresponding type documentation for valid values for both fields.
*/
|
