summaryrefslogtreecommitdiffstats
path: root/src/core/doc/qtwebengine.qdocconf
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Enable automatic linking to sources on code.qt.ioTopi Reinio2025-06-051-0/+3
| | | | | | | | | | | | | Since 6.10, QDoc is capable of generating links to the declaration in the source code for each documented C++ API entity in their `Detailed description`. Add the required configuration to enable this feature for modules in qtwebengine. Pick-to: 6.10 Change-Id: Iab5a519f5d7bc15da0ca2d64dee374db72b245f1 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Instruct QDoc to ignore output file overwrite warningsTopi Reinio2025-03-071-0/+4
| | | | | | | | | | | | | | | | We have two components (WebEngine Core, WebEngineDriver) that both have associated 3rd party attributions originating from Chromium. These attributions overlap each other, and cause multiple `Output file already exist` warnings when generating the documentation. Instruct QDoc to ignore these, in order to reduce noise during documentation build. Pick-to: 6.9 6.8 Fixes: QTBUG-134416 Change-Id: I57842910fe4835ac5f536a757d3347fa7cee636a Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add WebEngineDriver source directory to documentation buildTopi Reinio2025-02-181-0/+1
| | | | | | | | | | | | | While there is no documentation sources to parse there, the Chromium code attribution script uses it as the output directory for the generated 3rd party licenses. Add the directory to make QDoc parse the generated output. Fixes: QTBUG-133495 Pick-to: 6.9 6.8 6.5 Change-Id: I06643163e1b7791664afcfead90a91b65d3039af Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Moss Heim <moss.heim@qt.io>
* Doc: Fix qhp subproject for examplesTopi Reinio2024-08-101-4/+9
| | | | | | | | | | | | | | Qt WebEngine examples have been divided into two subgroups, Quick and Widgets -based examples. Modify the qhp subprojects in qtwebengine.qdocconf to reflect this. Fixes the following QDoc warning: Failed to find qhp.QtWebEngine.subprojects.examples.indexTitle 'Qt WebEngine Examples' Pick-to: 6.8 Change-Id: Ic991e0a53e3c46f1dced0427d20aca3376a1d310 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Docs: Organize topics in the qtwebengine repoAlexei Cazacov2024-08-081-1/+8
| | | | | | | | | | 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-127147 Change-Id: I3002ff3b0243e718ce56c4fb0017781ece2b7c7b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Document value types with \qmlvaluetypeTopi Reinio2024-08-081-1/+1
| | | | | | | | | | | As these types are value types, document them as such. Separate object and value types on the QML module page, and fix the incorrect \instantiates argument for webEngineFrame. Pick-to: 6.8 Change-Id: Ieb654efef0ede0eea7c10537d51cc040dc4e9935 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Moss Heim <moss.heim@qt.io>
* Doc: Increase warninglimit for doc builds to 2Paul Wicking2024-06-291-1/+1
| | | | | | | | | | | | | | | | | | | | | Technically the Qt WebEngine documentation builds without warnings, but testing in CI two warnings are observed: warning: Already generated qtwebengine-3rdparty-inspector-protocol.html for this project warning: Already generated qtwebengine-3rdparty-lit.html for this project These pages come from a qtattributionsscanner-generated source file, codeattributions.qdoc. The warnings do not affect the generated output. Increase the documentation warning limit temporarily to let integrations pass. Pick-to: 6.8 Task-number: QTBUG-126546 Change-Id: I450c4ef4a03abdbf5ccbeab865468b302c92ee90 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Fix QPdfPageSelector::currentPageLabel property documentationTopi Reinio2023-11-101-0/+3
| | | | | | | | | | | | | | | src/pdfwidgets/qpdfpageselector.cpp: * warning: Cannot find 'QPdfPageSelector::currentPageIndex' specified with '\property' in any header file src/core/doc/src/qtwebengine-deploying.qdoc: * warning: Unknown command '\maocs' Mark documentation modules free of warnings. Pick-to: 6.6 Change-Id: Icbdf9622501b1fc4911f58682ffd2146efc36c1f Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Highlight also Recipe BrowserKai Köhne2023-10-091-1/+2
| | | | | | | Task-number: QTBUG-117224 Pick-to: 6.5 6.6 6.6.0 Change-Id: I80eb11577a46b8e26c4705b647eca855b1a4d933 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Doc: Remove warninglimit .qdocconf variableTopi Reinio2023-06-271-3/+0
| | | | | | | | | | | | | | | | 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: Ic28d57f29e1f8ea5b551fe25a413dafcf04c0ccc Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Fix warning and minor clean-upPeter Varga2023-01-171-1/+0
| | | | | | | | | | - Fix typo in link - Qt Location is no longer linked in Qt WebEngine Features - Replace Qt Location with Qt Positioning module Pick-to: 6.4 6.5 Change-Id: Ia736fee8f0775fd6067c6f1e7a670b3bd7d8acb5 Reviewed-by: Michal Klocek <michal.klocek@qt.io>
* Revert "Pump up temporally warning limit for qdoc"Michal Klocek2022-12-161-1/+1
| | | | | | | | | | A required dependency for qttools is merged. This reverts commit f85b1381be8aeda4de7d364e4b51f09fc560c0c1. Pick-to: 6.5 Change-Id: If0f0a990a9f5ec2c8601057d803875f19893bf6a Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
* Pump up temporally warning limit for qdocMichal Klocek2022-11-291-1/+1
| | | | | | | | | | | | | | | | | | qDoc on ci throws some "Unable to parse JavaScript" warnings for new examples. However this issue will be gone after removing JavaScript support form qdoc qtools change: ecf918398579030c9ba16f843595cfdbe774c00b The newer qdoc comes form qt5 change: 271cd0608c84016a285116fe1295d7d2e60f1c87 Task-number: QTBUG-106275 Task-number: QTQAINFRA-4926 Change-Id: I74bb515146587361d804ee6be8d2d37c4dd29671 Reviewed-by: Michael Brüning <michael.bruning@qt.io>
* Doc: Add dependency to the CMake manualTopi Reinio2021-11-191-0/+1
| | | | | | | Fixes (qdoc) warning: Can't link to 'Versionless commands' Change-Id: Ia2940a3b244df57cdefe386734bdac0df18cd039 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Fix qdoc warnings and enable zero warning limitVenugopal Shivashankar2021-11-151-3/+7
| | | | | Change-Id: Ifa2914e7bca9c224670a1891785d0ba8262cd61b Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Remove unsupported customFiltersKai Köhne2021-08-251-4/+0
| | | | | | Task-number: QTBUG-95987 Change-Id: Ie762a1e45cf0e84951cf7c91bf2144f38ad55dd1 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Fix documentation issues for Qt WebEngineTopi Reinio2021-07-011-5/+10
| | | | | | | | | | API and documentation changes since 5.15 caused multiple warnings from QDoc; this change addresses most of them. Some warnings indicate missing documentation, those issues still remain. Pick-to: 6.2 Change-Id: I96be38b7daac37a7e35c149b4b3ec3f18c4415c9 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Add WebEngine qdocconf for documentationAllan Sandfeld Jensen2021-06-081-0/+90
Probably still needs internal naming updates. Task-number: QTBUG-94130 Change-Id: I3f2522b16a78475d42f9f689cf2d2e994130cf7b Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-17 12:21:09 +0000