summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@qt.io>2020-09-24 08:46:11 +0200
committerPaul Wicking <paul.wicking@qt.io>2020-10-29 09:40:31 +0100
commitc32b298024f2c1e1ee74c5ee3d73b626b46053aa (patch)
tree88f9a78796fae63be7a043c06a67cb17a144afdc
parenteba088a67dc36037484a9c13e8c221488b1d4db0 (diff)
downloadqtdoc-c32b298024f2c1e1ee74c5ee3d73b626b46053aa.tar.gz
Doc: Fix QDoc warnings in qtdoc
Task-number: QTBUG-86800 Change-Id: I00d2adb94ca024a54415fed4dbd7bb9df4ff10bb Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
-rw-r--r--doc/src/legal/licensechanges.qdoc555
-rw-r--r--doc/src/modules.qdoc2
-rw-r--r--doc/src/platforms/ios.qdoc8
-rw-r--r--doc/src/platforms/linux.qdoc30
-rw-r--r--doc/src/platforms/macos.qdoc1
-rw-r--r--doc/src/platforms/windows.qdoc8
-rw-r--r--doc/src/qmlapp/usecases/layouts.qdoc2
-rw-r--r--doc/src/qmlapp/usecases/styling.qdoc28
-rw-r--r--doc/src/qmlapp/usecases/userinput.qdoc15
-rw-r--r--doc/src/qmlapp/usecases/visual.qdoc2
-rw-r--r--doc/src/scripting.qdoc27
-rw-r--r--doc/src/topics.qdoc2
-rw-r--r--doc/src/web-content.qdoc11
-rw-r--r--examples/demos/maroon/doc/src/maroon.qdoc4
-rw-r--r--examples/demos/photosurface/doc/src/photosurface.qdoc2
15 files changed, 71 insertions, 626 deletions
diff --git a/doc/src/legal/licensechanges.qdoc b/doc/src/legal/licensechanges.qdoc
index 863c3d6d..8b62ba65 100644
--- a/doc/src/legal/licensechanges.qdoc
+++ b/doc/src/legal/licensechanges.qdoc
@@ -34,556 +34,7 @@
Changes in Qt and \l{Licenses Used in Qt}{Third Party Modules}
released with Qt that are relevant to licensing.
- \section1 Qt 5.15.1
-
- \section2 Qt Core Module
-
- \list
- \li \l{pcre2-sljit}{PCRE2 - Stack-less Just-In-Time Compiler} got updated to upstream version 10.35.
- \endlist
-
- \section2 Qt GUI Module
-
- \list
- \li Usage of \l{ANGLE: Khronos Headers} under MIT License is now documented.
- \li \l{libjpeg}{LibJPEG-turbo} got updated to upstream version 2.0.5.
- \endlist
-
- \section2 Qt SQL Module
-
- \l{sqlite}{SQLite} got updated to upstream version 3.32.3.
-
- \section1 Qt 5.15.0
-
- \section2 Qt 3D Module
-
- \list
- \li \l{Dear ImGui}{imgui} version v1.66b was added under MIT License.
- \endlist
-
- \section2 Qt Core Module
-
- \list
- \li \l{unicode-character-database}{UCD} got updated to upstream revision 26.
- \li The copy of the \l{psl}{The Public Suffix List} got updated on 2020-03-13.
- \endlist
-
- \section2 Qt DBUS Module
-
- \l{libdbus-1-headers}{libdus-1 headers} got updated to upstream version 1.13.12
-
- \section2 Qt GUI Module
-
- \list
- \li \l{libjpeg}{LibJPEG-turbo} got updated to upstream version 2.0.4.
- \li Usage of \l{XCB-XInput} under MIT License is now documented.
- \endlist
-
- \section2 Qt Image Formats
-
- \l{libwebp}{WebP (libwebp)} got updated to upstream version 1.1.0.
-
- \section2 Qt Location Module
-
- \list
- \li Use of \l{geosimplify-js polyline simplification library}{geosimplify.js} is now documented.
- \endlist
-
- \section2 Qt Quick3D Module
-
- \list
- \li Usage of \l{assimp}{Open Asset Import Library} got updated to upstream version 5.0.1.
- \endlist
-
- \section2 Qt Wayland Compositor
-
- \list
- \li \l{wayland-tablet-protocol}{Wayland Tablet Protocol} unstable v2, version 1 was added under the MIT License.
- \li \l{wayland-xdg-decoration-protocol}{Wayland xdg-decoration Protocol} was updated to unstable v1, version 2
- \li \l{wayland-xdg-shell-protocol}{Wayland XDG Shell Protocol} was updated to version 1.18
- \li \l{wayland-text-input-unstable}{Wayland Text Input Protocol} was updated to unstable version v2
- \li \l{wayland-linux-dmabuf-unstable-v1}{Wayland Linux Dmabuf Unstable V1 Protocol} was updated to unstable v1, version 3
- \li \l{wayland-eglstream-controller}{Wayland EGLStream Controller Protocol} was updated to version 1.1.1
- \endlist
-
- \section2 Qt WebEngine Module
- \list
- \li Updated Chromium to 80.0.3987
- \endlist
-
- \section1 Qt 5.14.2
-
- \section2 Qt GUI Module
-
- \l{md4c}{MD4C} got updated to upstream version 0.4.3.
-
- \section2 Qt SQL Module
-
- \l{sqlite}{SQLite} got updated to upstream version 3.31.1.
-
- \section1 Qt 5.14.1
-
- \section2 Qt Core Module
-
- \list
- \li \l{pcre2}{PCRE2} got updated to upstream version 10.34.
- \li \l{pcre2-sljit}{PCRE2 - Stack-less Just-In-Time Compiler} got updated to upstream version 10.34.
- \endlist
-
- \section2 Qt QML Module
-
- \e {LLVM: ADT} was removed from 3rd party sources and we are not bundling that library anymore.
-
- \section1 Qt 5.14.0
-
- \section2 Qt Core Module
-
- \list
- \li \l{unicode-cldr}{Unicode Common Locale Data Repository (CLDR)} got updated to
- upstream version v36.
- \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{psl}{The Public Suffix List} got updated on 2019-10-23.
- \endlist
-
- \section2 Qt GUI Module
-
- \list
- \li \l{freetype}{Freetype 2} got updated to upstream version 2.10.1.
- \li \l{libjpeg}{LibJPEG-turbo} got updated to upstream version 2.0.3.
- \li \l{md4c}{MD4C} version 0.3.4 was added under MIT License.
- \li \l{vulkanmemoryallocator}{Vulkan Memory Allocator} version 2.2.0 was added under MIT License.
- \endlist
-
- \section2 Qt Image Formats
-
- \list
- \l{libtiff} got updated to upstream version 4.1.0.
- \endlist
-
- \section2 Qt QML Module
-
- \e {LLVM: ADT} was added under University of Illinois/NCSA Open Source License.
-
- \section2 Qt SQL Module
-
- \l{sqlite}{SQLite} got updated to upstream version 3.30.1.
-
- \section2 Qt Wayland Compositor
-
- The compositor module is no longer available under the GPLv2 and LGPLv3
- licenses, but is still available under GPLv3 and commercial licenses.
-
- \list
- \li The xdg-output-unstable-v1 protocol version 2 was added under the
- MIT License.
- \li The idle-inhibit-unstable-v1 protocol version 1 was added under the
- MIT License.
- \endlist
-
- \section2 Qt Wayland QPA plugin
-
- \list
- \li The primary-selection-unstable-v1 protocol version 1 was added
- under the MIT License.
- \endlist
-
- \section2 Qt WebEngine Module
- \list
- \li Updated Chromium to 77.0.3865
- \endlist
-
- \section1 Qt 5.13.2
-
- \section2 Qt GUI Module
-
- \list
- \li \l{X Server helper} was added under X11 License and Historical Permission Notice and Disclaimer license.
- \li \l{aglfn}{Adobe Glyph List For New Fonts} version 1.7 was added under BSD 3-Clause \"New\" or \"Revised\" License.
- \endlist
-
- \section2 Qt SQL Module
-
- \l{sqlite}{SQLite} got updated to upstream version 3.29.0.
-
- \section1 Qt 5.13.1
-
- \section2 Qt Core Module
-
- \l{unicode-cldr}{Unicode Common Locale Data Repository (CLDR)} got updated to
- upstream version v35.1
-
- \section2 Qt Image Formats
-
- \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{psl}{The Public Suffix List} got updated on 2019-02-20.
- The upstream license is now MPL 2.0.
- \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}{SQLite} got updated to upstream version 3.28.0.
-
- \section2 Qt GUI Module
-
- \list
- \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{libdbus-1-headers}{libdus-1 headers} got updated to upstream version 1.12.12.
-
- \section2 Qt Wayland
-
- \list
- \li The fullscreen-shell-unstable-v1 version 1 was added under the MIT
- License.
- \li The linux-dmabuf-unstable-v1 protocol version 3 was added under the
- MIT License.
- \li The wayland protocol got updated to version 1.16.0.
- \li The wl-scaler protocol version 2 was added under the MIT License.
- \li The wp-viewporter protocol version 1 was added under the MIT
- License.
- \endlist
-
- \section1 Qt 5.12.10
-
- \section2 Qt SQL Module
-
- \l{sqlite}{SQLite} got updated to upstream version 3.32.3.
-
- \section1 Qt 5.12.9
-
- \section2 Qt SQL Module
-
- \l{sqlite}{SQLite} got updated to upstream version 3.32.1.
-
- \section1 Qt 5.12.6
-
- \section2 Qt SQL Module
-
- \l{sqlite}{SQLite} got updated to upstream version 3.29.0.
-
- \section1 Qt 5.12.5
-
- \section2 Qt GUI Module
-
- 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{libwebp}{WebP (libwebp)} got updated to upstream version 1.0.3.
-
- \section1 Qt 5.12.4
-
- \section2 Qt GUI Module
-
- \l{libpng}{LibPNG} got updated to upstream version 1.6.37.
-
- \section2 Qt Core Module
-
- \list
- \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-cldr}{Unicode Common Locale Data Repository (CLDR)} got updated to
- upstream version v35.1
- \endlist
-
- \section2 Qt SQL Module
-
- \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}{Wintab API} was now classified as 'Custom' instead of
- 'Public Domain'.
-
- \section2 Qt SQL Module
-
- \l{sqlite}{SQLite} got updated to upstream version 3.27.1.
-
- \section1 Qt 5.12.2
-
- \section2 Qt GUI Module
-
- \list
- \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{libwebp}{WebP (libwebp)} got updated to upstream version 1.0.2.
-
- \section1 Qt 5.12.1
-
- \section2 Qt Core Module
-
- \list
- \li The version information for \l{FreeBSD} got updated.
- \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
-
- \e{xkbcommon} was removed from 3rd party sources and we are not bundling that library any more.
-
- \section2 Qt Image Formats
-
- \list
- \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}{SQLite} got updated to upstream version 3.26.0.
-
- \section2 Qt Virtual Keyboard Module
-
- The version information for \l{lipitk}{Lipi Toolkit} got updated.
-
- \section2 Qt Wayland Compositor Module
-
- 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-sky}{Miramar Skybox Textures} is now documented.
-
- \section2 Qt Core Module
-
- \list
- \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}{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{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}{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}{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{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}{WebGradients} under the \e{MIT} license is now documented.
- \endlist
-
- \section2 Qt DBUS Module
-
- \l{libdbus-1-headers}{libdus-1 headers} got updated to upstream version 1.12.
-
- \section2 Qt Image Formats
-
- \list
- \li \e{JasPer} got removed.
- \li \e{MNG reference library} got removed.
- \endlist
-
- \section2 Qt Location Module
-
- \list
- \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}{Valgrind} got updated to upstream version 3.14.0.
-
- \section2 Qt Wayland Compositor Module
-
- \list
- \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}{Wayland XDG Output Protocol} under the \e{MIT} license is
- now documented.
- \endlist
-
- \section2 Qt WebEngine Module
-
- \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}{PCRE2} got updated to upstream version 10.31.
-
- \section2 Qt GUI Module
-
- \list
- \li The copyright information for \l{harfbuzz}{HarfBuzz} got updated.
- \li The copyright information for
- \l{grayraster}{Anti-aliasing rasterizer from FreeType 2} got updated.
- \endlist
-
- \section2 Qt Location Module
-
- The copyright information and description of
- \l{clipper}{Clipper Polygon Clipping Library} got updated.
-
- \section2 Qt SQL Module
-
- \l{sqlite}{SQLite} got updated to upstream version 3.24.0.
-
- \section2 Qt WebEngine Module
-
- \list
- \li Chromium received backported security fixes from Chromium up to version
- 68.0.3440.75.
- \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{recipebrowser-marked}{Marked (WebEngine RecipeBrowser example)} got updated to upstream
- version 0.4.0.
- \endlist
-
- \section1 Qt 5.11.1
-
- \section2 Qt 3D Module
-
- 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{coffeeexample-titillium}{Titillium Web Font} in the Coffee demo is now documented.
-
- \section2 Qt Image Formats
-
- \l{libwebp}{WebP (libwebp)} got updated to version 1.0.0.
-
- \section1 Qt 5.11.0
-
- \section2 Qt 3D Module
-
- \list
- \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}{Substance Share} that are available
- under the \e {Creative Commons Attribution 4.0} license. This is now
- documented.
- \endlist
-
-
- \section2 Qt Core Module
- \list
- \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{psl}{The Public Suffix List} got updated on
- 2018-01-04.
-
- \li The concluded license for the
- \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}{Unicode Character Database (UCD)} under the
- \e{Unicode License Agreement - Data Files and Software (2016)}.
- is now documented.
- \endlist
-
- \section2 Qt D-Bus Module
-
- Qt D-Bus uses code from \l{libdbus-1 headers} that are available under the
- \e{Academic Free License v2.1, or GNU General Public License v2.0 or later}.
- This is now documented.
-
- \section2 Qt GUI Module
-
- \list
- \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{libtiff}{TIFF Software Distribution (libtiff)} got updated to upstream
- version 4.0.9.
- \li \l{libwebp}{WebP (libwebp)} got updated to upstream version 0.6.1.
- \endlist
-
- \section2 Qt Quick Controls 2 Module
-
- 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}{SQLite} got updated to upstream version 3.23.1.
-
- \section2 Qt Test Module
-
- 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 \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.
- \li \l{BoringSSL} got updated.
- \li \l{CRC32C} got added under a \e{New BSD} license.
- \li \e{Error Prone} got removed.
- \li \l{Fiat-Crypto: Synthesizing Correct-by-Construction Code for
- Cryptographic Primitives} got added under a \e{MIT} license.
- \li \l{OpenVR SDK} got added under a \e{BSD 3-Clause} license.
- \li \l{Perfetto} got added under a \e{Apache 2} license.
- \li \e{The library to input, validate, and display addresses} got
- removed.
- \li \e{content_shell_fonts} got added under
- \e{SIL OPEN FONT LICENSE, GPL v2, Bitstream Vera Fonts Copyright}.
- \li \e{libcxx} got removed.
- \li \e{libcxxabi} got removed.
- \li \e{libunwind} got removed.
- \li \e{libva} got removed.
- \li \e{libxslt} got added under a \e{MIT} license.
- \li \e{open-vcdiff} got removed.
- \endlist
-
- \section2 Qt XML Patterns Module
-
- Use of \l{xml-xsd}{XML Schema}
- under \e{W3C Software Notice and Document License (2015-05-13)}
- is now documented.
+ \section1 Previous Qt Versions
+ To see license change information for Qt 5.15 and earlier, see
+ \l {https://doc.qt.io/qt-5.15/license-changes.html}.
*/
diff --git a/doc/src/modules.qdoc b/doc/src/modules.qdoc
index c698f6ea..74250d95 100644
--- a/doc/src/modules.qdoc
+++ b/doc/src/modules.qdoc
@@ -98,6 +98,7 @@
*/
/*!
+ \omit
\page activeqt.html
\title The Active Qt framework
\ingroup licensing
@@ -158,4 +159,5 @@
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
\endcode
+ \endomit
*/
diff --git a/doc/src/platforms/ios.qdoc b/doc/src/platforms/ios.qdoc
index 13aea6bd..97ef2fbf 100644
--- a/doc/src/platforms/ios.qdoc
+++ b/doc/src/platforms/ios.qdoc
@@ -146,7 +146,7 @@
\li If your application uses imports or plugins which depend on special Qt
modules, these Qt modules should be added to the .pro file. For example, if
- your application uses the \l{Qt Multimedia} import in QML, you should add
+ your application uses the Qt Multimedia import in QML, you should add
the following to your .pro file:
\badcode
@@ -163,14 +163,14 @@
QTPLUGIN += qavfcamera
\endcode
- See \l {http://wiki.qt.io/QtMultimedia_iOS}{Qt Multimedia on iOS}
- for information on other Qt Multimedia plugins. If your project uses APIs
- from \l {Qt Sensors}, use the following:
+ \omit
+ If your project uses APIs from \l {Qt Sensors}, use the following:
\badcode
QT += sensors
QTPLUGIN += qtsensors_ios
\endcode
+ \endomit
\li Save the changes to your project and run the application.
\endlist
diff --git a/doc/src/platforms/linux.qdoc b/doc/src/platforms/linux.qdoc
index c09c3600..2d7ca5a6 100644
--- a/doc/src/platforms/linux.qdoc
+++ b/doc/src/platforms/linux.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2019 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
@@ -106,7 +106,6 @@
\li \l{Qt Overviews} - list of topics about application development
\li \l{Qt Examples and Tutorials}{Examples and Tutorials} - code samples and tutorials
\li \l{Qt Reference Pages} - a listing of C++ and QML APIs
- \li \l{Qt X11 Extras} - provides additional APIs for X11
\endlist
Qt's vibrant and active community site, \l{http://qt.io} houses
@@ -332,20 +331,7 @@
has been deprecated in favor of the \l{Qt GUI} module (which contains
classes that start with \e QOpenGL).
- \section1 Multimedia Dependencies
-
- As described in the \l Multimedia overview, Qt Multimedia uses the GStreamer multimedia
- framework as the backend for audio and video playback on Linux. The minimum required
- version of GStreamer is 0.10.24. The 1.x series is also supported.
-
- To build Qt Multimedia, you need the GStreamer library, base plugins, and development
- files for your system. To run applications that use Qt Multimedia, you might also need to
- install the following GStreamer plugins: 'good', 'ugly', 'bad', ffmpeg (0.10), and libav (1.x).
- These additional plugins contain various codecs for audio and video decoding, as well as the
- necessary components for using the camera APIs. The package names for GStreamer vary between
- Linux distributions; try searching for \c gstreamer or \c libgstreamer in your distribution's
- package repository to find suitable packages.
-
+ \omit
\section1 Speech Dependencies
\l{Qt Speech} depends on Speech Dispatcher (libspeechd) on the Linux platform.
@@ -356,14 +342,10 @@
\li libspeechd-dev
\li speech-dispatcher
\endlist
-
- \section1 Qt WebEngine Dependencies
-
- \l{Qt WebEngine} has additional build requirements which are listed in the
- \l{Qt WebEngine Platform Notes}.
+ \endomit
\section1 QDoc Dependencies
- Since version 5.11, \l {QDoc Manual}{QDoc} uses Clang to parse C++ code.
+ \l{QDoc Manual}{QDoc} uses Clang to parse C++ code.
If you wish to build QDoc manually, refer to \l {Installing Clang for QDoc}
for specific build requirements.
*/
@@ -846,8 +828,8 @@
mode.
\li Versions 10.1.008 to 10.1.015 for both IA-32 and Intel 64 are
known crash with "(0): internal error: 0_47021" when compiling
- \l{Qt XML Patterns} and \l{Qt Designer} in release mode. Version
- 10.1.017 compiles these modules correctly in release mode.
+ \l{Qt Designer} in release mode. Version 10.1.017 compiles these
+ modules correctly in release mode.
\endlist
\section2 Known Issues with GCC Compilers
diff --git a/doc/src/platforms/macos.qdoc b/doc/src/platforms/macos.qdoc
index 3ad1acfd..5e83bf59 100644
--- a/doc/src/platforms/macos.qdoc
+++ b/doc/src/platforms/macos.qdoc
@@ -1182,7 +1182,6 @@
\li The image format plugins are always deployed.
\li The print support plugin is always deployed.
\li SQL driver plugins are deployed if the application uses the \l{Qt SQL} module.
- \li Script plugins are deployed if the application uses the \l{Qt Script} module.
\li The SVG icon plugin is deployed if the application uses the \l{Qt SVG} module.
\li The accessibility plugin is always deployed.
\endlist
diff --git a/doc/src/platforms/windows.qdoc b/doc/src/platforms/windows.qdoc
index 90a60281..b510d675 100644
--- a/doc/src/platforms/windows.qdoc
+++ b/doc/src/platforms/windows.qdoc
@@ -382,7 +382,7 @@
\note While not typically needed, \c{QT_NO_OPENGL_BUGLIST} can become relevant in
certain virtualized environments, with multiple, possibly virtual, graphics adapters
- present. If the logs from categories like \l{qt.qpa.gl} indicate that the detection of
+ present. If the logs from categories like \c{qt.qpa.gl} indicate that the detection of
the driver and display adapter leads to incorrectly disabling OpenGL, it is then
recommended to set this environment variable in order to enable the application to run
normally. This environment variable was introduced in Qt 5.15.
@@ -464,13 +464,15 @@
\sa {QDoc Dependencies}
+ \omit
\section2 Building Qt WebEngine
\l{Qt WebEngine} has additional build requirements which are listed in the
\l{Qt WebEngine Platform Notes}.
+ \endomit
\section1 QDoc Dependencies
- Since version 5.11, \l {QDoc Manual}{QDoc} uses Clang to parse C++ code.
+ \l {QDoc Manual}{QDoc} uses Clang to parse C++ code.
If you wish to build QDoc manually, refer to \l {Installing Clang for QDoc}
for specific build requirements.
@@ -765,8 +767,10 @@
If Qt was configured to link against ICU or OpenSSL, the respective DLL's
need to be added to the \c release folder, too.
+ \omit
\note \l{Qt WebEngine} applications have additional requirements that are
listed in \l{Deploying Qt WebEngine Applications}.
+ \endomit
Remember that if your application depends on compiler specific
libraries, these must be redistributed along with your
diff --git a/doc/src/qmlapp/usecases/layouts.qdoc b/doc/src/qmlapp/usecases/layouts.qdoc
index ad995eec..1febd4b0 100644
--- a/doc/src/qmlapp/usecases/layouts.qdoc
+++ b/doc/src/qmlapp/usecases/layouts.qdoc
@@ -71,7 +71,7 @@ For the common case of wanting to \e position a set of types in a regular patter
types. Items placed in a positioner are automatically positioned in some way; for example, a \l [QML] Row positions items to be
horizontally adjacent (forming a row).
-For full details see \l {Item Positioners} and the documentation for \l{Qt Positioning QML Types}{the positioner types}.
+For full details see \l {Item Positioners}.
\snippet qmlapp/usecases/layouts.qml import
\snippet qmlapp/usecases/layouts.qml positioners
diff --git a/doc/src/qmlapp/usecases/styling.qdoc b/doc/src/qmlapp/usecases/styling.qdoc
index 034fdda6..81c9885e 100644
--- a/doc/src/qmlapp/usecases/styling.qdoc
+++ b/doc/src/qmlapp/usecases/styling.qdoc
@@ -34,24 +34,27 @@ or by directly assigning a value to a property. For types that incorporate
Qt Quick's \l{Models and Views in Qt Quick}{delegates} the visual type attaches
to the \e delegate property.
-When using \l{Qt Quick Controls 1}, the controls automatically set
+\omit
+When using Qt Quick Controls 1, the controls automatically set
the appropriate style from the respective \l{Supported Platforms}{platforms}.
+\endomit
+\omit
\section1 Using the Styling QML Types
-The \l{Qt Quick Controls 1}{controls} have a \c style property to which the
-\e{styling types} bind. The controls have a corresponding styling type from the
-\l{Qt Quick Controls 1 Styles QML Types}{Qt Quick Controls 1 Styles} module.
-For example, \l [QtQuickControls1] Button has a
-\l [QtQuickControls1] ButtonStyle type and \l [QtQuickControls1] Menu has a
-\l [QtQuickControls1] MenuStyle type. The styling types provide properties
-applicable to their respective controls such as the background, label, or for
-some controls, the cursor appearance.
+The Qt Quick Controls 1 controls have a \c style property to which the
+\e{styling types} bind. The controls have a corresponding styling type
+from the Qt Quick Controls 1 Styles QML Types module.
+For example, QtQuickControls1 Button has a ButtonStyle type and Menu
+has a MenuStyle type. The styling types provide properties
+applicable to their respective controls such as the background, label,
+or for some controls, the cursor appearance.
\snippet qmlapp/usecases/styling.qml 0
-\note \l{Qt Quick Controls 1 Styles QML Types}{Qt Quick Controls 1 Styles} was
-introduced in Qt 5.1 and requires \l{Qt Quick} 2.1.
+\note Qt Quick Controls 1 Styles was introduced in Qt 5.1 and requires
+\l{Qt Quick} 2.1.
+\endomit
\section1 Accessing the System Palette
@@ -61,6 +64,5 @@ of visual types to match the native look and feel. In addition, on
\l{Desktop Platforms}{desktop} platforms, different color palettes are employed
when changing states, for example, when the application loses keyboard focus.
-When using the \l{Qt Quick Controls 1}{controls}, the system colors are already
-used.
+When using the controls, the system colors are already used.
*/
diff --git a/doc/src/qmlapp/usecases/userinput.qdoc b/doc/src/qmlapp/usecases/userinput.qdoc
index 1ffbe6b8..89f8c3ff 100644
--- a/doc/src/qmlapp/usecases/userinput.qdoc
+++ b/doc/src/qmlapp/usecases/userinput.qdoc
@@ -33,12 +33,17 @@
The \l {Qt Quick} module provides support for the most common types of user input,
including mouse and touch events, text input, and key-press events. Other
-modules provide support for other types of user input for example, the
-\l {Qt Sensors} module provides support for shake-gestures in QML applications.
+modules provide support for other types of user input.
+\omit
+For example, the \l {Qt Sensors} module provides support for shake-gestures
+in QML applications.
+\endomit
-This article covers how to handle basic user input; for further information
-about motion-gesture support, see the \l {Qt Sensors} documentation. For
-information about audio-visual input, see the \l {Qt Multimedia} documentation.
+This article covers how to handle basic user input.
+\omit
+For further information about motion-gesture support, see the
+\l {Qt Sensors} documentation. For information about audio-visual input, see the \l {Qt Multimedia} documentation.
+\endomit
\section2 Mouse and touch events
diff --git a/doc/src/qmlapp/usecases/visual.qdoc b/doc/src/qmlapp/usecases/visual.qdoc
index 719c2b3a..70e39cbf 100644
--- a/doc/src/qmlapp/usecases/visual.qdoc
+++ b/doc/src/qmlapp/usecases/visual.qdoc
@@ -54,7 +54,9 @@ borders. \l AnimatedImage plays animated .gif and .mng images. \l AnimatedSprite
and \l SpriteSequence play animations comprised of multiple frames stored adjacently
in a non animated image format.
+\omit
For displaying video files and camera data, see the \l {Qt Multimedia} module.
+\endomit
\section1 Shared Visual Properties
diff --git a/doc/src/scripting.qdoc b/doc/src/scripting.qdoc
index f15a28eb..86b875c6 100644
--- a/doc/src/scripting.qdoc
+++ b/doc/src/scripting.qdoc
@@ -30,32 +30,21 @@
\title Scripting
\brief Qt's scripting features
-Qt has three main ways to help make an application scriptable. All of them allow easy
-integration of the \l{ECMAScript Reference}{ECMAScript} (more widely known as JavaScript) language into the application. Depending on how deep
+Qt has two main ways to help make an application scriptable. All of them allow easy
+integration of the \l{ECMA-262}{ECMAScript} (more widely known as JavaScript) language into the application. Depending on how deep
the integration should be, one of these APIs can be used:
-\section1 Qt Script Module
- \l {Qt Script} is a separate module, designed with scripting applications in mind. It has
- a mature and rich API that permits a really deep integration of scripting functionality. It allows
- evaluating and debugging of scripts, and advanced use of objects and functions. It also gives access to a really
- low level \l{ECMAScript Reference}{ECMAScript} engine API. Full documentation about using \l{Qt Script} to make an application
- scriptable can be found \l{Making Applications Scriptable}{here}.
-
-\warning This module is not actively developed. It is provided for backwards
-compatibility with Qt 4 only. For new code, use
-\l {JS API}{QJSEngine and related classes} in the Qt QML module instead.
-
\section1 JS API
-This is a simple API, very similar to \l{Qt Script}, but limited to basic functionality. The main
- classes are QJSEngine and QJSValue, which can be used to embed pure \l{ECMAScript Reference}{ECMAScript} functionality
- like evaluating scripts and calling functions.
+This is a simple API, but limited to basic functionality. The main classes
+are QJSEngine and QJSValue, which can be used to embed pure \l{ECMAScript Reference}{ECMAScript}
+functionality like evaluating scripts and calling functions.
\section1 QML
-\l{Qt QML}{QML} exposes a modified \l{ECMAScript Reference}{ECMAScript} environment. It is designed to mix well with the JavaScript
+\l{Qt QML}{QML} exposes a modified \l{ECMA-262}{ECMAScript} environment. It is designed to mix well with the JavaScript
API mentioned earlier. QML may be used without \l{Qt Quick} components, which may be useful for
- server side scripting. With QML it is possible to mix pure \l{ECMAScript Reference}{ECMAScript} and declarative components
+ server side scripting. With QML it is possible to mix pure \l{ECMA-262}{ECMAScript} and declarative components
(\l{Use Case - Integrating JavaScript in QML}).
All of these three scripting solutions seamlessly inter-operate with \l{The Meta-Object System}{the Meta-Object System}, which means that all \l{Signals & Slots}{signals and slots} and
-\l{The Property System}{properties} of a QObject instance are accessible in an \l{ECMAScript Reference}{ECMAScript} environment.
+\l{The Property System}{properties} of a QObject instance are accessible in an \l{ECMA-262}{ECMAScript} environment.
*/
diff --git a/doc/src/topics.qdoc b/doc/src/topics.qdoc
index 53d17a5d..1b006437 100644
--- a/doc/src/topics.qdoc
+++ b/doc/src/topics.qdoc
@@ -38,7 +38,9 @@ functionality and can be used as a starting point for learning how to to get the
\li \l{User Interfaces}
\li \l{Core Internals}
\li \l{Data Storage}
+\omit
\li \l[QtMultimedia]{Multimedia}
+\endomit
\li \l{Networking and Connectivity}
\li \l{Graphics}
\li \l{Integrating Web Content}
diff --git a/doc/src/web-content.qdoc b/doc/src/web-content.qdoc
index 3a593654..1b5462dd 100644
--- a/doc/src/web-content.qdoc
+++ b/doc/src/web-content.qdoc
@@ -35,9 +35,13 @@ range of standard web techologies such as HTML, CSS, and JavaScript. These
interfaces enable applications to embed content from the World Wide Web.
It is also possible to combine Qt C++ and QML code with HTML and JavaScript to
-create web applications. Through \l{Qt WebChannel}, several of Qt's APIs are
-accessible to remote clients.
+create web applications.
+\omit
+Through Qt WebChannel, several of Qt's APIs are accessible to remote clients.
+\endomit
+
+\omit
\section1 WebEngine in Qt
Qt provides the Chromium-based \l{Qt WebEngine} module for applications
@@ -56,6 +60,8 @@ These pages contain information about porting applications to use
\li \l{Porting from Qt WebKit to Qt WebEngine}
\endlist
+\endomit
+\omit
\section1 Qt and HTML-JavaScript Hybrid Applications
The \l{Qt WebChannel} module enables HTML or JavaScript clients to access
@@ -70,4 +76,5 @@ These pages contain more information about the various APIs:
\li \l{Qt WebChannel Standalone Example}{Standalone Example}
\endlist
+\endomit
*/
diff --git a/examples/demos/maroon/doc/src/maroon.qdoc b/examples/demos/maroon/doc/src/maroon.qdoc
index e6f0a252..eb02a477 100644
--- a/examples/demos/maroon/doc/src/maroon.qdoc
+++ b/examples/demos/maroon/doc/src/maroon.qdoc
@@ -829,7 +829,7 @@
\section1 Playing Sound Effects
- The app can play sound effects if the \l{Qt Multimedia} module is installed.
+ The app can play sound effects if the Qt Multimedia module is installed.
In the SoundEffect.qml file, we proxy a SoundEffect type:
\quotefromfile demos/maroon/content/SoundEffect.qml
@@ -838,7 +838,7 @@
\printuntil }
We add the \c qtHaveModule() qmake command to the app .pro file, maroon.pro,
- to check whether the \l{Qt Multimedia} module is present:
+ to check whether the Qt Multimedia module is present:
\quotefromfile demos/maroon/maroon.pro
\skipto QT
diff --git a/examples/demos/photosurface/doc/src/photosurface.qdoc b/examples/demos/photosurface/doc/src/photosurface.qdoc
index dd1b2fe7..306ca42d 100644
--- a/examples/demos/photosurface/doc/src/photosurface.qdoc
+++ b/examples/demos/photosurface/doc/src/photosurface.qdoc
@@ -83,7 +83,7 @@
\skipto FileDialog
\printuntil }
- To use the FileDialog type, we must import \l{Qt Quick Dialogs}:
+ To use the FileDialog type, we must import Qt Quick Dialogs:
\code
import QtQuick.Dialogs 1.0