1 | /**************************************************************************** |
2 | ** |
3 | ** Copyright (C) 2016 The Qt Company Ltd. |
4 | ** Contact: https://www.qt.io/licensing/ |
5 | ** |
6 | ** This file is part of the tools applications of the Qt Toolkit. |
7 | ** |
8 | ** $QT_BEGIN_LICENSE:GPL-EXCEPT$ |
9 | ** Commercial License Usage |
10 | ** Licensees holding valid commercial Qt licenses may use this file in |
11 | ** accordance with the commercial license agreement provided with the |
12 | ** Software or, alternatively, in accordance with the terms contained in |
13 | ** a written agreement between you and The Qt Company. For licensing terms |
14 | ** and conditions see https://www.qt.io/terms-conditions. For further |
15 | ** information use the contact form at https://www.qt.io/contact-us. |
16 | ** |
17 | ** GNU General Public License Usage |
18 | ** Alternatively, this file may be used under the terms of the GNU |
19 | ** General Public License version 3 as published by the Free Software |
20 | ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT |
21 | ** included in the packaging of this file. Please review the following |
22 | ** information to ensure the GNU General Public License requirements will |
23 | ** be met: https://www.gnu.org/licenses/gpl-3.0.html. |
24 | ** |
25 | ** $QT_END_LICENSE$ |
26 | ** |
27 | ****************************************************************************/ |
28 | |
29 | #ifndef PACKAGE_H |
30 | #define PACKAGE_H |
31 | |
32 | #include <QtCore/qstring.h> |
33 | #include <QtCore/qstringlist.h> |
34 | |
35 | struct Package { |
36 | QString id; // Usually a lowercase, no-spaces version of the name. Mandatory. |
37 | QString path; // Source directory. Optional. |
38 | // Default is the directory of the qt_attribution.json file. |
39 | QStringList files; // Files in path. Optional. |
40 | QString name; // Descriptive name of the package. Will be used as the title. Mandatory. |
41 | QString qdocModule; // QDoc module where the documentation should be included. Mandatory. |
42 | QString qtUsage; // How the package is used in Qt. Any way to disable? Mandatory. |
43 | QStringList qtParts; // Possible values are "examples", "tests", "tools", or "libs". |
44 | // "libs" is the default. |
45 | |
46 | QString description; // A short description of what the package is and is used for. Optional. |
47 | QString homepage; // Homepage of the upstream project. Optional. |
48 | QString version; // Version used from the upstream project. Optional. |
49 | QString downloadLocation; // Link to exact upstream version. Optional. |
50 | |
51 | QString license; // The license under which the package is distributed. Mandatory. |
52 | QString licenseId; // see https://spdx.org/licenses/. Optional. |
53 | QString licenseFile; // path to file containing the license text. Optional. |
54 | |
55 | QString copyright; // A list of copyright owners. Mandatory. |
56 | |
57 | QString ; // Further comments about the package. Optional. |
58 | }; |
59 | |
60 | #endif // PACKAGE_H |
61 | |