diff options
| author | Paul Wicking <[email protected]> | 2025-05-27 20:38:35 +0200 |
|---|---|---|
| committer | Paul Wicking <[email protected]> | 2025-06-03 11:55:01 +0000 |
| commit | f7efd5d856656df7293629196b42fbef18ef9efd (patch) | |
| tree | d2a10537f646216aaf4908446d121fe1e655744e | |
| parent | 84f5fa6f8c00cb6e7db05d511798c4f7ff66ca52 (diff) | |
The `documentationinheaders` feature was introduced to QDoc as a
technical preview feature with Qt 6.9. Some minor issues have been
reported and addressed since its release. Given the current state,
we (the development team) feel the feature is mature enough to warrant
being considered a stable QDoc feature. This change "promotes" the
feature from technical preview to regular feature.
Specifically, the change removes the "technical preview" phrase from the
documentation of the feature. As it was missing, a mention of the
version in which the feature was introduced is added as well.
Pick-to: 6.10
Change-Id: Id2eb1baea08bdf7632f04608b685e98ba5ac3609
Reviewed-by: Topi Reiniö <[email protected]>
| -rw-r--r-- | src/qdoc/qdoc/doc/qdoc-manual-qdocconf.qdoc | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/qdoc/qdoc/doc/qdoc-manual-qdocconf.qdoc b/src/qdoc/qdoc/doc/qdoc-manual-qdocconf.qdoc index bd7ec2268..57fa94911 100644 --- a/src/qdoc/qdoc/doc/qdoc-manual-qdocconf.qdoc +++ b/src/qdoc/qdoc/doc/qdoc-manual-qdocconf.qdoc @@ -142,7 +142,7 @@ \list \li \l {defines-variable} {defines} \li \l {depends-variable} {depends} - \li \l {documentationinheaders-variable} {documentationinheaders} (technical preview) + \li \l {documentationinheaders-variable} {documentationinheaders} \li \l {exampledirs-variable} {exampledirs} \li \l {examples-variable} {examples} \li \l {examplesinstallpath-variable} {examplesinstallpath} @@ -330,9 +330,7 @@ See also \l indexes, \l project, and \l url. \target documentationinheaders-variable - \section1 documentationinheaders (technical preview) - - \note This configuration flag enables a technical preview feature in QDoc. + \section1 documentationinheaders Set \c {documentationinheaders = true} to instruct QDoc to parse documentation comments also in header files when generating @@ -341,6 +339,8 @@ \warning In large code bases, this may impact QDoc's processing time. Therefore, you shouldn't set this flag unless you need it. + This feature was introduced to QDoc with Qt 6.9. + \target exampledirs-variable \section1 exampledirs |