The documentation needs to be improved especially because the headers
are highly templated and it is very hard to understand anything just
from the API.
Task-number: QTBUG-129103
Pick-to: 6.9 6.9.0
Change-Id: I7cb22f7b3501ecb727a50da89230e071637af512
Reviewed-by: Matthias Rauter <matthias.rauter@qt.io>
Qt HTTP Server is out of technology preview in Qt 6.8.0.
Task-number: QTBUG-129773
Pick-to: 6.8
Change-Id: I2dc7ea1d4c90800f3bace9497370632bea690085
Reviewed-by: Jesus Fernandez <jsfdez@gmail.com>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit organizes the articles, so they:
- have a reasonable tree structure
- can be navigated through the topic tree in the Qt Creator help viewer
Task-number: QTBUG-127313
Change-Id: I029e05c1131f302dff4fdc6289e0a89cf569871f
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
To keep the API lean, remove the SSL confguration and listen()
methods.
Instead using listen() on a QAbstractHttpServer, a user should
create an instance of a QTcpServer or QSslServer, then call
listen() on it before calling bind() on a QAbstractHttpServer
with it as an argument.
Task-number: QTBUG-125859
Pick-to: 6.8
Change-Id: I366c0a01d8b7ee3802e0bdd63b9d84813338f478
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
The status parameter used in QHttpServerResponse constructors
are not const in header file, but const in the implementation.
This compiles on all compilers in CI, but does not work when
generating documentation. Status is not supposed to be const
because it is passed by value. Fix the implementation as well.
Also set warning limit to zero to enforce zero warnings in CI.
Task-number: QTBUG-125859
Pick-to: 6.8
Change-Id: Ia34831bd6210ca027666840056693d89562f97a3
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reference the colorpalette client documentation from the colorpalette
server documentation.
Pick-to: 6.6 6.5
Task-number: QTBUG-114713
Change-Id: I9fa782d23ffffeae0eaf68c470f51ec186119af7
Reviewed-by: Konrad Kujawa <konrad.kujawa@qt.io>
Make sure the example is shown as one of the first in the
Web Technologies section of Qt Creator's Welcome screen.
Task-number: QTBUG-117224
Pick-to: 6.5 6.6 6.6.0
Change-Id: I5411c9aab24b6e8c3780f37056ef1f2139d4a651
Reviewed-by: Jesus Fernandez <jsfdez@gmail.com>
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: Icd515ff052108d86d50f030e8a95dde64a919fe0
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
As specified in the current Example Guideline document.
Task-number: QTBUG-110895
Pick-to: 6.5
Change-Id: Ibd39195030f5b5af328fdae5868fdedeeddf3759
Reviewed-by: Juha Vuolle <juha.vuolle@qt.io>
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
Remove AddressBook example, instead create ColorPalette example.
ColorPalette is based on reqres.in, and it contains static assets
like colors, users, sessions JSON and avatar images to preload
to server upon start.
Pick-to: 6.5
Fixes: QTBUG-106040
Change-Id: I5edec8d26f11809782d5d40d8e2c15143617eeb9
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
Reviewed-by: Juha Vuolle <juha.vuolle@qt.io>
Non-standard headers must start with "X-". The header check was
also made case-insensitive to match behavior of the standard headers.
Added documentation snippet showing how to create entries using curl.
Fixed JSON syntax in the documentation.
Use \badcode blocks for non-C++ code examples.
Fixes: QTBUG-107927
Pick-to: 6.5
Change-Id: I48fc171fe32164541d777e4dae5747683aba37ad
Reviewed-by: Luca Di Sera <luca.disera@qt.io>
Reviewed-by: Konrad Kujawa <konrad.kujawa@qt.io>
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
Also actually build the example and rename the example in
the documentation.
Pick-to: 6.4
Change-Id: I9c403ceed1562728f8f280d3412f6fb2c3b2a0f4
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Konrad Kujawa <konrad.kujawa@qt.io>
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
This reverts commit 0d3a4a6a28.
Reason for revert: \modulestate command is now supported by
qdoc version used by coin.
This is not a clean revert due to documentation changes done
after the commit to be reverted.
Change-Id: Ib4ad3e79a12d0f8eabc52d39b257844917166634
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Mention use cases as described in QTBUG-60105. Elaborate more on
the security aspect, making it explicit that the use of SSL/HTTPS does
not magically make the server fit for general-purpose servers.
Pick-to: 6.4
Change-Id: I5aef64d00fdb45e1b91020d98754f0d65ddb1562
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
Move separate overview page to landing page - this is
the place where people should get a quick overview of what
the module is for, so IMO it better fits here.
While at it, linkify all referenced methods and signals.
Add also details on how to link to the module to this page,
and add a link to the logging page to the reference section.
Pick-to: 6.4
Change-Id: I05ac9a4d519aa96d345703c92382de6795d130c2
Reviewed-by: Konrad Kujawa <konrad.kujawa@qt.io>
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
This makes sure C++ classes are properly linked in the Contents
list of Assistant and Qt Creator. Setting the landingpage
also makes sure examples are properly listed for the module.
Fixes: QTBUG-106378
Pick-to: 6.4
Change-Id: I4cf9a7191f276a01eaf986cbe1b78b461fcbd52f
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
This hopefully will get examples listed in the Creator.
Fixes: QTBUG-105723
Pick-to: 6.4
Change-Id: I116f6bfe272e5ec06b94d2995a739296705ed0a6
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
\modulestate command was introduced in qdoc after branching to
6.4 was done. It is still useful to have this note in the module
documentation, so spell it out explicitly.
This amends a8ef93c629.
Change-Id: I3df6949be7aa886ff873c051b06e744a38d2168a
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
(cherry picked from commit b9da3d877d)
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Add an address book implementation example using QHttpServer.
Task-number: QTBUG-105198
Pick-to: 6.4
Change-Id: I72d88a4814425cfc94601f4c7955ca8b395b8ede
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Prefer Qt6::HttpServer vs Qt::HttpServer (we don't expose all
information in Qt::HttpServer). Also, use PRIVATE linking by default.
Pick-to: 6.4
Change-Id: I3f6cce21cf124067321aa5b8bb17d3fa44a21501
Reviewed-by: Mikhail Svetkin <mikhail.svetkin@gmail.com>
Use new \modulestate command (introduced in qttools commit 214521bf8d)
to mark QtHttpServer as technical preview.
Change-Id: Ib078c05641d78b8a1aff339da7b581e4f752fdec
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Mikhail Svetkin <mikhail.svetkin@gmail.com>
This will make sure find_package explicitly fails if
HttpServer component is missing.
Change-Id: Ibda6059b77411cf482a747a16c97c178ea4f8563
Reviewed-by: Mikhail Svetkin <mikhail.svetkin@gmail.com>
We shouldn't advertise the include module header anymore. Instead, each
class advertises its header.
Pick-to: 6.4
Change-Id: If7a90c41a9986980f81053f86da29090e5de466e
Reviewed-by: Jesus Fernandez <jsfdez@gmail.com>
Replace the current license disclaimer in files by
a SPDX-License-Identifier.
License files are organized under LICENSES directory.
Pick-to: 6.4
Task-number: QTBUG-67283
Change-Id: I657c36f679b9448ec68d411a492171bc39df1411
Reviewed-by: Jesus Fernandez <jsfdez@gmail.com>
Øystein Heskestad
Topi Reinio
Matthias Rauter
Alexei Cazacov
Mate Barany
Kai Köhne
Safiyyah Moosa
Ievgenii Meshcheriakov
Konrad Kujawa
Lucie Gérard