Qt wiki will be updated on October 12th 2023 starting at 11:30 AM (EEST) and the maintenance will last around 2-3 hours. During the maintenance the site will be unavailable.
Qt attribution.json
Jump to navigation
Jump to search
This is currently only a proposal.
qt_attribution.json files are used to document 3rd party code inside the Qt modules. It is a JSON based format that can be processed with the licensescanner tool.
Content
| Name | Description | Usage in qdoc |
|---|---|---|
| Name | Descriptive name of the package, without version number. Camel case. Mandatory. | Title |
| ShortName | Unique name for package, without spaces. All lower case. Mandatory. | Link target |
| QDocModule | The qch file the page should be part of. Mandatory. | |
| Description | A short description of what the package is and is used for. Optional. | |
| Modules | Either array of modules, or one single module where the code is used. Mandatory. | Link target |
| Usage | Free text on where the 3rd party code in Qt is used, and how to avoid it (configure options?). Mandatory. | |
| Homepage | Homepage of the upstream project. Optional. | |
| Version | Version used from the upstream project. Optional. | |
| VersionLink | Link to exact upstream version. Optional. | |
| License | The license under which the package is distributed, preferably with the names from SPDX 'Full Name'. Mandatory. | |
| LicenseId | SPDX ID. Optional. | |
| LicenseFile | Relative path to file containing the license text. Optional. | |
| Copyright | (Aggregated) list of copyright lines. Mandatory. |