Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
package.h
Go to the documentation of this file.
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
10
struct
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
main
int main(int argc, char *argv[])
[2]
Definition
buffer.cpp:77
Scanner::InputFormat
InputFormat
Definition
scanner.h:17
Scanner::InputFormat::QtAttributions
@ QtAttributions
Scanner::InputFormat::ChromiumAttributions
@ ChromiumAttributions
LogLevel
LogLevel
Definition
logging.h:9
NormalLog
@ NormalLog
Definition
logging.h:11
SilentLog
@ SilentLog
Definition
logging.h:12
VerboseLog
@ VerboseLog
Definition
logging.h:10
tr
static QString tr(const char *key)
Definition
logging.h:15
JsonGenerator
Definition
jsongenerator.cpp:14
JsonGenerator::generate
void generate(QTextStream &out, const QList< Package > &packages, LogLevel logLevel)
Definition
jsongenerator.cpp:54
QDocGenerator
Definition
qdocgenerator.h:13
QDocGenerator::generate
void generate(QTextStream &out, const QList< Package > &packages, const QString &baseDirectory, LogLevel logLevel)
Definition
qdocgenerator.cpp:143
Scanner
Definition
scanner.h:15
PackageFilter
Definition
packagefilter.h:10
PackageFilter::InvalidFilter
@ InvalidFilter
Definition
packagefilter.h:16
Package
Definition
package.h:10
Package::homepage
QString homepage
Definition
package.h:23
Package::licenseId
QString licenseId
Definition
package.h:28
Package::name
QString name
Definition
package.h:15
Package::packageComment
QString packageComment
Definition
package.h:39
Package::qtUsage
QString qtUsage
Definition
package.h:17
Package::licenseFilesContents
QStringList licenseFilesContents
Definition
package.h:30
Package::downloadLocation
QString downloadLocation
Definition
package.h:25
Package::cpeList
QStringList cpeList
Definition
package.h:36
Package::purlList
QStringList purlList
Definition
package.h:37
Package::id
QString id
Definition
package.h:11
Package::qtParts
QStringList qtParts
Definition
package.h:19
Package::version
QString version
Definition
package.h:24
Package::qdocModule
QString qdocModule
Definition
package.h:16
Package::path
QString path
Definition
package.h:12
Package::securityCritical
bool securityCritical
Definition
package.h:18
Package::copyright
QString copyright
Definition
package.h:32
Package::description
QString description
Definition
package.h:22
Package::licenseFiles
QStringList licenseFiles
Definition
package.h:29
Package::copyrightFile
QString copyrightFile
Definition
package.h:33
Package::files
QStringList files
Definition
package.h:14
Package::copyrightFileContents
QString copyrightFileContents
Definition
package.h:34
Package::license
QString license
Definition
package.h:27
qttools
src
qtattributionsscanner
package.h
Generated on Sat Sep 21 2024 00:39:31 for Qt by
1.12.0