diff options
author | Topi Reinio <topi.reinio@qt.io> | 2019-11-07 12:34:15 +0100 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2019-11-08 11:52:03 +0100 |
commit | 9e7fbb542a537a63aa220388be176eb206a22b73 (patch) | |
tree | 6500990ffb6ef719387e3694c285279cb2d41f6a | |
parent | bc77060e9c03ccdf09e1ae7b8972af37ff67c71a (diff) | |
download | qtdoc-9e7fbb542a537a63aa220388be176eb206a22b73.tar.gz |
Doc: Fix documentation warnings
- Fix linking and replace mentions of deprecated add-ons in
'OpenGL and 3D' section of the graphics topic.
- Fix linking to (generated) license documentation pages in
licensechanges.qdoc. The links failed because now, the version
information for the component is part of the generated title.
Use a \target name instead, as it continues to work even when
the versions change.
- Remove linking for removed licenses, use \e instead.
- Add missing dependencies
Fixes: QTBUG-79820
Change-Id: Ie74ba5e7b5cff6d286ece6b362b4622e9cafabf3
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
-rw-r--r-- | doc/config/qtdoc.qdocconf | 2 | ||||
-rw-r--r-- | doc/src/graphics.qdoc | 22 | ||||
-rw-r--r-- | doc/src/highdpi.qdoc | 1 | ||||
-rw-r--r-- | doc/src/legal/licensechanges.qdoc | 160 | ||||
-rw-r--r-- | doc/src/platforms/supported-platforms.qdoc | 2 | ||||
-rw-r--r-- | doc/src/source-breaks.qdoc | 2 |
6 files changed, 99 insertions, 90 deletions
diff --git a/doc/config/qtdoc.qdocconf b/doc/config/qtdoc.qdocconf index 4d1434c8..f2edc47c 100644 --- a/doc/config/qtdoc.qdocconf +++ b/doc/config/qtdoc.qdocconf @@ -38,11 +38,13 @@ depends += \ qtpositioning \ qtprintsupport \ qtqml \ + qtqmlmodels \ qtqmltest \ qtquick \ qtquickcontrols \ qtquickdialogs \ qtquickextras \ + qtquicktimeline \ qtscript \ qtscripttools \ qtscxml \ diff --git a/doc/src/graphics.qdoc b/doc/src/graphics.qdoc index 9bf4955e..d4a5eac8 100644 --- a/doc/src/graphics.qdoc +++ b/doc/src/graphics.qdoc @@ -101,10 +101,11 @@ QPainter and related classes are part of the \l {Qt GUI} module. \section1 OpenGL and 3D -OpenGL is the most widely adopted graphics API for hardware accelerated and 3D graphics, implemented on all -desktop platforms and almost every mobile and embedded platform. The -Qt library contains a number of classes that help users integrate -OpenGL into their applications. +OpenGL is the most widely adopted graphics API for hardware accelerated and 3D +graphics, implemented on all desktop platforms and almost every mobile and +embedded platform. The Qt library contains a number of classes that help users +integrate graphics driven by OpenGL or other graphics API calls into their +applications, as well as add-on modules for displaying 3D content. \list @@ -115,14 +116,19 @@ OpenGL into their applications. \li \l {QOpenGLWidget}{QOpenGLWidget} is a widget that allows adding OpenGL scenes into QWidget-based user interfaces. - \li \l {Mixing Scene Graph and OpenGL}{OpenGL and Qt Quick 2.0} - - How to integrate OpenGL into a the Qt Quick 2.0 scene graph. + \li \l {Mixing Scene Graph and the native graphics API}{OpenGL and Qt Quick 2.0} + - How to integrate application-provided graphics commands + (OpenGL, Vulkan, Direct3D, etc.) into a Qt Quick scene graph. \li \l {http://www.khronos.org/opengl}{www.khronos.org/opengl} - The official OpenGL pages. - \li Qt Canvas 3D - An add-on module that provides a way to - make OpenGL-like 3D drawing calls from Qt Quick using JavaScript. + \li \l {Qt Quick 3D} - An add-on module that provides a high-level API for + creating 3D content or UIs based on Qt Quick. + + \li \l {Qt 3D} - An add-on module that provides functionality for near-realtime + simulation systems with support for 2D and 3D rendering, in both Qt C++ and + Qt Quick applications. \endlist diff --git a/doc/src/highdpi.qdoc b/doc/src/highdpi.qdoc index df7ec8de..2409ce7c 100644 --- a/doc/src/highdpi.qdoc +++ b/doc/src/highdpi.qdoc @@ -218,6 +218,7 @@ \list \li let the application run as \e{DPI Unaware} on Windows \li set the \c QT_AUTO_SCREEN_SCALE_FACTOR environment variable to \c 1. + \endlist However, these options may result in some scaling or painting artifacts. diff --git a/doc/src/legal/licensechanges.qdoc b/doc/src/legal/licensechanges.qdoc index d90d91c1..b04fd017 100644 --- a/doc/src/legal/licensechanges.qdoc +++ b/doc/src/legal/licensechanges.qdoc @@ -39,16 +39,16 @@ \section2 Qt Core Module \list - \li \l{Unicode Common Locale Data Repository (CLDR)} got updated to + \li \l{unicode-cldr}{Unicode Common Locale Data Repository (CLDR)} got updated to upstream version v36. - \li \l{Efficient Binary-Decimal and Decimal-Binary Conversion Routines for IEEE Doubles} + \li \l{doubleconversion}{Efficient Binary-Decimal and Decimal-Binary Conversion Routines for IEEE Doubles} got updated to upstream version 3.1.5. - \li The copy of the \l{The Public Suffix List} got updated on 2019-10-23. + \li The copy of the \l{psl}{The Public Suffix List} got updated on 2019-10-23. \endlist \section2 Qt SQL Module - \l{SQLite} got updated to upstream version 3.30.1. + \l{sqlite}{SQLite} got updated to upstream version 3.30.1. \section2 Qt Wayland Compositor @@ -73,44 +73,44 @@ \section2 Qt SQL Module - \l{SQLite} got updated to upstream version 3.29.0. + \l{sqlite}{SQLite} got updated to upstream version 3.29.0. \section1 Qt 5.13.1 \section2 Qt Core Module - \l{Unicode Common Locale Data Repository (CLDR)} got updated to + \l{unicode-cldr}{Unicode Common Locale Data Repository (CLDR)} got updated to upstream version v35.1 \section2 Qt Image Formats - \l{WebP (libwebp)} got updated to upstream version 1.0.3. + \l{libwebp}{WebP (libwebp)} got updated to upstream version 1.0.3. \section1 Qt 5.13.0 \section2 Qt Core Module \list - \li The copy of the \l{The Public Suffix List} got updated on 2019-02-20. + \li The copy of the \l{psl}{The Public Suffix List} got updated on 2019-02-20. The upstream license is now MPL 2.0. - \li \l{PCRE2} got updated to upstream version 10.33. - \li \l{PCRE2 - Stack-less Just-In-Time Compiler} got updated to upstream version 10.33. + \li \l{pcre2}{PCRE2} got updated to upstream version 10.33. + \li \l{pcre2-sljit}{PCRE2 - Stack-less Just-In-Time Compiler} got updated to upstream version 10.33. \endlist \section2 Qt SQL Module - \l{SQLite} got updated to upstream version 3.28.0. + \l{sqlite}{SQLite} got updated to upstream version 3.28.0. \section2 Qt GUI Module \list - \li \l{LibJPEG-turbo} got updated to upstream version 2.0.2. - \li \l{LibPNG} got updated to upstream version 1.6.37. + \li \l{libjpeg}{LibJPEG-turbo} got updated to upstream version 2.0.2. + \li \l{libpng}{LibPNG} got updated to upstream version 1.6.37. \endlist \section2 Qt DBUS Module - The \l{libdus-1 headers} got updated to upstream version 1.12.12. + The \l{libdbus-1-headers}{libdus-1 headers} got updated to upstream version 1.12.12. \section2 Qt Wayland @@ -129,63 +129,63 @@ \section2 Qt SQL Module - \l{SQLite} got updated to upstream version 3.29.0. + \l{sqlite}{SQLite} got updated to upstream version 3.29.0. \section1 Qt 5.12.5 \section2 Qt GUI Module - Use of \l{Adobe Glyph List For New Fonts} under the \e{BSD-3-Clause} + Use of \l{aglfn}{Adobe Glyph List For New Fonts} under the \e{BSD-3-Clause} license is now documented. \section2 Qt Image Formats - \l{WebP (libwebp)} got updated to upstream version 1.0.3. + \l{libwebp}{WebP (libwebp)} got updated to upstream version 1.0.3. \section1 Qt 5.12.4 \section2 Qt GUI Module - \l{LibPNG} got updated to upstream version 1.6.37. + \l{libpng}{LibPNG} got updated to upstream version 1.6.37. \section2 Qt Core Module \list - \li \l{PCRE2} got updated to upstream version 10.33 - \li \l{PCRE2 - Stack-less Just-In-Time Compiler} got updated to + \li \l{pcre2}{PCRE2} got updated to upstream version 10.33 + \li \l{pcre2-sljit}{PCRE2 - Stack-less Just-In-Time Compiler} got updated to upstream version 10.33 - \li \l{Unicode Common Locale Data Repository (CLDR)} got updated to + \li \l{unicode-cldr}{Unicode Common Locale Data Repository (CLDR)} got updated to upstream version v35.1 \endlist \section2 Qt SQL Module - \l{SQLite} got updated to upstream version 3.28.0. + \l{sqlite}{SQLite} got updated to upstream version 3.28.0. \section1 Qt 5.12.3 \section2 Qt GUI Module - The license of \l{Wintab API} was now classified as 'Custom' instead of + The license of \l{wintab}{Wintab API} was now classified as 'Custom' instead of 'Public Domain'. \section2 Qt SQL Module - \l{SQLite} got updated to upstream version 3.27.1. + \l{sqlite}{SQLite} got updated to upstream version 3.27.1. \section1 Qt 5.12.2 \section2 Qt GUI Module \list - \li \l{Freetype 2} got updated to upstream version 2.9.1. - \li \l{LibPNG} got updated to upstream version 1.6.36. libpng License 2 + \li \l{freetype}{Freetype 2} got updated to upstream version 2.9.1. + \li \l{libpng}{LibPNG} got updated to upstream version 1.6.36. libpng License 2 added at same time. \endlist \section2 Qt Image Formats - \l{WebP (libwebp)} got updated to upstream version 1.0.2. + \l{libwebp}{WebP (libwebp)} got updated to upstream version 1.0.2. \section1 Qt 5.12.1 @@ -193,74 +193,74 @@ \list \li The version information for \l{FreeBSD} got updated. - \li The version information for \l{Secure Hash Algorithm SHA-3 - Keccak} got updated. - \li \l{UCD} got updated to upstream version 20. + \li The version information for \l{sha3_keccak}{Secure Hash Algorithm SHA-3 - Keccak} got updated. + \li \l{unicode-character-database}{UCD} got updated to upstream version 20. \endlist \section2 Qt GUI Module - \l{xkbcommon} was removed from 3rd party sources and we are not bundling that library any more. + \e{xkbcommon} was removed from 3rd party sources and we are not bundling that library any more. \section2 Qt Image Formats \list - \l{WebP (libwebp)} got updated to upstream version 1.0.1. + \l{libwebp}{WebP (libwebp)} got updated to upstream version 1.0.1. \l{libtiff} got updated to upstream version 4.0.10. \endlist \section2 Qt SQL Module - \l{SQLite} got updated to upstream version 3.26.0. + \l{sqlite}{SQLite} got updated to upstream version 3.26.0. \section2 Qt Virtual Keyboard Module - The version information for \l{Lipi Toolkit} got updated. + The version information for \l{lipitk}{Lipi Toolkit} got updated. \section2 Qt Wayland Compositor Module - The usage of \l{Wayland EGLStream Controller Protocol} under MIT license is now documented. + The usage of \l{wayland-eglstream-controller}{Wayland EGLStream Controller Protocol} under MIT license is now documented. \section1 Qt 5.12.0 \section2 Qt 3D Module - Use of \l{Miramar Skybox Textures} is now documented. + Use of \l{miramar-sky}{Miramar Skybox Textures} is now documented. \section2 Qt Core Module \list - \li \l{Efficient Binary-Decimal and Decimal-Binary Conversion Routines for IEEE Doubles} + \li \l{doubleconversion}{Efficient Binary-Decimal and Decimal-Binary Conversion Routines for IEEE Doubles} got updated to upstream version 3.1.1. - \li \l{PCRE2} got updated to upstream version 10.32. - \li Use of \l{PCRE2 - Stack-less Just-In-Time Compiler} under the + \li \l{pcre2}{PCRE2} got updated to upstream version 10.32. + \li Use of \l{pcre2-sljit}{PCRE2 - Stack-less Just-In-Time Compiler} under the \e{BSD 2-clause "Simplified"} license is now documented. - \li \l{Secure Hash Algorithm SHA-3 - brg_endian} got updated to version + \li \l{sha3_endian}{Secure Hash Algorithm SHA-3 - brg_endian} got updated to version https://github.com/BrianGladman/sha/ commit 4b9e13ead2c5b5e41ca27c65de4dd69ae0bac228. License got updated to \e{BSD 2-clause "Simplified"} license. - \li Use of \l{TinyCBOR} under the \e{MIT} license is now documented. - \li \l{Unicode Common Locale Data Repository (CLDR)} got updated to + \li Use of \l{tinycbor}{TinyCBOR} under the \e{MIT} license is now documented. + \li \l{unicode-cldr}{Unicode Common Locale Data Repository (CLDR)} got updated to upstream version v34. \endlist \section2 Qt GUI Module \list - \li The version information for \l{Freetype 2} got updated. - \li The Qt usage documentation for \l{HarfBuzz} got updated. - \li The Qt usage documentation for \l{HarfBuzz-NG} got updated. - \li The version information for \l{IAccessible2 IDL Specification} got updated. - \li \l{LibJPEG-turbo} got updated to upstream version 2.0.0. - \li \l{LibPNG} got updated to upstream version 1.6.35. - \li Use of \l{Bitstream Vera Font} under the \e{Bitstream Vera Font} + \li The version information for \l{freetype}{Freetype 2} got updated. + \li The Qt usage documentation for \l{harfbuzz}{HarfBuzz} got updated. + \li The Qt usage documentation for \l{harfbuzz-ng}{HarfBuzz-NG} got updated. + \li The version information for \l{iaccessible2}{IAccessible2 IDL Specification} got updated. + \li \l{libjpeg}{LibJPEG-turbo} got updated to upstream version 2.0.0. + \li \l{libpng}{LibPNG} got updated to upstream version 1.6.35. + \li Use of \l{vera_font}{Bitstream Vera Font} under the \e{vera_font}{Bitstream Vera Font} license is now documented. - \li \l{DejaVu Fonts} got updated to upstream version 2.37 and their use + \li \l{dejayvu}{DejaVu Fonts} got updated to upstream version 2.37 and their use under the \e{Bitstream DejaVu Font} license is now documented. - \li Use of \l{WebGradients} under the \e{MIT} license is now documented. + \li Use of \l{webgradients}{WebGradients} under the \e{MIT} license is now documented. \endlist \section2 Qt DBUS Module - \l{libdus-1 headers} got updated to upstream version 1.12. + \l{libdbus-1-headers}{libdus-1 headers} got updated to upstream version 1.12. \section2 Qt Image Formats @@ -272,50 +272,50 @@ \section2 Qt Location Module \list - \li Use of \l{Tango Weather Icon Pack by Darkobra} is now documented. - \li Use of \l{Tango Icons} is now documented. + \li Use of \l{weatherinfo-tango-weather-pack}{Tango Weather Icon Pack by Darkobra} is now documented. + \li Use of \l{weatherinfo-tango-icons}{Tango Icons} is now documented. \endlist \section2 Qt Test Module - \l{Valgrind} got updated to upstream version 3.14.0. + \l{valgrind}{Valgrind} got updated to upstream version 3.14.0. \section2 Qt Wayland Compositor Module \list - \li Use of \l{Wayland xdg-decoration Protocol} under the \e{MIT} license + \li Use of \l{wayland-xdg-decoration-protocol}{Wayland xdg-decoration Protocol} under the \e{MIT} license is now documented. - \li Use of \l{Wayland XDG Output Protocol} under the \e{MIT} license is + \li Use of \l{wayland-xdg-output-protocol}{Wayland XDG Output Protocol} under the \e{MIT} license is now documented. \endlist \section2 Qt WebEngine Module - \l Chromium and third-party components bundled with it were updated to + \e Chromium and third-party components bundled with it were updated to version 69.0.3497. \section1 Qt 5.11.2 \section2 Qt Core Module - \l{PCRE2} got updated to upstream version 10.31. + \l{pcre2}{PCRE2} got updated to upstream version 10.31. \section2 Qt GUI Module \list - \li The copyright information for \l{HarfBuzz} got updated. + \li The copyright information for \l{harfbuzz}{HarfBuzz} got updated. \li The copyright information for - \l{Anti-aliasing rasterizer from FreeType 2} got updated. + \l{grayraster}{Anti-aliasing rasterizer from FreeType 2} got updated. \endlist \section2 Qt Location Module The copyright information and description of - \l{Clipper Polygon Clipping Library} got updated. + \l{clipper}{Clipper Polygon Clipping Library} got updated. \section2 Qt SQL Module - \l{SQLite} got updated to upstream version 3.24.0. + \l{sqlite}{SQLite} got updated to upstream version 3.24.0. \section2 Qt WebEngine Module @@ -325,7 +325,7 @@ \li The \l{WebEngine StyleSheet Browser Example}, \l{WebEngine Widgets Simple Browser Example}, \l{WebEngine Quick Nano Browser}, and \l{WebEngine Cookie Browser Example} use images from the Tango Icon Library. This is now documented. - \li \l{Marked (WebEngine RecipeBrowser example)} got updated to upstream + \li \l{recipebrowser-marked}{Marked (WebEngine RecipeBrowser example)} got updated to upstream version 0.4.0. \endlist @@ -333,26 +333,26 @@ \section2 Qt 3D Module - The use of the \e{Jet Propulsion Laboratory Photojournal} in + The use of the \e{nasa-jpl}{Jet Propulsion Laboratory Photojournal} in the module is actually limited to the planets-qml example. The attribution has therefore been removed from the module's documentation. \section2 Qt Documentation - Use of the \l{Titillium Web Font} in the Coffee demo is now documented. + Use of the \l{coffeeexample-titillium}{Titillium Web Font} in the Coffee demo is now documented. \section2 Qt Image Formats - \l{WebP (libwebp)} got updated to version 1.0.0. + \l{libwebp}{WebP (libwebp)} got updated to version 1.0.0. \section1 Qt 5.11.0 \section2 Qt 3D Module \list - \li The \l{Open Asset Import Library} got updated to upstream version + \li The \l{assimp}{Open Asset Import Library} got updated to upstream version 4.1.0. - \li Examples use some assets from \l{Substance Share} that are available + \li Examples use some assets from \l{substance_share}{Substance Share} that are available under the \e {Creative Commons Attribution 4.0} license. This is now documented. \endlist @@ -363,16 +363,16 @@ \li \e{Parts of QTemporaryFile} got removed from documentation. The corresponding code got removed already in Qt 5.10.0. - \li The copy of the \l{The Public Suffix List} got updated on + \li The copy of the \l{psl}{The Public Suffix List} got updated on 2018-01-04. \li The concluded license for the - \l{Unicode Common Locale Data Repository (CLDR)} changed to + \l{unicode-cldr}{Unicode Common Locale Data Repository (CLDR)} changed to \e{Unicode License Agreement - Data Files and Software (2016)}. In Qt 5.10 documentation, the component was labelled as \e{Unicode CLDR (Unicode Common Locale Data Repository)}. - \li The use of the \l{Unicode Character Database (UCD)} under the + \li The use of the \l{unicode-character-database}{Unicode Character Database (UCD)} under the \e{Unicode License Agreement - Data Files and Software (2016)}. is now documented. \endlist @@ -386,36 +386,36 @@ \section2 Qt GUI Module \list - \li \l{HarfBuzz-NG} got updated to upstream version 1.7.4. - \li \l{LibJPEG-turbo} got updated to upstream version 1.5.3. + \li \l{harfbuzz-ng}{HarfBuzz-NG} got updated to upstream version 1.7.4. + \li \l{libjpeg}{LibJPEG-turbo} got updated to upstream version 1.5.3. \endlist \section2 Qt Image Formats \list - \li \l{TIFF Software Distribution (libtiff)} got updated to upstream + \li \l{libtiff}{TIFF Software Distribution (libtiff)} got updated to upstream version 4.0.9. - \li \l{WebP (libwebp)} got updated to upstream version 0.6.1. + \li \l{libwebp}{WebP (libwebp)} got updated to upstream version 0.6.1. \endlist \section2 Qt Quick Controls 2 Module - Use of \l{Shadow values from Angular Material} under \e{MIT License} + Use of \l{shadow_angular_material}{Shadow values from Angular Material} under \e{MIT License} in the Material Style is now documented. \section2 Qt SQL Module - \l{SQLite} got updated to upstream version 3.23.1. + \l{sqlite}{SQLite} got updated to upstream version 3.23.1. \section2 Qt Test Module - The concluded license of \l{Linux Performance Events} changed to + The concluded license of \l{linuxperf}{Linux Performance Events} changed to \e{GNU General Public License v2.0 only with Linux Syscall Note}. \section2 Qt WebEngine Module \list - \li \l{(Components of) Bazel} got added under the + \li \e{(Components of) Bazel} got added under the \e {Apache License 2.0}. \li \l{Breakpad, An open-source multi-platform crash reporting system} got added under a \e{New BSD, Apple PSL 2.0 and Apache 2.0} license. @@ -440,7 +440,7 @@ \section2 Qt XML Patterns Module - Use of \l{XML Schema} + Use of \l{xml-xsd}{XML Schema} under \e{W3C Software Notice and Document License (2015-05-13)} is now documented. */ diff --git a/doc/src/platforms/supported-platforms.qdoc b/doc/src/platforms/supported-platforms.qdoc index b2e6cffd..1f6b9172 100644 --- a/doc/src/platforms/supported-platforms.qdoc +++ b/doc/src/platforms/supported-platforms.qdoc @@ -110,7 +110,7 @@ \list \li \l{Deploying Qt Applications} \list - \li \l{Platform and Compiler Notes - Android#Deployment}{Android} + \li \l{Qt Creator: Deploying Applications to Android Devices}{Android} \li \l{Qt for iOS}{iOS} \li \l{Qt for Linux/X11 - Deployment}{Linux/X11} \li \l{Qt for macOS - Deployment}{\macos} diff --git a/doc/src/source-breaks.qdoc b/doc/src/source-breaks.qdoc index 5f459550..95cea3d2 100644 --- a/doc/src/source-breaks.qdoc +++ b/doc/src/source-breaks.qdoc @@ -503,7 +503,7 @@ recommendations for handling those changes. \section2 Changes to QTouchEvent \list - \li \l{QTouchEvent::DeviceType} and \l{QTouchEvent::deviceType()} are deprecated + \li \c{QTouchEvent::DeviceType} and \c{QTouchEvent::deviceType()} are deprecated as \l{QTouchDevice} provides a better way to identify and access the device from which the events originate. \li The constructor now takes a \l{QTouchDevice} pointer instead of \c{DeviceType} value. |