Commit Graph

92 Commits

Author SHA1 Message Date
Kai Köhne
486c8aae62 Doc: Change links from froglogic to qt domain
Pick-to: 5.15 6.2 6.4
Change-Id: Ic249f8dfa168948eddc83f35314708ffb40e75b1
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-12-09 11:40:49 +01:00
Lucie Gérard
05fc3aef53 Use SPDX license identifiers
Replace the current license disclaimer in files by
a SPDX-License-Identifier.
Files that have to be modified by hand are modified.
License files are organized under LICENSES directory.

Task-number: QTBUG-67283
Change-Id: Id880c92784c40f3bbde861c0d93f58151c18b9f1
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Lars Knoll <lars.knoll@qt.io>
Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
2022-05-16 16:37:38 +02:00
Edward Welbourne
0e5c39ee13 Document what QtTest's various loggers do
Provide basic (internal) documentation of each logging class and link
the command-line documentation to pages relevant to the formats not
defined by Qt.

Change-Id: I3251dd1304203c6ab87dfe1f2dec0e9787ab69f8
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
2022-03-22 17:43:13 +01:00
Thiago Macieira
30e90841bc QProcess/Doc: update the information on how the program is found
Pick-to: 5.15 6.2 6.3
Change-Id: I54f205f6b7314351b078fffd16d05b1eecb24544
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-03-10 18:20:13 -08:00
Assam Boudjelthia
1956ca7d70 Document use of android:allowNativeHeapPointerTagging in the manifest
Document the tag for more clarity on why it's needed, and for what
platforms.

Pick-to: 6.2 6.3
Task-number: QTBUG-97009
Task-number: QTBUG-91150
Change-Id: Ie4522fb582583be07270d3cdbf83992897b51669
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2022-03-05 17:37:33 +02:00
Kai Köhne
c6d221f0a9 Doc: Update cmake documentation link
http://www.cmake.org/cmake/help/documentation.html works, but is
nowadays just a redirect.

Change-Id: Ic443eb5e16ef92f523391bcb94cd7763d0e39151
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
2022-02-09 16:53:27 +01:00
Topi Reinio
869f14fb35 Doc: Fix typo in \externalpage command
Pick-to: 6.3 6.2 5.15
Change-Id: I7a2dd1057dae5424f27da314e56dbfad6e34e438
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-01-07 17:13:18 +01:00
Leena Miettinen
c68b057510 Doc: Update external links to Qt Creator Manual
Sync with Qt Creator Manual 6.0.0.
Remove topics related to using Qt Quick Designer plugin
because they are now in the Qt Design Studio Manual, only.
Add new topics and fix some topic titles.

Some topics also exist in Qt Design Studio Manual and can
be accessed with the "Qt Design Studio:" prefix.

Pick-to: 5.15 6.2
Change-Id: Ie4f07b0a1602f3318ca5335ee72130ddce12801e
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2022-01-04 13:01:31 +01:00
Leena Miettinen
25406a6526 Doc: Add link targets for Qt Design Studio Manual topics
You can use these link targets in Qt docs to refer to
QDS topics.

Pick-to: 6.2
Change-Id: I4d4e288e1456ef92c5e8d9949390a431220eab75
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
2022-01-03 15:32:56 +00:00
Luca Di Sera
fc73b585f8 Doc: Update Microsoft's Documentation Links
The documentation links on `msdn.microsoft.com` now redirect to
`docs.microsoft.com`.

While the redirection works, our script to catch broken links on
dev-snapshots builds of the documentation doesn't handle redirection
correctly, reporting it as broken.

Both to appease the broken-links script and to avoid an unneccesary
redirection, the links were modified to point to the equivalent address
in the new domain.

Furthermore, the link to the `Winsock 2 Socket Handle` was moved to be
an `\externalpage` link, as it was used in two different places.

Additionally, the `\externalpage` link titled `Dirext X SDK` was removed
as it was not used in any part of the documentation.

Task-number: QTBUG-96127
Pick-to: 6.2 6.2.0
Change-Id: I07f0ae8d610a7f8322b892a2fa37a5cc1769289e
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2021-09-23 15:55:59 +00:00
Luca Di Sera
10eedd175e Doc: Centralize RFC documentation-links in rfc.qdoc
In the effort of repairing broken links as per QTBUG-96127,
a series of RFC links referring to `tools.ietf.org/html/*` were modified
to point to the new address that the site redirected to.

To simplify executing a similar task and to diminish the duplication of
manually inserted urls, the already existing `rfc.qdoc` file, containing
`\externalpage` commands directing to RFC locations, was enhanced with
links to all RFCs that were mentioned in the current documentation, so
as to aggregate this common category of links.

All links pointing to a `ietf` domain inside QDoc documentation blocks
were then changed to use the newly provided external-references.

Task-number: QTBUG-96127
Pick-to: 6.2
Change-Id: I2a52eb6aa8c9e346f64ef1a627b039220d9f6c2a
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
2021-09-16 15:52:27 +02:00
Luca Di Sera
e3d16b984a Doc: Repair broken link to the Netscape Cookie Specification
The link was replaced with an equivalent one from the Internet Archive's
Wayback Machine, as it is the one used in
RFC-6265 (https://datatracker.ietf.org/doc/html/rfc6265#ref-Netscape) to
deliver the same information.

Task-number: QTBUG-96127
Pick-to: 6.2
Change-Id: I3d8b7ac511e040c1b4651b59ddedfa580c45ce90
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
2021-09-15 20:13:38 +02:00
Luca Di Sera
d32f7dde25 Doc: Update \externalpage links for RFC
The `rfc.qdoc` file was modified to order the external RFC link by RFC
number.

Furthermore, the links were modified to use the `datatracker.ietf.org`
domain to be consistent with the recent changes to the old
`tools.ietf.org` links.

Task-number: QTBUG-96127
Pick-to: 6.2
Change-Id: I865e7ea131264d0b123f34d796b7ec8007931adc
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
2021-09-15 17:42:39 +00:00
Luca Di Sera
3ddc3c78ce Doc: Update some links to Microsoft's documentation
The documentation links on `msdn.microsoft.com` and
`msdn2.microsoft.com` now redirect to `docs.microsoft.com`.

Some of the links in the documentation were to those domains.

In particular:

- An `\externalpage` link to the `Mitigating Cross-site Scripting With
HTTP-only Cookies` article.
- An `\externalpage` link to `Microsoft Actibe Accessibility Event
Constants`
- A link to the `RtlGetVersion` function in
`qoperatingsystemversion.cpp`
- A link to the `GetCommandLine` function in `qcoreapplication.cpp`
- A link to the `KNOWNFOLDERID` constant in `qfiledialog.cpp`

While the redirection works, our script to catch broken links on
dev-snapshots builds of the documentation doesn't handle redirection
correctly, reporting it as broken.

Both to appease the broken-links script and to avoid an unneccesary
redirection, the above links were modified to
point to the equivalent address in the new domain.

Task-number: QTBUG-96127
Pick-to: 6.2
Change-Id: I0e9a132f06af7fc43bca6c8ad2054feb6e3e27cd
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2021-09-13 08:57:03 +02:00
Lars Schmertmann
f2b914afc6 Android: Enable QDesktopService
QDesktopServices::openUrl(const QUrl &url) is already implemented
on Android. But even if it is possible to set an URL handler, the
mechanism to invoke it is missing. With this commit the URL handler
will work on Android like it is already working on iOS.

Task-number: QTBUG-84382
Pick-to: 6.2
Change-Id: Ic560bd380f1cc59586861aa1a6a3ea064276a39e
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2021-09-10 06:41:15 +02:00
Assam Boudjelthia
90d8a7bed6 Add note on selecting the device which is used to run tests on Android
Pick-to: 6.2 5.15
Change-Id: I9bcff18ca11fbbfdff968e29190cae488de56263
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
2021-08-18 19:53:38 +00:00
Paul Wicking
87249cd8b0 Doc: Terminate C-comment
Pick-to: 6.2 6.1
Change-Id: I18d3e609781c0f8d518982292279b497dac539a5
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2021-06-30 13:36:26 +02:00
Paul Wicking
7968281444 Doc: Use https for links to unicode.org
* Change all outbound links in user-facing documentation.
* Reflow lines that exceed 100 cols as mandated by clang-format.
* Add unicode.org as a global \externalsite.

Pick-to: 6.2 6.1 5.15
Change-Id: I2ba1e434aa913e678406d62c2801f1a8b2d9e4f4
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2021-06-25 18:55:55 +02:00
Leena Miettinen
7c57288460 Doc: Update Qt Creator link targets
- Add links to new topics
- Remove links to obsolete topics
- Update changed topic titles (might break links in module docs)
- Fix HTML file name of the Creating a Mobile Application topic

Change-Id: I8f06171946d85ed0fbfd457ed115f41cb5a9e2d0
Reviewed-by: Nico Vertriest <nico.vertriest@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2021-02-01 16:29:33 +01:00
Andreas Buhr
1c635e805f Fix typo in external-resources.qdoc
C++ comment was terminated by "/" instead of "*/"

Task-number: QTBUG-88533
Pick-to: 6.0
Change-Id: I560b69602856009509781e56df36fee5879a297f
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
2020-12-07 15:43:42 +01:00
Andreas Buhr
987ee22690 Fix broken link to Zstandard library
The old link zstd.net is not working any more. Zstandard is now at
http://facebook.github.io/zstd/. To ease maintenance in the future,
those links now point to "Zstandard Site" which is maintained in
external-resources.qdoc.

Task-number: QTBUG-88533
Pick-to: 6.0
Change-Id: Ic8f067fd5d7ce1a088d0272797fca98fd506a26e
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
2020-12-04 18:47:13 +01:00
Kai Koehne
77d7ca2d26 Doc: Add external link to conan.io
We don't use it yet in qtbase, but will need it in various other sub-modules,
so it's arguably better to maintain it here.

Change-Id: I5c10c9b34cafd435251918280ad0405189900337
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-11-16 08:13:37 +01:00
Jerome Pasion
0ce1865ffa Add link to Qt for Python as external page
Qt for Python can be linked with \externalpage QDoc command

Task-number: QTBUG-87158
Change-Id: I68acc028f89af09cbd069e098a0fbbfa72234cdc
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2020-10-20 11:30:35 +02:00
Jerome Pasion
23d517b446 Add Qt Marketplace link as an external page
Link to the website with the QDoc \l command

Task-number: QTBUG-87158
Change-Id: I1ae93f4ecf917dbb06e4ebd1eb1ca1b8fe31562b
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2020-10-12 13:00:43 +02:00
Jerome Pasion
a80e1766d8 Add links to Qt 3D Studio and Qt Design Studio
Enables linking to them using QDoc \l command

Task-number: QTBUG-85517
Change-Id: I23073a5c7b2f06a8ecf66116c538dcd3fff08f61
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-10-08 16:29:14 +02:00
Kai Koehne
1381b59222 Remove last remainings of Qt Quick 1 imports
amends  e1fd607493

Change-Id: I4587ae287635bc9718325a24bee728f1c1938978
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2020-05-25 11:48:12 +02:00
Assam Boudjelthia
cc106ce565 Android: update Android specific variables docs
Android variable are missing from the list of QMake variables...

Task-number: QTBUG-80390
Change-Id: Ic10f96687334eea99c0302d7137685b1bf6e56c6
Reviewed-by: BogDan Vatra <bogdan@kdab.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-04-17 17:27:36 +03:00
Leena Miettinen
382619de65 Doc: Fix copy-paste error in QOpenGLTexture::Target docs
Add a link to https://www.khronos.org/opengl/wiki/Array_Texture.

Fixes: QTBUG-49802
Change-Id: Ic740dd758c41a8f3e471a503bd2d02f6d3096f50
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-01-28 18:42:58 +01:00
Leena Miettinen
2656d3e923 Doc: Add external links to new topics in Qt Creator Manual
These topics were added to Qt Creator Manual 4.9 and 4.10.

Change-Id: I2e9bf355eb78b5e9877d0ca0bc41de00ed2b4333
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-09-05 17:36:05 +02:00
Kai Koehne
b7aea2bcd3 Qt Widgets: Document CMake macros
Task-number: QTBUG-72159
Change-Id: Ib9fdf852583964cf07c4d26e0a6c74f0058e29f1
Reviewed-by: Kevin Funk <kevin.funk@kdab.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2019-05-16 13:24:25 +00:00
Kai Koehne
57b4f6d56e Qt Core: Document CMake macros
Document public macros in Qt5CoreMacros.cmake. This will replace
the list in the current CMake Manual.

Task-number: QTBUG-72159
Change-Id: I377412fe0c1d0a9b232162bbab88ac830d2cac80
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2019-05-16 13:24:08 +00:00
Kai Koehne
f2b5baf9d0 Update external links to CMake documentation
We don't support CMake version 2 anymore. Instead of just updating
to a newer (but fixed) version let's link to the latest
documentation. This might create a bigger risk that links get
stale, but hopefully let people find always the latest information.

Task-number: QTBUG-72159
Change-Id: I082de80cf9ee107b5d017ab8ad6369f2448b0e1b
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2019-04-25 05:22:31 +00:00
Paul Wicking
341d967068 Doc: Fix broken links after page rename
The title of the external page 'Creating a Mobile Application' in the
Qt Creator docs has changed to include a space between 'Qt' and
'Creator'. This caused the filename to change, thus breaking the
incoming links from the Qt for (iOS|Android) Examples pages.

Task-number: QTBUG-69678
Change-Id: I7819a9e2b483bc760af5bb636841bccf0c6cb739
Reviewed-by: Nico Vertriest <nico.vertriest@qt.io>
2018-07-31 15:52:36 +00:00
Leena Miettinen
2ce62ed87b Doc: Update external links to Qt Creator Manual
Reflects version 4.7.

Change-Id: Ia41b5c1a7eb829ab3c6ec0d3bd9fe60dcbfed54d
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2018-07-20 11:26:01 +00:00
Leena Miettinen
2740584e6d Doc: Update Qt Creator Manual link targets to match version 4.4
Change-Id: Ib784779b09f4bce38ada4833777f873ee510af16
Reviewed-by: Tarja Sundqvist <tarja.sundqvist@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2017-08-23 12:18:14 +00:00
Nico Vertriest
b7c33df724 Doc: add tutorials to overview page Qt Widgets
Change-Id: I62037ce2190689b2e9c8d62a9d67e1d477e1be42
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2017-07-03 10:35:44 +00:00
Kai Koehne
87229adca8 Change MinGW link to MinGW-w64
We're only supporting builds with MinGW-w64 these days.

Change-Id: I1198551ba85132c3f0f81e32f11aa149126ca61f
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2017-07-03 10:16:44 +00:00
Nico Vertriest
4d3b9171fe Doc: Add Creating C++ Classes to externalsites/qtcreator.qdoc
qtquickcontrols2-customize.qdoc:28: warning: Can't link to 'Creating C++ Classes'

Change-Id: I7e8e84d7a0d03a84f32d860bc646640e5cf6258f
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
2017-03-29 12:31:13 +00:00
Leena Miettinen
5e921a18b2 Doc: Enable global linking to new Qt Creator VCS subtopics
Each supported version control system is described in
more detail in a dedicated topic since version 4.2.

Change-Id: I666f8c18d31954935c836509e572a3bfd2c2a32e
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2016-11-25 10:52:04 +00:00
Leena Miettinen
6a9e039d19 Doc: Fix link to qsslkey-p11 example in external-resources
Apparently, the example has been moved.

Change-Id: If68e5db87321e8ff4af652a1cbbd0c3243acb515
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
2016-10-19 14:03:40 +00:00
Kai Koehne
357a35eaf0 Add \externalpage for The Qt Company
Change-Id: If8f8e949c6c6799fbe2e382fee3b1fcccab6a350
Reviewed-by: Lars Knoll <lars.knoll@qt.io>
2016-08-12 06:55:04 +00:00
Topi Reinio
100970687f Doc: Fix broken external link to livecoding vfx video
Change-Id: Idf4ea5f175b3ad41292e5ba8e4538311b00c6d2f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2016-08-02 07:52:00 +00:00
Edward Welbourne
b5695bd5be Merge remote-tracking branch 'origin/5.6' into 5.7
Change-Id: Ibd81cd1df4a0650d93fcb556a57be90be2e1f569
2016-07-04 15:58:39 +02:00
Friedemann Kleint
df9aee2150 Fix URL to ANGLE
Point to the README.md of the project; the old URL
http://code.google.com/p/angleproject is now redirected
to the bugtracker.

Change-Id: I293fc150d5b6c08f16effe8921010050faa264b5
Reviewed-by: Maurice Kalinowski <maurice.kalinowski@qt.io>
2016-06-30 07:06:39 +00:00
Jani Heikkinen
cd46a2daf5 Unify license header usage.
Update files using old header.LGPL3 to header.LGPL
Update files using old FDL template to use new one
Update files using old BSD template to use new one

Change-Id: I36a78272516f9953d02956522f285b40adfc8915
Reviewed-by: Lars Knoll <lars.knoll@theqtcompany.com>
2016-03-29 10:20:03 +00:00
Frederik Gladhorn
ad16478a76 Merge remote-tracking branch 'origin/5.6' into dev
Based on merge done by Liang Qi

Change-Id: Id566e5b9f284d29bff2199f13f9417c660f5b26f
2016-01-08 12:35:24 +01:00
Topi Reinio
f25298bd11 Doc: Update Qt Account url
Change-Id: I123ce085032eeb323f7c60548a9651c5188bb337
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
2015-12-21 13:33:00 +00:00
Simon Hausmann
ea5f40a788 Merge remote-tracking branch 'origin/5.6' into dev
Change-Id: Ib43c6f126998eefcfed9a7c1f2bcbac8b4dd05ec
2015-11-27 08:27:53 +01:00
Leena Miettinen
09b64aa9d3 Doc: add links to new topics in Qt Creator Manual 3.6
Change-Id: I4e317c8dad847c4b4be5e9a9d7c904abc2fa95c7
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
2015-11-24 15:17:54 +00:00
Louai Al-Khanji
dbb7817e13 Remove remaining support for Blackberry
The platform is no longer supported or actively maintained, and is
in the way for improvements to the Unix event dispatcher and QProcess
implementations.

Change-Id: I3935488ca12e2139ea5f46068d7665a453e20526
Reviewed-by: Lars Knoll <lars.knoll@theqtcompany.com>
2015-11-21 15:38:39 +00:00