1// Copyright (C) 2016 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
3
4#ifndef PACKAGE_H
5#define PACKAGE_H
6
7#include <QtCore/qstring.h>
8#include <QtCore/qstringlist.h>
9
10struct Package {
11 QString id; // Usually a lowercase, no-spaces version of the name. Mandatory.
12 QString path; // Source directory. Optional.
13 // Default is the directory of the qt_attribution.json file.
14 QStringList files; // Files in path. Optional.
15 QString name; // Descriptive name of the package. Will be used as the title. Mandatory.
16 QString qdocModule; // QDoc module where the documentation should be included. Mandatory.
17 QString qtUsage; // How the package is used in Qt. Any way to disable? Mandatory.
18 bool securityCritical = false; // Whether code is security critical in the Qt module. Optional.
19 QStringList qtParts; // Possible values are "examples", "tests", "tools", or "libs".
20 // "libs" is the default.
21
22 QString description; // A short description of what the package is and is used for. Optional.
23 QString homepage; // Homepage of the upstream project. Optional.
24 QString version; // Version used from the upstream project. Optional.
25 QString downloadLocation; // Link to exact upstream version. Optional.
26
27 QString license; // The license under which the package is distributed. Mandatory.
28 QString licenseId; // see https://spdx.org/licenses/. Optional.
29 QStringList licenseFiles; // path to files containing the license text. Optional.
30 QStringList licenseFilesContents;
31
32 QString copyright; // Text with copyright owner. Optional.
33 QString copyrightFile; // Path to file containing copyright owners. Optional.
34 QString copyrightFileContents;
35
36 QStringList cpeList; // List of CPE values. Optional.
37 QStringList purlList; // List of PURL values. Optional.
38
39 QString packageComment; // Further comments about the package. Optional.
40};
41
42#endif // PACKAGE_H
43

source code of qttools/src/qtattributionsscanner/package.h