The closing C-style comment delimiter causes the entire documentation
block to terminate early.
In passing, fix some formatting issues, converting documented steps
to an ordered \list.
Mark the qtdoc module clear of documentation warnings.
Pick-to: 6.6
Change-Id: I55973e5ed84038fcd7a164e091c112f929af32be
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
Add the full list of all example categories in the right order
to QtDoc metadata. This will generate a matching list in the
matching examples-manifest.xml file, and allows Qt Creator to sort
the categories correctly.
Pick-to: 6.5 6.6
Change-Id: I45dccf4d7fd0020e25f19e22a5bfebb44f640cca
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
The most common limit for the maximum number of allowed documentation
warnings is zero. As all Qt module docs include() a common configuration
from qtbase, it's better to control the base warninglimit from a central
location in qtbase/doc/global.
This allows for a temporary increase of the limit across all modules as
needed - for example, when updating the QDoc binary that the CI
provisions to a version that introduces new types of documentation
warnings.
Task-number: QTBUG-113326
Change-Id: I51cccfed5fe4ff27c99cb280db1f0959be16df1d
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
- Combine the "Internationalization with Qt" and
"Internationalization and Localization with Qt Quick"
topics
- Add a "Localizing Applications" topic
- Move information from the Qt Linguist Manual developer
section to the new topics
- Add a link to a YouTube video about localizing apps
- Use active voice and present tense
Fixes: QTBUG-71876
Change-Id: If2db1d4865e47a85e0b63adac326fc123ad65e50
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
This sets 'url.examples' that is used for generating the link to
the example project under code.qt.io in example documentation.
Pick-to: 6.5 6.4
Change-Id: I5f7647d38b622503c3b1e1d568d64762ef4c55bf
Reviewed-by: Vladimir Minenko <vladimir.minenko@qt.io>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Modified Data storage page to I/O and various ways to
retrieve and save data.
Fixes: QTBUG-104786
Fixes: QTBUG-104353
Pick-to: 6.4 6.5
Change-Id: Ie4f7c3ebec2f2c2179680ad36e59e97cefd163fc
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
How it works page, host environment variables page,
and relevant CMake information page added.
Fixes: QTBUG-107704
Pick-to: 6.4 6.2
Change-Id: I823d3f9d97f49e79da867660bd4cd41a8378266a
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
Change-Id: I96ae4df88465eeecd40d8c32dae2a9302fda1bfc
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Add step-by-step install instructions for installing Qt for application
development and Qt Design Studio for Qt educational license holders.
These steps differ from normal procedure with the online installer as
it involves the creation of Qt Account via the education license
program, and the available packages differ from those in the open-source
edition.
Add instructions for using Raspberry Pi as a target hardware via QBSP,
also available as part of the educational license.
Link to the new pages from Getting Started, and add information about
the educational license to Licensing page.
Pick-to: 6.4
Fixes: QTBUG-106537
Done-with: Hanna Humaljoki <hanna.humaljoki@qt.io>
Change-Id: Icce481c50f19580363e25e07b084bc80d7e1132a
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
A relative path was used to refer to a thumbnail image for a video link
on Qt for Android overview page. While QDoc was able to locate and copy
the image to the output directory, the relative path appears as-is in
the generated .qhp file and is no longer correct, causing qhelpgenerator
to ignore it.
Consolidate all 'extra images' into the same source directory and handle
them in one location in the .qdocconf file.
Pick-to: 6.4
Change-Id: I66531da883bac57fcf32e75c11eb087a648d9798
Reviewed-by: Luca Di Sera <luca.disera@qt.io>
Only the coffee machine example had some tags already. Add them
also for the rest, but inside the .qdoc file, instead of the
more clunky/verbose tagging in the .qdocconf file.
Pick-to: 6.4
Change-Id: I37640c2296c67413361f7987122c5e7daa1f12b0
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
The YouTube ID copied from the browser was incorrect.
This patch fixes this.
Will build locally and check embedded YouTube videos work in future
before pushing.
Pick-to: 6.4
Change-Id: Ib48500a2b49abb17177353bc544dcb05d10c219b
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
Embedded the YouTube video in the getting started with android docs.
Fixes: QTBUG-107151
Pick-to: 6.4
Change-Id: I9b4e77de6f6be19eb29efd7241a9e7ee1ddefa02
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
* Drop the link to 'Qt Creator' under the 'Reference' section; it's not
really a reference, and can be reached via the 'Developer Tools'
link easily.
* Shorten 'All Qt Reference Documentation' to 'All Qt Reference Pages'
Pick-to: 6.3
Change-Id: Iad3dec5607cee0c13420834feb5db6362eae5fa3
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
While the page links to dedicated pages that list new features in each
6.x release, the page itself no longer serves as the authoritate source
for new features. Rename it to 'Introduction to Qt', adjust links and
the sidebar.
Pick-to: 6.3.0 6.3
Fixes: QTBUG-96459
Change-Id: I6c5c17444fcbd456f7b35f485da7cd2b347f09ac
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
Adding the calqlatr as a highlighted example in the qt creator welcome
page.
Pick-to: 6.2
Change-Id: Ib87d0f731d2922d1f5c697479a2a4f936d9a836f
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
customFilters defined in .qdocconf are not supported anymore by Qt
Assistant since Qt 5.13. Therefore remove them from all .qdocconf files,
also to avoid cargo-culting them to new help modules.
Task-number: QTBUG-95987
Change-Id: I83562b30c2fa039b7a207caaf7b3705ae0e4aa70
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Offline documentation needs a thumbnail image which acts a link to
open the video in an external browser.
Task-number: QTBUG-91675
Pick-to: 6.1 6.0 5.15
Change-Id: Ief7a1cea4e3df139fcb1819d9b6a65da302e1b2d
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Now when the XmlListModel is a part of QtDeclarative, we
can udpate the examples, which were using the model.
This patch introduces the following changes:
- Uses XmlListModel from QtDeclarative, removes the custom
implementation from shared subdir.
- Improves photoviewer and rssnew examples to get rid of
some qml and C++ warnings and deprecation notifications.
- Updates the documentation for photoviewer and rssnew
examples to reflect the usage of the XmlListModel from
QtDeclarative.
- Enables documentation build for rssnews example
Task-number: QTBUG-89817
Change-Id: If3736a18070dc19492058f7c184d5c9cfab74663
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
This should avoid unnecessary attention
to these examples, at least till they are fixed.
Change-Id: Iffbbfa06c56c9cf66e9b70a632ced175206ac78a
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Qt 6.0 doesn't support many of the Qt 5 mobile APIs
and we need to re-emphasize the other parts of the
mobile story.
Task-number: QTBUG-87158
Change-Id: I08fb6d1941f8229d2f66971eddabe9f964f9ad8a
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Adds a new top level topic for platform integration, moving
the QPA docs under that, and cleans up and rewrites the QPA docs
for Qt 6.
Task-number: QTBUG-80233
Change-Id: I658e5e2c402a25ce391102675cee6ada0563e71f
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
-Added link to the Qt 6 version from main page
-Updated sidebar link
Task-number: QTBUG-85517
Change-Id: Ide5e931b37340c0a6ce103c1a8b051e8cd9ab605
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This update sets the depends variable in qtdoc.qdocconf to '*'.
Change-Id: Ib202a7a9aa1a3990a303cfe5d19a158d1ecc1b6b
Task-number: QTBUG-77126
Reviewed-by: Martin Smith <martin.smith@qt.io>
- 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>
We've now four pages, which logically belong together. So let's
move them into one 'qtcmake' module.
Change-Id: I3015fc0804d62bcaec2cfbb6b84c6c08fe5f43f8
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Previous commits had introduced a number of linking issues and other
problems. Linking to Qt Canvas 3D fails as the module was dropped -
remove references to it.
Change-Id: I7a24f82662929bc56cea4db919c02651a1a456a4
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Add a dependency and linking to the module (as Technology Preview).
Task-number: QTBUG-74041
Change-Id: I44c8cd2804fcb46cbe2d379e688c7c755c33ef04
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
The depends order affects the auto links in the doc,
especially for Controls 1 and Controls 2 QML types.
Change-Id: Ibf46f9dc7428cfc6e242720d437939b0b29ab518
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
This change is inline with the updated link targets in the
Qt Quick Controls 1 docs.
Task-number: QTBUG-70333
Change-Id: I4ab6f6729d450337570ff89d330aa431b4b0bd1b
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Without it the link to the manual fails.
Change-Id: I74bd681e83bd05a6262c8db11db8b44a2c0335dc
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>
These are unnecessary and break linking on pages with identical section
titles.
Task-number: QTBUG-70435
Change-Id: I86f2b94253fc9217bc5b197d03c7018a94c717c6
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
These demos use several modules and moving them allows to use for
example Qt Quick Controls 2 in them.
The shared directory should be removed and the examples made
self-contained.
Change-Id: I5dc667d22388651894d7d145b65752bc5c5cf6cf
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@qt.io>
Topi Reinio
Kai Köhne
Leena Miettinen
Jaishree Vyas
Nicholas Bennett
Thibaut Cuvelier
Andy Shaw
Venugopal Shivashankar
Oliver Eftevaag
Paul Wicking
Tor Arne Vestbø
Ivan Solovev
Ralf Habacker
Andreas Buhr
Jerome Pasion
Martin Smith
Tomi Korpipaa
Nico Vertriest
Qt Forward Merge Bot