diff options
| author | Luca Di Sera <luca.disera@qt.io> | 2025-04-22 11:27:00 +0200 |
|---|---|---|
| committer | Luca Di Sera <luca.disera@qt.io> | 2025-04-22 19:08:36 +0200 |
| commit | aefd01697767bda646c597ff774d87e899436ee1 (patch) | |
| tree | 6d1a38354e865c49f78872ed45f5ab97bc85f982 /src/quickcontrols/macos/qtquickcontrols2macosstyleplugin.cpp | |
| parent | 40af06119284f436fced32b31fd04d5252a21d37 (diff) | |
Doc: Avoid creating the qqmlintegration.h and qqml.h proxy pages
QDoc allows positioning some amount of documentation under certain pages
by use of the "\relates" command.
The "\relates" command takes an argument that represents a name and
tries to find where the documentation should be positioned in the
output, based on that name.
When the provided name doesn't refer to anything that QDoc is aware of
in the current project, a "proxy page" will be created to hold the
documentation.
The "qqmlintegration.h" header is documented as an header and its
generated page was intended to be used to collect the documentation for
a series of elements that the header exports.
Nonetheless, while the header page itself was created while, the
elements that were intended to be collected where insted positioned
under a similarly named proxy page.
The issues stemmed from the "\headerfile" command using the
"<qqmlintegration.h>" name to refer to the header and the relevant
relates command using the "qqmlintegration.h" name to refer to the same,
with the two names differing in the usage of the surrounding angle
brackets.
To avoid creating a proxy page, and instead correctly collecting the
relevant documentation under the header documentation page, the name
usage was synchronized by changing the relevant "\relates" command to
refer to "<qqmlintegration.h>".
A similar issue existes for the "qqml.h" headerfile and a similar
solution was applied to solve the issue.
Pick-to: 6.9 6.8
Fixes: QTBUG-136037
Change-Id: I3bf1aa97648c0a94acb7a0de5f5fbbaeb6a81c7b
Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
Diffstat (limited to 'src/quickcontrols/macos/qtquickcontrols2macosstyleplugin.cpp')
0 files changed, 0 insertions, 0 deletions
